feat: updated all of postdfm to use esmodules correctly

.eslintrc.cjs

@@ -0,0 +1 @@
+module.exports = require("./eslint.config.cjs")();

.husky/commit-msg

@@ -1,4 +1,4 @@
 #!/bin/sh
 . "$(dirname $0)/_/husky.sh"
 
-yarn run commitlint --edit $1
+yarn run commitlint --config commitlint.config.cjs --edit $1

__test__/__fixtures__/transform/everything/plugin.js

@@ -1,11 +1,11 @@
-// eslint-disable-next-line node/no-extraneous-require
-const { Plugin } = require("@postdfm/plugin");
+// eslint-disable-next-line node/no-extraneous-import
+import { Plugin } from "@postdfm/plugin";
 
 function reverseString(str) {
   return str.split("").reverse().join("");
 }
 
-module.exports = class ReverseEverythingPlugin extends Plugin {
+export default class ReverseEverythingPlugin extends Plugin {
   PLUGIN_NAME = "ReverseEverythingPlugin";
 
   hookCallback;
@@ -134,4 +134,4 @@ module.exports = class ReverseEverythingPlugin extends Plugin {
       // nothing to reverse here
     });
   }
-};
+}

__test__/__fixtures__/transform/hello-world/plugin.js

@@ -1,11 +1,11 @@
-// eslint-disable-next-line node/no-extraneous-require
-const { Plugin } = require("@postdfm/plugin");
+// eslint-disable-next-line node/no-extraneous-import
+import { Plugin } from "@postdfm/plugin";
 
-module.exports = class HelloWorldPlugin extends Plugin {
+export default class HelloWorldPlugin extends Plugin {
   install(hooks) {
     hooks.property.tap("HelloWorldPlugin", (node) => {
       node.name = node.name.split("").reverse().join("");
       return node;
     });
   }
-};
+}

commitlint.config.cjs

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ["@commitlint/config-conventional"]
+};

eslint.config.js → eslint.config.cjs

@@ -5,18 +5,18 @@ module.exports = function getConfig(enableTypeChecking) {
     settings: {
       node: {
         allowModules: ["@postdfm/ast2dfm", "@postdfm/ast", "@postdfm/dfm2ast"],
-        tryExtensions: [".js", ".ts", ".json", ".node"],
-      },
+        tryExtensions: [".js", ".cjs", ".ts", ".json", ".node"]
+      }
     },
-    ignorePatterns: [".eslintrc.js"],
     parserOptions: {
-      project: "./tsconfig.json",
+      extraFileExtensions: [".cjs"],
+      project: "./tsconfig.json"
     },
     extends: [
       "eslint:recommended",
       "plugin:node/recommended",
       "plugin:jest/recommended",
-      "prettier",
+      "prettier"
     ],
     overrides: [
       {
@@ -30,17 +30,17 @@ module.exports = function getConfig(enableTypeChecking) {
           enableTypeChecking &&
             "plugin:@typescript-eslint/recommended-requiring-type-checking",
           "prettier",
-          "prettier/@typescript-eslint",
+          "prettier/@typescript-eslint"
         ].filter((v) => !!v),
         rules: {
           "node/no-unsupported-features/es-syntax": [
             "error",
             {
-              ignores: ["modules"],
-            },
-          ],
-        },
-      },
-    ],
+              ignores: ["modules", "dynamicImport"]
+            }
+          ]
+        }
+      }
+    ]
   };
 };

jest.config.json

@@ -0,0 +1,34 @@
+{
+  "reporters": [
+    "default",
+    [
+      "jest-junit",
+      {
+        "usePathForSuiteName": "true",
+        "classNameTemplate": "[{classname}]",
+        "titleTemplate": "{title}",
+        "outputDirectory": "test-results/jest",
+        "outputName": "./report.xml"
+      }
+    ]
+  ],
+  "preset": "ts-jest/presets/default-esm",
+  "globals": {
+    "ts-jest": {
+      "useESM": true
+    }
+  },
+  "transform": {
+    "^.+\\.tsx?$": "ts-jest"
+  },
+  "collectCoverage": true,
+  "collectCoverageFrom": [
+    "**/*.ts",
+    "!**/node_modules/**",
+    "!**/dist/**",
+    "!packages/@postdfm/dfm2ast/src/grammar.ts"
+  ],
+  "coverageReporters": ["lcov", "text"],
+  "coverageDirectory": "coverage",
+  "rootDir": "./"
+}

package.json

