feat(deps)!: update commitlint monorepo to v19

BREAKING CHANGE: Drop support for @commitlint v9 up to and indlucing v18
BREAKING CHANGE: Require Node.js 20 minimum

Author: jdbruijn

package-lock.json

@@ -19,19 +19,12 @@
   "license": "GPL-3.0-or-later",
   "author": "Jeroen de Bruijn",
   "type": "module",
-  "exports": {
-    ".": {
-      "import": "./dist/config.js",
-      "require": "./dist/index.cjs"
-    }
-  },
+  "exports": "./dist/index.js",
   "files": [
     "./dist/**/!(*.test).{js,d.ts,cjs}"
   ],
   "scripts": {
-    "build": "npm run build:esm && npm run build:cjs",
-    "build:cjs": "esbuild src/index.ts --bundle --target=ES2022 --platform=node --outfile=dist/index.cjs",
-    "build:esm": "tsc",
+    "build": "tsc",
     "format": "prettier --ignore-path .gitignore --write \"**/*.{vue,css,less,scss,html,htm,json,md,markdown,yml,yaml}\" --log-level warn",
     "format:check": "prettier --ignore-path .gitignore --check \"**/*.{vue,css,less,scss,html,htm,json,md,markdown,yml,yaml}\" --log-level warn",
     "lint": "npm run format:check && xo",
@@ -192,37 +185,20 @@
     ]
   },
   "dependencies": {
-    "@commitlint/config-conventional": "18.5.0",
-    "commitlint-plugin-function-rules": "3.1.0"
+    "@commitlint/config-conventional": "19.1.0",
+    "commitlint-plugin-function-rules": "4.0.0-beta.1"
   },
   "devDependencies": {
     "@ava/typescript": "4.1.0",
-    "@commitlint/cli": "18.5.0",
-    "@commitlint/lint-10.x": "npm:@commitlint/lint@10.0.0",
-    "@commitlint/lint-11.x": "npm:@commitlint/lint@11.0.0",
-    "@commitlint/lint-12.x": "npm:@commitlint/lint@12.1.4",
-    "@commitlint/lint-13.x": "npm:@commitlint/lint@13.2.0",
-    "@commitlint/lint-14.x": "npm:@commitlint/lint@14.1.0",
-    "@commitlint/lint-15.x": "npm:@commitlint/lint@15.0.0",
-    "@commitlint/lint-16.x": "npm:@commitlint/lint@16.2.4",
-    "@commitlint/lint-17.x": "npm:@commitlint/lint@18.5.0",
-    "@commitlint/lint-9.x": "npm:@commitlint/lint@9.1.2",
-    "@commitlint/load-10.x": "npm:@commitlint/load@10.0.0",
-    "@commitlint/load-11.x": "npm:@commitlint/load@11.0.0",
-    "@commitlint/load-12.x": "npm:@commitlint/load@12.1.4",
-    "@commitlint/load-13.x": "npm:@commitlint/load@13.2.1",
-    "@commitlint/load-14.x": "npm:@commitlint/load@14.1.0",
-    "@commitlint/load-15.x": "npm:@commitlint/load@15.0.0",
-    "@commitlint/load-16.x": "npm:@commitlint/load@16.3.0",
-    "@commitlint/load-17.x": "npm:@commitlint/load@18.5.0",
-    "@commitlint/load-9.x": "npm:@commitlint/load@9.1.2",
-    "@commitlint/types": "18.4.4",
+    "@commitlint/cli": "19.2.0",
+    "@commitlint/lint-19.x": "npm:@commitlint/lint@19.1.0",
+    "@commitlint/load-19.x": "npm:@commitlint/load@19.1.0",
+    "@commitlint/types": "19.0.3",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/exec": "6.0.3",
     "@semantic-release/git": "10.0.1",
     "ava": "6.1.2",
     "c8": "9.1.0",
-    "esbuild": "0.20.1",
     "husky": "9.0.11",
     "lint-staged": "15.2.2",
     "prettier": "3.2.5",
@@ -231,6 +207,6 @@
     "xo": "0.58.0"
   },
   "engines": {
-    "node": ">=18"
+    "node": ">=20"
   }
 }

package.json

@@ -1,9 +1,15 @@
 import test from 'ava';
-import type commitlintLoad from '@commitlint/load-17.x';
-import type commitlintLint from '@commitlint/lint-17.x';
+import load19x from '@commitlint/load-19.x';
+import lint19x from '@commitlint/lint-19.x';
 import {type LoadOptions} from '@commitlint/types';
-import {config} from './config.js';
 import {headerMaxLength} from './rules/index.js';
