stylelint-find-new-rules 4.1.1 → 5.0.0

package/README.md

@@ -72,23 +72,23 @@ npm run --silent stylelint-find-rules
 ## API Usage
 
 ```js
-const stylelintRules = require('stylelint-find-new-rules');
-
-stylelintRules('./my-config-file.js').then((rules) => {
-    // `rules` format:
-    // {
-    //     used       : [[RULE], [RULE], ...],
-    //     all        : [[RULE], [RULE], ...],
-    //     unused     : [[RULE], [RULE], ...],
-    //     deprecated : [[RULE], [RULE], ...],
-    //     invalid    : [[RULE], [RULE], ...]
-    // }
-    // 
-    // `[RULE]` format:
-    // {
-    //     name         : '[Rule name]',
-    //     url          : '[URL of the rule's documentation if available or `null`]',
-    //     isDeprecated : [boolean]
-    // }
-});
+import stylelintRules from 'stylelint-find-new-rules';
+
+const rules = await stylelintRules('./my-config-file.js');
+
+// `rules` format:
+// {
+//     used       : [[RULE], [RULE], ...],
+//     all        : [[RULE], [RULE], ...],
+//     unused     : [[RULE], [RULE], ...],
+//     deprecated : [[RULE], [RULE], ...],
+//     invalid    : [[RULE], [RULE], ...]
+// }
+// 
+// `[RULE]` format:
+// {
+//     name         : '[Rule name]',
+//     url          : '[URL of the rule's documentation if available or `null`]',
+//     isDeprecated : [boolean]
+// }
 ```

package/bin/stylelint-find-new-rules.js

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

package/lib/cli.js

