refactor!: migrate to ESM

BREAKING CHANGE: the package is now pure ESM

Author: sheerlox

.eslintrc.js renamed to .eslintrc.cjs

@@ -2,13 +2,14 @@ module.exports = {
   root: true,
   parserOptions: {
     ecmaVersion: 'latest',
+    sourceType: 'module',
   },
   env: {
     node: true,
     es6: true,
   },
   extends: ['eslint:recommended', 'plugin:prettier/recommended'],
-  ignorePatterns: ['coverage', '.eslintrc.js'],
+  ignorePatterns: ['coverage', '.eslintrc.cjs'],
   overrides: [
     {
       files: ['**/*.test.js'],

index.js

@@ -1,5 +1,7 @@
-module.exports = {
-  parserPreset: require('@insurgent/conventional-changelog-preset'),
+import createPreset from '@insurgent/conventional-changelog-preset';
+
+const commitLintConfig = {
+  parserPreset: createPreset,
   rules: {
     'body-leading-blank': [1, 'always'],
     'body-max-line-length': [2, 'always', 100],
@@ -135,3 +137,8 @@ module.exports = {
     },
   },
 };
+
+export default commitLintConfig;
+
+export const parserPreset = commitLintConfig.parserPreset;
+export const rules = commitLintConfig.rules;

index.test.js

@@ -1,10 +1,10 @@
-const lint = require('@commitlint/lint').default;
-const { parserPreset, rules } = require('.');
+import lint from '@commitlint/lint';
+import { parserPreset, rules } from './index.js';
 const types = rules['type-enum'][2];
 
 const commitLint = async (message) => {
   const preset = await parserPreset();
-  return lint(message, rules, { ...preset });
+  return lint.default(message, rules, { ...preset });
 };
 
 const messages = {

package-lock.json

@@ -7,12 +7,13 @@
     "Pierre Cavin <[email protected]>"
   ],
   "license": "MIT",
+  "type": "module",
   "scripts": {
     "lint:eslint": "eslint . --ext .js",
     "lint:prettier": "prettier ./**/*.{json,md,yml} --check",
     "lint": "npm run lint:eslint && npm run lint:prettier",
     "lint:fix": "npm run lint:eslint -- --fix && npm run lint:prettier -- --write",
-    "test": "jest --coverage",
+    "test": "cross-env NODE_OPTIONS=--experimental-vm-modules jest --coverage",
     "test:commitlint": "commitlint --from HEAD~1 --to HEAD --verbose"
   },
   "engines": {
@@ -31,6 +32,7 @@
     "@semantic-release/github": "9.2.6",
     "@semantic-release/npm": "11.0.3",
     "@semantic-release/release-notes-generator": "12.1.0",
+    "cross-env": "7.0.3",
     "eslint": "8.57.0",
     "eslint-config-prettier": "9.1.0",
     "eslint-plugin-jest": "27.9.0",