stylelint-find-new-rules 6.0.0 → 6.1.0

package/eslint.config.mjs

@@ -1 +1,15 @@
-export { default } from '@pulsanova/eslint-config-node';
+import config from '@pulsanova/eslint-config-node';
+
+export default [
+    ...config,
+    {
+        files: ['index.d.ts'],
+        languageOptions: {
+            parserOptions: {
+                projectService: {
+                    allowDefaultProject: ['index.d.ts'],
+                },
+            },
+        },
+    },
+];

package/index.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Stylelint rule metadata returned by stylelint-find-new-rules.
+ */
+export type Rule = {
+    /** Rule name, including the plugin namespace when present. */
+    name: string,
+
+    /** Documentation URL when it can be resolved. */
+    url: string | null,
+
+    /**
+     * Whether the rule is marked as deprecated.
+     *
+     * Absent when the configured rule cannot be matched to an available rule.
+     */
+    isDeprecated?: boolean,
+};
+
+/**
+ * Result of comparing a resolved Stylelint config with all available rules.
+ */
+export type Result = {
+    /** All available core and plugin rules. */
+    all: Rule[],
+
+    /** Rules configured in the resolved Stylelint config. */
+    used: Rule[],
+
+    /** Available non-deprecated rules missing from the config. */
+    unused: Rule[],
+
+    /** Configured rules that are not available. */
+    invalid: Rule[],
+
+    /** Configured rules marked as deprecated. */
+    deprecated: Rule[],
+};
+
+/**
+ * Finds available, configured, unused, invalid, and deprecated Stylelint rules.
+ *
+ * @param configFile - Path to a Stylelint config file.
+ *
+ * @returns A promise resolved with the available, configured, unused,
+ *          invalid, and deprecated rules (see {@link Result}).
+ */
+declare const stylelintFindNewRules: (configFile?: string | null) => Promise<Result>;
+
+export default stylelintFindNewRules;

package/lib/utils/rules.js

@@ -35,7 +35,8 @@ export const getAllRules = async (config) => {
         allRules.push(...pluginsRules.flat());
     }
 
-    return allRules;
+    const rulesByName = new Map(allRules.map((rule) => [rule.name, rule]));
+    return [...rulesByName.values()];
 };
 
 export const getUsedRules = async (config, allRules = null) => {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "stylelint-find-new-rules",
-    "version": "6.0.0",
+    "version": "6.1.0",
     "description": "Find stylelint rules that you don't have in your config",
     "homepage": "https://github.com/Donov4n/stylelint-find-new-rules",
     "license": "MIT",
@@ -12,23 +12,30 @@
     "contributors": [
         "Alex Ilyaev"
     ],
-    "exports": "./lib/index.js",
+    "exports": {
+        ".": {
+            "types": "./index.d.ts",
+            "default": "./lib/index.js"
+        }
+    },
+    "types": "./index.d.ts",
     "type": "module",
     "bin": {
         "stylelint-find-new-rules": "bin/stylelint-find-new-rules.js"
     },
     "scripts": {
-        "lint": "eslint --ext .js lib"
+        "lint": "eslint --ext .js lib",
+        "test": "node --test test/*.test.js"
     },
     "dependencies": {
         "columnify": "~1.6.0",
         "picocolors": "^1.1.1",
-        "read-pkg": "^10.0.0",
+        "read-pkg": "^10.1.0",
         "yargs": "~18.0.0"
     },
     "devDependencies": {
-        "@pulsanova/eslint-config-node": "~3.1.2",
-        "eslint": "~9.39.2",
+        "@pulsanova/eslint-config-node": "~3.3.3",
+        "eslint": "~10.6.0",
         "stylelint": "^17"
     },
     "peerDependencies": {

package/test/fixtures/duplicate-plugin.config.mjs

@@ -0,0 +1,20 @@
+const plugin = [
+    {
+        ruleName: 'fixture/no-css',
+        rule: () => {},
+    },
+    {
+        ruleName: 'fixture/no-scss',
+        rule: () => {},
+    },
+];
+
+export default {
+    // The same plugin is listed twice to emulate separate CSS and SCSS configs.
+    plugins: [plugin, plugin],
+    rules: {
+        'fixture/no-css': true,
+        // `fixture/no-scss` is intentionally absent from `rules`,
+        // so it should be reported as unused once.
+    },
+};

package/test/rules.test.js

@@ -0,0 +1,16 @@
+import assert from 'node:assert/strict';
+import { fileURLToPath } from 'node:url';
+import test from 'node:test';
+import stylelintFindNewRules from '../lib/index.js';
+
+const countRules = (rules, name) => rules.filter((rule) => rule.name === name).length;
+
+test('Deduplicates plugin rules when the same plugin is configured more than once', async () => {
+    const configFile = fileURLToPath(new URL('./fixtures/duplicate-plugin.config.mjs', import.meta.url));
+    const { all, unused } = await stylelintFindNewRules(configFile);
+
+    assert.equal(countRules(all, 'fixture/no-css'), 1);
+    assert.equal(countRules(all, 'fixture/no-scss'), 1);
+    assert.equal(countRules(unused, 'fixture/no-css'), 0);
+    assert.equal(countRules(unused, 'fixture/no-scss'), 1);
+});