@@ -1,11 +1,12 @@
-'use strict';
-
-const colors = require('picocolors');
-const yargs = require('yargs');
-const standalone = require('./index');
-const { print, printRules } = require('./utils/print');
-
-const pkg = require('../package.json');
+import yargs from 'yargs';
+import { hideBin } from 'yargs/helpers';
+import colors from 'picocolors';
+import { readPackageSync } from 'read-pkg';
+import process from 'node:process';
+import { dirname } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import standalone from './index.js';
+import { print, printRules } from './utils/print.js';
 
 const DEFAULT_OPTIONS = {
     unused: true,
@@ -27,7 +28,7 @@ const handleError = (err) => {
 
 process.on('unhandledRejection', handleError);
 
-const { argv } = yargs
+const { argv } = yargs(hideBin(process.argv))
     .usage('stylelint-find-new-rules [options] <file>')
     .example('stylelint-find-new-rules')
     .example('stylelint-find-new-rules --no-d --no-i')
@@ -91,6 +92,10 @@ if (!options.unused && !options.deprecated && !options.current && !options.avail
 }
 
 const printResults = (rules) => {
+    const pkg = readPackageSync({
+        cwd: dirname(dirname(fileURLToPath(import.meta.url))),
+        normalize: false,
+    });
     print(`stylelint-find-new-rules v${pkg.version}`);
 
     if (options.current) {

package/lib/index.js

@@ -1,23 +1,22 @@
-'use strict';
+import process from 'node:process';
+import stylelint from 'stylelint';
+import { getAllRules, getUsedRules } from './utils/rules.js';
 
-const { resolveConfig } = require('stylelint');
-const { getAllRules, getUsedRules } = require('./utils/rules');
+export default async (configFile = null) => {
+    const config = await stylelint.resolveConfig(process.cwd(), { configFile });
 
-module.exports = async (configFile = null) => {
-    const config = await resolveConfig(process.cwd(), { configFile });
-
-    const all = getAllRules(config);
-    const used = getUsedRules(config, all);
+    const all = await getAllRules(config);
+    const used = await getUsedRules(config, all);
     const deprecated = used.filter(({ isDeprecated }) => isDeprecated);
 
     const unused = all.filter(
         ({ name, isDeprecated }) => (
-            !isDeprecated && !used.find((_rule) => _rule.name === name)
+            !isDeprecated && !used.some((_rule) => _rule.name === name)
         ),
     );
 
     const invalid = used.filter(
-        ({ name }) => !all.find((_rule) => _rule.name === name),
+        ({ name }) => !all.some((_rule) => _rule.name === name),
     );
 
     return { all, used, unused, invalid, deprecated };

package/lib/utils/extractRuleMeta.js

@@ -1,5 +1,3 @@
-'use strict';
-
 const PLUGINS_URL_RESOLVER = {
     'stylelint': (rule) => (
         `https://stylelint.io/user-guide/rules/list/${rule}`
@@ -54,4 +52,4 @@ const extractRuleMeta = (name, rule, isPlugin) => {
     return { name, isDeprecated: deprecated, url };
 };
 
-module.exports = extractRuleMeta;
+export default extractRuleMeta;

package/lib/utils/print.js

@@ -1,15 +1,14 @@
-'use strict';
+import columnify from 'columnify';
+import colors from 'picocolors';
+import process from 'node:process';
+import os from 'node:os';
 
-const columnify = require('columnify');
-const colors = require('picocolors');
-const os = require('os');
-
-const print = (output) => {
+export const print = (output) => {
     process.stdout.write(output);
     process.stdout.write(os.EOL + os.EOL);
 };
 
-const printRules = (heading, rules, options = {}) => {
+export const printRules = (heading, rules, options = {}) => {
     const defaults = { color: null, showLink: true };
     const { color, showLink } = { ...defaults, ...options };
 
@@ -34,5 +33,3 @@ const printRules = (heading, rules, options = {}) => {
     print(colors.underline(colors[color || 'blue'](heading)));
     print(columnify(rulesToPrint, {}));
 };
-
-module.exports = { print, printRules };

package/lib/utils/rules.js

@@ -1,36 +1,46 @@
-'use strict';
+import { isAbsolute } from 'node:path';
+import { pathToFileURL } from 'node:url';
+import stylelint from 'stylelint';
+import extractRuleMeta from './extractRuleMeta.js';
 
-const coreRules = require('stylelint').rules;
-const extractRuleMeta = require('./extractRuleMeta');
-
-const getAllRules = (config) => {
-    const rules = Object.entries(coreRules).map(([name, rule]) => (
-        extractRuleMeta(name, rule, false)
-    ));
+export const getAllRules = async (config) => {
+    const allRules = Object.entries(stylelint.rules).map(
+        ([name, rule]) => extractRuleMeta(name, rule, false),
+    );
 
     if (config.plugins) {
-        [config.plugins].flat().forEach((plugin) => {
-            let pluginRules;
-            pluginRules = require(plugin); // eslint-disable-line import/no-dynamic-require, global-require
-            pluginRules = pluginRules.default || pluginRules; // - ES6 or CommonJS modules
-            pluginRules = [pluginRules].flat();
-
-            pluginRules.forEach(({ ruleName: name, rule }) => {
-                if (!name || !name.includes('/')) {
-                    return;
-                }
-                rules.push(extractRuleMeta(name, rule, true));
-            });
-        });
+        // @see https://github.com/stylelint/stylelint/blob/16.1.0/lib/augmentConfig.mjs#L317
+        const plugins = [config.plugins].flat();
+        const pluginsRules = await Promise.all(plugins.map(async (plugin) => {
+            let rawPluginRules = typeof plugin !== 'string' ? plugin : (
+                await import(
+                    isAbsolute(plugin)
+                        ? pathToFileURL(plugin).toString()
+                        : plugin
+                )
+            );
+            rawPluginRules = rawPluginRules.default || rawPluginRules; // - ESM / CommonJS.
+            rawPluginRules = [rawPluginRules].flat();
+
+            return rawPluginRules.reduce(
+                (pluginRules, { ruleName: name, rule }) => {
+                    if (name?.includes('/')) {
+                        pluginRules.push(extractRuleMeta(name, rule, true));
+                    }
+                    return pluginRules;
+                },
+                [],
+            );
+        }));
+        allRules.push(...pluginsRules.flat());
     }
 
-    return rules;
+    return allRules;
 };
 
-const getUsedRules = (config, allRules = null) => {
-    if (allRules === null) {
-        allRules = getAllRules(config);
-    }
+export const getUsedRules = async (config, allRules = null) => {
+    // eslint-disable-next-line require-atomic-updates
+    allRules ??= await getAllRules(config);
 
     const rules = Object.keys(config.rules || {})
         .filter((value, index, self) => self.indexOf(value) === index)
@@ -41,5 +51,3 @@ const getUsedRules = (config, allRules = null) => {
 
     return rules;
 };
-
-module.exports = { getUsedRules, getAllRules };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "stylelint-find-new-rules",
-    "version": "4.1.1",
+    "version": "5.0.0",
     "description": "Find stylelint rules that you don't have in your config",
     "homepage": "https://github.com/Donov4n/stylelint-find-new-rules",
     "license": "MIT",
@@ -9,9 +9,10 @@
     "contributors": [
         "Alex Ilyaev"
     ],
-    "main": "lib/index.js",
+    "exports": "./lib/index.js",
+    "type": "module",
     "bin": {
-        "stylelint-find-new-rules": "bin/stylelint-find-new-rules.js"
+        "stylelint-find-new-rules": "./bin/stylelint-find-new-rules.js"
     },
     "scripts": {
         "lint": "eslint --ext .js lib"
@@ -19,17 +20,19 @@
     "dependencies": {
         "columnify": "~1.6.0",
         "picocolors": "^1.0.0",
-        "yargs": "~17.3.1"
+        "read-package-up": "^11.0.0",
+        "read-pkg": "^9.0.1",
+        "yargs": "~17.7.2"
     },
     "devDependencies": {
-        "@pulsanova/eslint-config-base": "~2.1.2",
-        "eslint": "^8.11.0",
-        "stylelint": "^15"
+        "@pulsanova/eslint-config-node": "~2.3.0",
+        "eslint": "^8.56.0",
+        "stylelint": "^16"
     },
     "peerDependencies": {
-        "stylelint": "^14.2.0 || ^15"
+        "stylelint": "^16"
     },
     "engines": {
-        "node": ">=10"
+        "node": ">=18.12.0"
     }
 }