@@ -5,6 +5,7 @@
     "packages/postdfm"
   ],
   "description": "Provides an API for easily transforming Delphi Forms",
+  "type": "module",
   "scripts": {
     "postinstall": "husky install",
     "ci": "yarn --frozen-lockfile && yarn run compile && yarn run lint:check && yarn run format:check && yarn test && yarn docs",
@@ -15,7 +16,7 @@
     "format:fix": "yarn format --write --list-different",
     "format:check": "yarn format --check",
     "compile": "yarn workspaces run compile",
-    "test": "jest --coverage",
+    "test": "cross-env NODE_OPTIONS=--experimental-vm-modules jest --coverage --verbose --maxWorkers=16",
     "docs": "yarn workspaces run docs",
     "release": "semantic-release",
     "snyk-protect": "snyk protect",
@@ -33,20 +34,21 @@
     "@typescript-eslint/eslint-plugin": "^4.14.0",
     "@typescript-eslint/parser": "^4.14.0",
     "commitlint": "^12.0.1",
+    "cross-env": "^7.0.3",
     "cz-conventional-changelog": "^3.0.2",
     "eslint": "^7.18.0",
     "eslint-config-prettier": "^7.2.0",
     "eslint-plugin-jest": "^24.1.3",
     "eslint-plugin-node": "^11.1.0",
     "execa": "^4.0.0",
     "husky": "^5.0.6",
-    "jest": "^26.0.0",
+    "jest": "^27.0.0-next.7",
     "jest-junit": "^10.0.0",
     "lint-staged": "^10.0.3",
     "nearley": "^2.16.0",
     "prettier": "^2.2.1",
-    "semantic-release": "^17.3.8",
-    "ts-jest": "^26.4.4",
+    "semantic-release": "^17.4.0",
+    "ts-jest": "^27.0.0-next.10",
     "typedoc": "^0.20.24",
     "typescript": "^4.1.3"
   },

packages/@postdfm/ast/.eslintrc.cjs

@@ -0,0 +1 @@
+module.exports = require("../../../eslint.config.cjs")(true);

packages/@postdfm/ast/package.json

@@ -4,9 +4,10 @@
   "description": "Abstract Syntax Tree classes for postdfm",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "type": "module",
   "scripts": {
     "compile": "tsc --listEmittedFiles",
-    "docs": "typedoc --options typedoc.config.js"
+    "docs": "typedoc --options typedoc.config.cjs"
   },
   "author": "SpiltCoffee",
   "license": "MIT",

packages/@postdfm/ast/typedoc.config.cjs

@@ -0,0 +1,4 @@
+module.exports = require("../../../typedoc.config.cjs")({
+  entryPoints: ["src/index.ts"],
+  out: "@postdfm/ast"
+});

packages/@postdfm/ast2dfm/.eslintrc.cjs

@@ -0,0 +1 @@
+module.exports = require("../../../eslint.config.cjs")(true);

packages/@postdfm/ast2dfm/__test__/broken/index.test.ts