+import config from './index.js';
+
+/* eslint-disable @typescript-eslint/naming-convention */
+const versions = {
+  '19.x': {load: load19x, lint: lint19x},
+} as const;
+/* eslint-enable @typescript-eslint/naming-convention */
 
 test('extends the "@commitlint/config-conventional" config', (t) => {
   t.deepEqual(config.extends, ['@commitlint/config-conventional']);
@@ -34,43 +40,24 @@ test(disables, 'header-max-length');
  * configuration.
  */
 const loadOptions: LoadOptions = {file: 'package.json'} as const;
-const loadConfig = test.macro<[string]>({
+const loadConfig = test.macro<[keyof typeof versions]>({
   async exec(t, version) {
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-    const module = await import(`@commitlint/load-${version}`);
-    const load = module.default.default as typeof commitlintLoad.default;
-
-    await t.notThrowsAsync(load(config, loadOptions));
+    await t.notThrowsAsync(versions[version].load(config, loadOptions));
   },
   title: (_, version) =>
     `@commitlint/load@${version} can load the configuration`,
 });
-test(loadConfig, '9.x');
-test(loadConfig, '10.x');
-test(loadConfig, '11.x');
-test(loadConfig, '12.x');
-test(loadConfig, '13.x');
-test(loadConfig, '14.x');
-test(loadConfig, '15.x');
-test(loadConfig, '16.x');
-test(loadConfig, '17.x');
+test(loadConfig, '19.x');
 
-const lintUsingConfiguration = test.macro<[string]>({
+const lintUsingConfiguration = test.macro<[keyof typeof versions]>({
   async exec(t, version) {
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-    const loadModule = await import(`@commitlint/load-${version}`);
-    const load = loadModule.default.default as typeof commitlintLoad.default;
-    const qualifiedConfig = await load(config, loadOptions);
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-    const module = await import(`@commitlint/lint-${version}`);
-    const lint = module.default.default as typeof commitlintLint.default;
-
+    const qualifiedConfig = await versions[version].load(config, loadOptions);
     const input = [
       'chore(deps): we are told to remember the idea, not the man. Because a',
       'man can fail. He can be caught, he can be killed and forgotten. But 400',
       'years later, an idea can still change the world - A. Moore',
     ].join(' ');
-    const outcome = await lint(input, qualifiedConfig.rules, {
+    const outcome = await versions[version].lint(input, qualifiedConfig.rules, {
       plugins: qualifiedConfig.plugins,
     });
 
@@ -79,12 +66,4 @@ const lintUsingConfiguration = test.macro<[string]>({
   title: (_, version) =>
     `@commitlint/lint@${version} can use the configuration`,
 });
-test(lintUsingConfiguration, '9.x');
-test(lintUsingConfiguration, '10.x');
-test(lintUsingConfiguration, '11.x');
-test(lintUsingConfiguration, '12.x');
-test(lintUsingConfiguration, '13.x');
-test(lintUsingConfiguration, '14.x');
-test(lintUsingConfiguration, '15.x');
-test(lintUsingConfiguration, '16.x');
-test(lintUsingConfiguration, '17.x');
+test(lintUsingConfiguration, '19.x');

src/config.ts

@@ -1,11 +1,15 @@
-import {config} from './config.js';
+import {type UserConfig} from '@commitlint/types';
+import {headerMaxLength} from './rules/index.js';
 
-/**
- * Export single object, according to the CommonJS model. The CommonJS module is
- * explicitly used here as that's the kind of module commitlint requires for
- * shareable configurations. This project is an ES module for ease of
- * development, and thus requires the error for an export assignment to be
- * disabled.
- */
-// @ts-expect-error TS1203
-export = config;
+const config: UserConfig = {
+  extends: ['@commitlint/config-conventional'],
+  plugins: ['function-rules'],
+  rules: {
+    'body-max-line-length': [0],
+    'footer-max-line-length': [0],
+    'header-max-length': [0],
+    'function-rules/header-max-length': [2, 'always', headerMaxLength],
+  },
+};
+
+export default config;

src/config.test.ts src/index.test.tssrc/config.test.ts renamed to src/index.test.ts

@@ -1,6 +1,10 @@
 import test from 'ava';
-import {type Commit} from '@commitlint/types';
-import {config, failedMessage, headerMaxLength} from './header-max-length.js';
+import {
+  type Commit,
+  config,
+  failedMessage,
+  headerMaxLength,
+} from './header-max-length.js';
 
 function commit(
   type: string,
@@ -25,7 +29,7 @@ function commit(
     references: [],
     revert: null,
     merge: null,
-  };
+  } as unknown as Commit;
 }
 
 const outcome = test.macro<

src/index.ts

@@ -1,4 +1,6 @@
-import {type Commit, type RuleOutcome} from '@commitlint/types';
+import {type Rule, type RuleOutcome} from '@commitlint/types';
+
+type Commit = Parameters<Rule>[0];
 
 const config = {
   maxLength: 100,
@@ -34,25 +36,24 @@ function failedMessage(dependency: boolean, length: number): string {
 }
 
 function headerMaxLength(parsed: Commit): RuleOutcome {
-  if (parsed.header.length <= config.maxLength) {
+  const headerLength = parsed.header?.length ?? 0;
+  if (headerLength <= config.maxLength) {
     return [true];
   }
 
   const isDependencyCommit = config.dependency.commitStyle.some(
     (commitStyle) =>
-      parsed.type !== null &&
-      commitStyle.type.test(parsed.type) &&
-      parsed.scope !== null &&
-      commitStyle.scope.test(parsed.scope),
+      commitStyle.type.test(parsed.type ?? '') &&
+      commitStyle.scope.test(parsed.scope ?? ''),
   );
   const maxLength = isDependencyCommit
     ? config.dependency.maxLength
     : config.maxLength;
-  if (parsed.header.length > maxLength) {
-    return [false, failedMessage(isDependencyCommit, parsed.header.length)];
+  if (headerLength > maxLength) {
+    return [false, failedMessage(isDependencyCommit, headerLength)];
   }
 
   return [true];
 }
 
-export {config, failedMessage, headerMaxLength};
+export {type Commit, config, failedMessage, headerMaxLength};