feat: migrate to pure ESM

Author: JounQin

.eslintrc.js renamed to .eslintrc.cjs

@@ -1 +1 @@
-module.exports = require('@commitlint/config-angular');
+export {default} from '@commitlint/config-angular';

@alias/commitlint-config-angular/index.js

@@ -1,5 +1,6 @@
 {
   "name": "commitlint-config-angular",
+  "type": "module",
   "version": "18.6.0",
   "description": "Shareable commitlint config enforcing the angular commit convention",
   "files": [

@alias/commitlint-config-angular/package.json

@@ -1 +1 @@
-module.exports = require('@commitlint/config-lerna-scopes');
+export {default} from '@commitlint/config-lerna-scopes';

@alias/commitlint-config-lerna-scopes/index.js

@@ -1,5 +1,6 @@
 {
   "name": "commitlint-config-lerna-scopes",
+  "type": "module",
   "version": "18.4.4",
   "description": "Shareable commitlint config enforcing lerna package names as scopes",
   "files": [

@alias/commitlint-config-lerna-scopes/package.json

@@ -1 +1 @@
-module.exports = require('@commitlint/config-nx-scopes');
+export {default} from '@commitlint/config-nx-scopes';

@alias/commitlint-config-nx-scopes/index.js

@@ -1,5 +1,6 @@
 {
   "name": "commitlint-config-nx-scopes",
+  "type": "module",
   "version": "18.5.1",
   "description": "Shareable commitlint config enforcing nx project names as scopes",
   "files": [

@alias/commitlint-config-nx-scopes/package.json

@@ -1 +1 @@
-module.exports = require('@commitlint/config-patternplate');
+export {default} from '@commitlint/config-patternplate';

@alias/commitlint-config-patternplate/index.js

@@ -1,5 +1,6 @@
 {
   "name": "commitlint-config-patternplate",
+  "type": "module",
   "version": "18.6.0",
   "description": "Lint your commits, patternplate-style",
   "files": [

@alias/commitlint-config-patternplate/package.json

@@ -1,3 +1,2 @@
 #!/usr/bin/env node
-const pkgDir = require('@commitlint/cli');
-require(pkgDir);
+import '@commitlint/cli/cli.js';

@alias/commitlint/cli.js

@@ -1,6 +1,14 @@
+import {createRequire} from 'module';
+import path from 'path';
+import {fileURLToPath} from 'url';
+
 import execa from 'execa';
 import {fix} from '@commitlint/test';
 
+const require = createRequire(import.meta.url);
+
+const __dirname = path.resolve(fileURLToPath(import.meta.url), '..');
+
 const bin = require.resolve('./cli.js');
 
 function cli(args, options, input) {

@alias/commitlint/cli.test.js

@@ -1,5 +1,6 @@
 {
   "name": "commitlint",
+  "type": "module",
   "version": "18.6.0",
   "description": "Lint your commit messages",
   "files": [

@alias/commitlint/package.json

@@ -1,2 +1,2 @@
 #!/usr/bin/env node
-require('./lib/cli.js');
+import './lib/cli.js';

@commitlint/cli/cli.js

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

@commitlint/cli/fixtures/package.json

@@ -1,12 +1,14 @@
 {
   "name": "@commitlint/cli",
+  "type": "module",
   "version": "18.6.0",
   "description": "Lint your commit messages",
   "files": [
-    "index.js",
+    "index.cjs",
     "cli.js",
     "lib"
   ],
+  "main": "index.cjs",
   "bin": {
     "commitlint": "./cli.js"
   },
@@ -39,7 +41,6 @@
   "devDependencies": {
     "@commitlint/test": "^18.0.0",
     "@commitlint/utils": "^18.4.4",
-    "@types/lodash.isfunction": "^3.0.8",
     "@types/lodash.merge": "^4.6.8",
     "@types/node": "^18.11.9",
     "@types/yargs": "^17.0.29",
@@ -53,7 +54,6 @@
     "@commitlint/read": "^18.6.0",
     "@commitlint/types": "^18.6.0",
     "execa": "^5.0.0",
-    "lodash.isfunction": "^3.0.9",
     "resolve-from": "5.0.0",
     "resolve-global": "1.0.0",
     "yargs": "^17.0.0"

@commitlint/cli/index.js renamed to @commitlint/cli/index.cjs

@@ -1,8 +1,15 @@
+import {createRequire} from 'module';
+import path from 'path';
+import {fileURLToPath} from 'url';
+
 import {fix, git} from '@commitlint/test';
 import execa from 'execa';
 import fs from 'fs-extra';
 import merge from 'lodash.merge';
-import path from 'path';
+
+const require = createRequire(import.meta.url);
+
+const __dirname = path.resolve(fileURLToPath(import.meta.url), '..');
 
 const bin = require.resolve('../cli.js');
 

@commitlint/cli/package.json

@@ -1,30 +1,45 @@
-import execa, {ExecaError} from 'execa';
-import load from '@commitlint/load';
-import lint from '@commitlint/lint';
-import read from '@commitlint/read';
-import isFunction from 'lodash.isfunction';
-import resolveFrom from 'resolve-from';
-import resolveGlobal from 'resolve-global';
-import yargs, {Arguments} from 'yargs';
+import {createRequire} from 'module';
+import path from 'path';
+import {fileURLToPath, pathToFileURL} from 'url';
 import util from 'util';
 
-import {CliFlags} from './types';
-import {
+import lint from '@commitlint/lint';
+import load from '@commitlint/load';
+import read from '@commitlint/read';
+import type {
+	Formatter,
 	LintOptions,
 	LintOutcome,
-	ParserOptions,
 	ParserPreset,
 	QualifiedConfig,
-	Formatter,
 	UserConfig,
 } from '@commitlint/types';
-import {CliError} from './cli-error';
+import type {Options} from 'conventional-commits-parser';
+import execa, {ExecaError} from 'execa';
+import resolveFrom from 'resolve-from';
+import resolveGlobal from 'resolve-global';
+import yargs, {type Arguments} from 'yargs';
+
+import {CliFlags} from './types.js';
+
+import {CliError} from './cli-error.js';
+
+const require = createRequire(import.meta.url);
+
+const __dirname = path.resolve(fileURLToPath(import.meta.url), '..');
 
-const pkg = require('../package');
+const dynamicImport = async <T>(id: string): Promise<T> => {
+	const imported = await import(
+		path.isAbsolute(id) ? pathToFileURL(id).toString() : id
+	);
+	return ('default' in imported && imported.default) || imported;
+};
+
+const pkg: typeof import('../package.json') = require('../package.json');
 
 const gitDefaultCommentChar = '#';
 
-const cli = yargs
+const cli = yargs(process.argv.slice(2))
 	.options({
 		color: {
 			alias: 'c',
@@ -215,7 +230,7 @@ async function main(args: MainArgs): Promise<void> {
 			'[input] is required: supply via stdin, or --env or --edit or --from and --to',
 			pkg.name
 		);
-		yargs.showHelp('log');
+		yargs().showHelp('log');
 		console.log(err.message);
 		throw err;
 	}
@@ -225,7 +240,7 @@ async function main(args: MainArgs): Promise<void> {
 		file: flags.config,
 	});
 	const parserOpts = selectParserOpts(loaded.parserPreset);
-	const opts: LintOptions & {parserOpts: ParserOptions} = {
+	const opts: LintOptions & {parserOpts: Options} = {
 		parserOpts: {},
 		plugins: {},
 		ignores: [],
@@ -243,7 +258,7 @@ async function main(args: MainArgs): Promise<void> {
 	if (loaded.defaultIgnores === false) {
 		opts.defaultIgnores = false;
 	}
-	const format = loadFormatter(loaded, flags);
+	const format = await loadFormatter(loaded, flags);
 
 	// If reading from `.git/COMMIT_EDIT_MSG`, strip comments using
 	// core.commentChar from git configuration, falling back to '#'.
@@ -431,21 +446,18 @@ function selectParserOpts(parserPreset: ParserPreset | undefined) {
 	return parserPreset.parserOpts;
 }
 
-function loadFormatter(config: QualifiedConfig, flags: CliFlags): Formatter {
+function loadFormatter(
+	config: QualifiedConfig,
+	flags: CliFlags
+): Promise<Formatter> {
 	const moduleName = flags.format || config.formatter || '@commitlint/format';
 	const modulePath =
 		resolveFrom.silent(__dirname, moduleName) ||
 		resolveFrom.silent(flags.cwd, moduleName) ||
 		resolveGlobal.silent(moduleName);
 
 	if (modulePath) {
-		const moduleInstance = require(modulePath);
-
-		if (isFunction(moduleInstance.default)) {
-			return moduleInstance.default;
-		}
-
-		return moduleInstance;
+		return dynamicImport<Formatter>(modulePath);
 	}
 
 	throw new Error(`Using format ${moduleName}, but cannot find the module.`);

@commitlint/cli/src/cli.test.ts

@@ -11,8 +11,9 @@ const types = [
 	'test',
 ];
 
-module.exports.rules = {
-	'type-enum': [2, 'always', types],
+export default {
+	rules: {
+		'type-enum': [2, 'always', types],
+	},
+	value: () => types,
 };
-
-module.exports.value = () => types;

@commitlint/cli/src/cli.ts

@@ -1,5 +1,6 @@
 {
   "name": "@commitlint/config-angular-type-enum",
+  "type": "module",
   "version": "18.4.4",
   "description": "Shareable commitlint config enforcing the angular commit convention types",
   "files": [

@commitlint/config-angular-type-enum/index.js

@@ -1,6 +1,6 @@
-const typeEnum = require('@commitlint/config-angular-type-enum');
+import typeEnum from '@commitlint/config-angular-type-enum';
 
-module.exports = {
+export default {
 	parserPreset: {parserOpts: {headerPattern: /^(\w*)(?:\((.*)\))?!?: (.*)$/}},
 	rules: {
 		'subject-exclamation-mark': [2, 'never'],

@commitlint/config-angular-type-enum/package.json

@@ -1,5 +1,8 @@
 import lint from '@commitlint/lint';
-import {rules, parserPreset} from '.';
+
+import config from './index.js';
+
+const {rules, parserPreset} = config;
 
 const lintMessage = async (message) => {
 	const parserOpts = parserPreset.parserOpts;

@commitlint/config-angular/index.js

@@ -1,5 +1,6 @@
 {
   "name": "@commitlint/config-angular",
+  "type": "module",
   "version": "18.6.0",
   "description": "Shareable commitlint config enforcing the angular commit convention",
   "files": [

@commitlint/config-angular/index.test.js

@@ -1,4 +1,4 @@
-module.exports = {
+export default {
 	parserPreset: 'conventional-changelog-conventionalcommits',
 	rules: {
 		'body-leading-blank': [1, 'always'],

@commitlint/config-angular/package.json

@@ -1,8 +1,21 @@
+import path from 'path';
+import {pathToFileURL} from 'url';
+
 import lint from '@commitlint/lint';
-import {rules, parserPreset} from '.';
+
+import config from './index.js';
+
+const {rules, parserPreset} = config;
+
+const dynamicImport = async (id) => {
+	const imported = await import(
+		path.isAbsolute(id) ? pathToFileURL(id).toString() : id
+	);
+	return ('default' in imported && imported.default) || imported;
+};
 
 const commitLint = async (message) => {
-	const preset = await require(parserPreset)();
+	const preset = (await dynamicImport(parserPreset))();
 	return lint(message, rules, {...preset});
 };
 

@commitlint/config-conventional/index.js

@@ -1,5 +1,6 @@
 {
   "name": "@commitlint/config-conventional",
+  "type": "module",
   "version": "18.6.0",
   "description": "Shareable commitlint config enforcing conventional commits",
   "files": [

@commitlint/config-conventional/index.test.js

@@ -1,9 +1,14 @@
-const glob = require('glob');
-const Path = require('path');
-const importFrom = require('import-from');
-const semver = require('semver');
+import {createRequire} from 'module';
+import Path from 'path';
+import {pathToFileURL} from 'url';
 
-module.exports = {
+import glob from 'glob';
+import importFrom from 'import-from';
+import semver from 'semver';
+
+const require = createRequire(import.meta.url);
+
+export default {
 	utils: {getPackages},
 	rules: {
 		'scope-enum': (ctx) =>
@@ -62,6 +67,5 @@ function getLernaVersion(cwd) {
 		'lerna'
 	);
 	const modulePackageJson = Path.join(moduleDir, 'package.json');
-
 	return require(modulePackageJson).version;
 }

@commitlint/config-conventional/package.json

@@ -1,6 +1,11 @@
-import Path from 'path';
+import path from 'path';
+import {fileURLToPath} from 'url';
+
 import {npm} from '@commitlint/test';
-import config from '.';
+
+import config from './index.js';
+
+const __dirname = path.resolve(fileURLToPath(import.meta.url), '..');
 
 test('exports rules key', () => {
 	expect(config).toHaveProperty('rules');
@@ -78,7 +83,7 @@ test('returns expected value for scoped lerna repository', async () => {
 
 test('returns expected value for yarn workspaces', async () => {
 	const {'scope-enum': fn} = config.rules;
-	const cwd = Path.join(__dirname, 'fixtures', 'yarn');
+	const cwd = path.join(__dirname, 'fixtures', 'yarn');
 	const [, , value] = await fn({cwd});
 	expect(value.sort()).toEqual(['a', 'b']);
 });

@commitlint/config-lerna-scopes/index.js

@@ -1,5 +1,6 @@
 {
   "name": "@commitlint/config-lerna-scopes",
+  "type": "module",
   "version": "18.4.4",
   "description": "Shareable commitlint config enforcing lerna package and workspace names as scopes",
   "files": [
@@ -45,7 +46,8 @@
   },
   "devDependencies": {
     "@commitlint/test": "^18.0.0",
-    "@commitlint/utils": "^18.4.4"
+    "@commitlint/utils": "^18.4.4",
+    "@types/glob": "^8.1.0"
   },
   "gitHead": "70f7f4688b51774e7ac5e40e896cdaa3f132b2bc"
 }