@@ -1,13 +1,17 @@
-import * as AST from "@postdfm/ast";
-import * as fs from "fs";
-import * as path from "path";
+import fs from "fs";
+import { fileURLToPath } from "url";
+
+import { Root } from "@postdfm/ast";
 import stringify from "../../src";
 
 describe("dfm2ast", () => {
   test("broken AST throws error", () => {
     const ast = JSON.parse(
-      fs.readFileSync(path.join(__dirname, "ast.json"), "utf8")
-    ) as AST.Root;
+      fs.readFileSync(
+        fileURLToPath(new URL("./ast.json", import.meta.url)),
+        "utf8"
+      )
+    ) as Root;
 
     expect(() => stringify(ast)).toThrow("Cannot stringify astType unknown");
   });

packages/@postdfm/ast2dfm/package.json

@@ -4,9 +4,10 @@
   "description": "Convert DFM Abstract Syntax Trees to a Delphi Form file",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "type": "module",
   "scripts": {
     "compile": "tsc --listEmittedFiles",
-    "docs": "typedoc --options typedoc.config.js"
+    "docs": "typedoc --options typedoc.config.cjs"
   },
   "author": "SpiltCoffee",
   "license": "MIT",

packages/@postdfm/ast2dfm/typedoc.config.cjs

@@ -0,0 +1,4 @@
+module.exports = require("../../../typedoc.config.cjs")({
+  entryPoints: ["src/index.ts"],
+  out: "@postdfm/ast2dfm"
+});

packages/@postdfm/dfm2ast/.eslintrc.cjs

@@ -0,0 +1 @@
+module.exports = require("../../../eslint.config.cjs")(true);

packages/@postdfm/dfm2ast/__test__/broken/index.test.ts

@@ -1,10 +1,13 @@
-import * as fs from "fs";
-import * as path from "path";
+import fs from "fs";
+import { fileURLToPath } from "url";
 import parse from "../../src";
 
 describe("dfm2ast", () => {
   test("broken DFM throws error", () => {
-    const dfm = fs.readFileSync(path.join(__dirname, "form.dfm"), "ascii");
+    const dfm = fs.readFileSync(
+      fileURLToPath(new URL("./form.dfm", import.meta.url)),
+      "ascii"
+    );
 
     expect(() => parse(dfm)).toThrow("Unexpected End Of Input");
   });

packages/@postdfm/dfm2ast/__test__/fixtures/index.test.ts

@@ -1,21 +1,27 @@
-import * as fs from "fs";
-import * as path from "path";
+import fs from "fs";
+import { ASTNode } from "@postdfm/ast";
 import parse from "../../src";
 
-const rootFixturesDir = path.join("__test__", "__fixtures__");
-const parseFixturesDir = path.join(rootFixturesDir, "parse");
+const parseFixturesPath = new URL(
+  "../../../../../__test__/__fixtures__/parse/",
+  import.meta.url
+);
 
 describe("dfm2ast", () => {
   describe("parse fixtures", () => {
-    const fixtures = fs.readdirSync(parseFixturesDir);
+    const fixtures = fs.readdirSync(parseFixturesPath);
     fixtures.forEach((fixture) => {
-      const formFile = path.join(parseFixturesDir, fixture, "form.dfm");
-      const astFile = path.join(parseFixturesDir, fixture, "ast.json");
+      const fixturePath = new URL(`./${fixture}/`, parseFixturesPath);
+      const formFile = fs.readFileSync(
+        new URL("./form.dfm", fixturePath),
+        "ascii"
+      );
+      const astJson = JSON.parse(
+        fs.readFileSync(new URL("./ast.json", fixturePath), "utf-8")
+      ) as ASTNode;
 
       test(`${fixture}`, () => {
-        expect(
-          JSON.parse(JSON.stringify(parse(fs.readFileSync(formFile, "ascii"))))
-        ).toEqual(JSON.parse(fs.readFileSync(astFile, "utf8")));
+        expect(JSON.parse(JSON.stringify(parse(formFile)))).toEqual(astJson);
       });
     });
   });

packages/@postdfm/dfm2ast/package.json

@@ -4,10 +4,11 @@
   "description": "Convert Delphi Form files to an Abstract Syntax Tree",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
+  "type": "module",
   "scripts": {
     "precompile": "nearleyc ne/grammar.ne -o src/grammar.ts",
     "compile": "tsc --listEmittedFiles",
-    "docs": "typedoc --options typedoc.config.js"
+    "docs": "typedoc --options typedoc.config.cjs"
   },
   "author": "SpiltCoffee",
   "license": "MIT",

packages/@postdfm/dfm2ast/src/index.ts

@@ -1,5 +1,12 @@
 import { Root } from "@postdfm/ast";
-import { Grammar, Parser } from "nearley";
+
+// nearley isn't a proper ESM module here (not even CommonJS - it's UMD)
+import * as nearleyPkg from "nearley";
+import type { Parser as ParserType, Grammar as GrammarType } from "nearley";
+const { Parser, Grammar } = (<
+  { default: { Parser: typeof ParserType; Grammar: typeof GrammarType } }
+>(<unknown>nearleyPkg)).default;
+
 import grammar from "./grammar";
 
 function parse(dfm: string): Root {

packages/@postdfm/dfm2ast/typedoc.config.cjs

@@ -0,0 +1,4 @@
+module.exports = require("../../../typedoc.config.cjs")({
+  entryPoints: ["src/index.ts"],
+  out: "@postdfm/dfm2ast"
+});

packages/@postdfm/plugin/.eslintrc.cjs

@@ -0,0 +1 @@
+module.exports = require("../../../eslint.config.cjs")(true);

packages/@postdfm/plugin/__test__/plugin/index.test.ts

@@ -1,5 +1,6 @@
 import * as AST from "@postdfm/ast";
 import { Plugin, Hooks } from "../../src";
+import { jest } from "@jest/globals";
 
 class TapAllPlugin extends Plugin {
   hookCallback: () => void;