feat: update repo to esm

A big update as it has been some time since this repo has had any attention. Many of the fixes are the same as seen in the `vertigis-web-sdk` version of this update:

vertigis/vertigis-web-sdk@b679778

Author: yonabystedt

.eslintrc.js renamed to .eslintrc.cjs

@@ -1,7 +1,7 @@
 const path = require("path");
 
 module.exports = {
-    extends: [path.join(__dirname, "config", ".eslintrc.js")],
+    extends: [path.join(__dirname, "config", ".eslintrc")],
     env: {
         jest: true,
     },

.npmrc

@@ -1,2 +1,2 @@
 access=public
-package-lock=false
+engine-strict=true

.prettierignore

@@ -0,0 +1,2 @@
+package-lock.json
+tsconfig.json.template

.prettierrc

@@ -1,5 +1,6 @@
 {
-    "printWidth": 80,
+    "arrowParens": "avoid",
+    "printWidth": 120,
     "tabWidth": 4,
     "trailingComma": "es5"
 }

.vscode/launch.json

@@ -12,7 +12,7 @@
             "skipFiles": ["<node_internals>/**"],
             "console": "integratedTerminal",
             "internalConsoleOptions": "neverOpen",
-            "type": "pwa-node"
+            "type": "node"
         },
         {
             "name": "Build 'test-lib' project",
@@ -21,7 +21,7 @@
             "runtimeExecutable": "npm",
             "skipFiles": ["<node_internals>/**"],
             "cwd": "${workspaceFolder}/test-lib",
-            "type": "pwa-node"
+            "type": "node"
         }
     ]
 }

.vscode/settings.json

@@ -0,0 +1,19 @@
+{
+    "editor.formatOnSave": true,
+    "editor.codeActionsOnSave": {
+        "source.fixAll.eslint": "explicit"
+    },
+    "[javascript]": {
+        "editor.formatOnSave": true
+    },
+    "[javascriptreact]": {
+        "editor.formatOnSave": true
+    },
+    "[typescript]": {
+        "editor.formatOnSave": true
+    },
+    "[typescriptreact]": {
+        "editor.formatOnSave": true
+    },
+    "eslint.validate": ["javascript", "javascriptreact", "typescript", "typescriptreact"]
+}

babel.config.cjs

@@ -0,0 +1,13 @@
+module.exports = {
+    presets: [
+        [
+            require("@babel/preset-env"),
+            {
+                targets: {
+                    node: "current",
+                },
+            },
+        ],
+        require("@babel/preset-typescript"),
+    ],
+};

bin/vertigis-workflow-sdk.js

@@ -1,16 +1,19 @@
 #!/usr/bin/env node
 // @ts-check
-"use strict";
+// Necessary to turn this into a module, which allows top-level await.
+export {};
 
 const args = process.argv.slice(2);
 
-const scriptIndex = args.findIndex(
-    (x) => x === "build" || x === "create" || x === "generate" || x === "start"
-);
+const scriptIndex = args.findIndex(x => x === "build" || x === "create" || x === "generate" || x === "start");
 const script = scriptIndex === -1 ? args[0] : args[scriptIndex];
 
 if (["build", "create", "generate", "start"].includes(script)) {
-    require(`../scripts/${script}`);
+    try {
+        await import(`../scripts/${script}.js`);
+    } catch (e) {
+        console.error(e);
+    }
 } else {
-    console.log('Unknown script "' + script + '".');
+    console.error(`Unknown script '${script}'.`);
 }

config/.eslintrc/README.md

@@ -0,0 +1,11 @@
+This folder may seem bizarre but is necessary since existing SDK projects have
+their own eslint config that extends
+`require.resolve("@vertigis/web-sdk/config/.eslintrc")`. This will only work if
+`config/.eslintrc` is a Common JS module, but this project was converted to
+`"type": "module"`. It appears that Node will NOT resolve a module with a .cjs
+extension unless the extension is explicitly included in the path, which it
+isn't in this case.
+
+By creating a folder with the same name containing a Common JS index.js and a
+package.json with `"type": "commonjs"`, it allows us to have this path still
+work via `require()` even after converting the SDK to ESM.

config/.eslintrc.js renamed to config/.eslintrc/index.js

@@ -5,11 +5,11 @@ module.exports = {
         ecmaFeatures: {
             jsx: true,
         },
-        ecmaVersion: 2018,
+        ecmaVersion: 2021,
         project: "./tsconfig.json",
         sourceType: "module",
     },
-    plugins: ["@typescript-eslint", "react", "react-hooks"],
+    plugins: ["@typescript-eslint", "only-warn", "react", "react-hooks"],
     env: {
         browser: true,
         commonjs: true,