Fix and extend commitlint plugin (resolves #628)

packages/knip/fixtures/plugins/commitlint/.commitlintrc.json

@@ -1 +1,4 @@
-{ "extends": ["@commitlint/config-conventional"], "plugins": ["commitlint-plugin-tense"] }
+{
+  "extends": ["@commitlint/config-conventional"],
+  "plugins": ["commitlint-plugin-tense"]
+}

packages/knip/fixtures/plugins/commitlint/commitlint.config.js

@@ -1 +1,17 @@
-module.exports = { extends: ['@commitlint/config-conventional'], plugins: ['commitlint-plugin-tense'] };
+module.exports = {
+  extends: ['lerna', '@commitlint/config-conventional'],
+  parserPreset: 'conventional-changelog-atom',
+  formatter: '@commitlint/format',
+  plugins: [
+    {
+      rules: {
+        'contains-issue': () => {},
+        'dollar-sign': () => {},
+      },
+    },
+    'commitlint-plugin-tense',
+  ],
+  rules: {
+    'type-enum': [2, 'always', ['oh-no']],
+  },
+};

packages/knip/fixtures/plugins/commitlint/package.json

@@ -4,9 +4,7 @@
     "@commitlint/cli": "*"
   },
   "commitlint": {
-    "extends": [
-      "@commitlint/config-conventional"
-    ],
+    "extends": ["@commitlint/config-conventional"],
     "plugins": ["commitlint-plugin-tense"]
   }
 }

packages/knip/src/plugins/commitlint/index.ts

@@ -1,14 +1,10 @@
 import type { IsPluginEnabled, Plugin, ResolveConfig } from '#p/types/plugins.js';
 import { hasDependency } from '#p/util/plugin.js';
+import type { CommitLintConfig } from './types.js';
 
 // https://commitlint.js.org
 // https://github.com/conventional-changelog/commitlint#config
 
-type CommitLintConfig = {
-  extends: string[];
-  plugins: string[];
-};
-
 const title = 'commitlint';
 
 const enablers = ['@commitlint/cli'];
@@ -23,9 +19,15 @@ const config = [
 ];
 
 const resolveConfig: ResolveConfig<CommitLintConfig> = config => {
-  const extendsConfigs = config.extends ? [config.extends].flat() : [];
-  const plugins = config.plugins ? [config.plugins].flat() : [];
-  return [...extendsConfigs, ...plugins];
+  const extendsConfigs = config.extends
+    ? [config.extends]
+        .flat()
+        .map(id => (id.startsWith('@') || id.startsWith('commitlint-config-') ? id : `commitlint-config-${id}`))
+    : [];
+  const plugins = config.plugins ? [config.plugins].flat().filter(s => typeof s === 'string') : [];
+  const formatter = config.formatter ? [config.formatter] : [];
+  const parserPreset = config.parserPreset ? [config.parserPreset] : [];
+  return [...extendsConfigs, ...plugins, ...formatter, ...parserPreset];
 };
 
 export default {

packages/knip/src/plugins/commitlint/types.ts

@@ -0,0 +1,6 @@
+export type CommitLintConfig = {
+  extends?: string | string[];
+  plugins?: string[];
+  formatter?: string;
+  parserPreset?: string;
+};

packages/knip/test/plugins/commitlint.test.ts

@@ -14,16 +14,21 @@ test('Find dependencies with the Commitizen plugin', async () => {
   });
 
   assert(issues.unlisted['.commitlintrc.json']['@commitlint/config-conventional']);
-  assert(issues.unlisted['commitlint.config.js']['@commitlint/config-conventional']);
-  assert(issues.unlisted['package.json']['@commitlint/config-conventional']);
   assert(issues.unlisted['.commitlintrc.json']['commitlint-plugin-tense']);
+
+  assert(issues.unlisted['commitlint.config.js']['@commitlint/config-conventional']);
   assert(issues.unlisted['commitlint.config.js']['commitlint-plugin-tense']);
+  assert(issues.unlisted['commitlint.config.js']['commitlint-config-lerna']);
+  assert(issues.unlisted['commitlint.config.js']['conventional-changelog-atom']);
+  assert(issues.unlisted['commitlint.config.js']['@commitlint/format']);
+
+  assert(issues.unlisted['package.json']['@commitlint/config-conventional']);
   assert(issues.unlisted['package.json']['commitlint-plugin-tense']);
 
   assert.deepEqual(counters, {
     ...baseCounters,
     devDependencies: 1,
-    unlisted: 6,
+    unlisted: 9,
     processed: 1,
     total: 1,
   });