Remove import-lazy and change stylelint.rules Promise-based (#7279)

This commit makes the following changes, including a breaking:

- Remove the `import-lazy` dependency
- Make the `stylelint.rules` object Promise-based (breaking)

Thanks to these changes, the test suite is executed for ESM rules (`lib/rules/*/index.mjs`), instead of CJS ones (`*.cjs`).

.changeset/slow-planes-begin.md

@@ -0,0 +1,5 @@
+---
+"stylelint": major
+---
+
+Changed: Node.js API so that the `stylelint.rules` object has `Promise` functions

docs/developer-guide/plugins.md

@@ -297,15 +297,16 @@ Here's an example of a plugin that runs `declaration-no-important` only if there
 
 ```js
 module.exports = stylelint.createPlugin(ruleName, (expectation) => {
-  const runDeclarationNoImportant =
-    stylelint.rules["declaration-no-important"](expectation);
+  const runDeclarationNoImportant = stylelint.rules[
+    "declaration-no-important"
+  ].then((rule) => rule(expectation));
 
   return (root, result) => {
-    if (root.toString().indexOf("@@check-declaration-no-important") === -1) {
+    if (!root.toString().includes("@@check-declaration-no-important")) {
       return;
     }
 
-    runDeclarationNoImportant(root, result);
+    return runDeclarationNoImportant.then((rule) => rule(root, result));
   };
 });
 ```

docs/developer-guide/rules.md

@@ -260,6 +260,7 @@ The final step is to add references to the new rule in the following places:
 
 - [The rules `index.mjs` file](../../lib/rules/index.mjs)
 - [The list of rules](../user-guide/rules.md)
+- [The type definition of rules](../../types/stylelint/index.d.ts)
 
 ## Add an option to a rule
 

docs/migration-guide/to-16.md

@@ -52,8 +52,17 @@ If you use `stylelint.lint()` to lint files, the `code` property will always be
 We've changed the `stylelint.formatters` object in the Node.js API so that every formatter is a `Promise` function.
 
 ```diff js
--stylelint.formatters.json(results);
-+stylelint.formatters.json.then(formatter => formatter(results));
+-const formatter = stylelint.formatters.json;
++const formatter = await stylelint.formatters.json;
+```
+
+## Changed Node.js API returned `rules` object
+
+We've changed the `stylelint.rules` object in the Node.js API so that every rule is a `Promise` function.
+
+```diff js
+-const rule = stylelint.rules['block-no-empty'];
++const rule = await stylelint.rules['block-no-empty'];
 ```
 
 ## Changed CLI to print problems to stderr

lib/__tests__/fixtures/plugin-conditionally-check-color-named.cjs

@@ -5,11 +5,13 @@ const stylelint = require('../../index.cjs');
 const ruleName = 'plugin/conditionally-check-color-named';
 
 module.exports = stylelint.createPlugin(ruleName, (expectation, options, context) => {
-	const colorNamedRule = stylelint.rules['color-named'](expectation, options, context);
+	const colorNamedRule = stylelint.rules['color-named'].then((rule) =>
+		rule(expectation, options, context),
+	);
 
 	return (root, result) => {
 		if (!root.toString().includes('@@check-color-named')) return;
 
-		colorNamedRule(root, result);
+		return colorNamedRule.then((rule) => rule(root, result));
 	};
 });

lib/__tests__/normalizeRuleSettings.test.mjs

@@ -33,8 +33,9 @@ describe('rules whose primary option IS NOT an array', () => {
 		expect(actual).toEqual(expected);
 	});
 
-	it('arrayed number with secondary options returns same', () => {
-		const actual = normalizeRuleSettings([2, { severity: 'warning' }], rules['block-no-empty']);
+	it('arrayed number with secondary options returns same', async () => {
+		const rule = await rules['block-no-empty'];
+		const actual = normalizeRuleSettings([2, { severity: 'warning' }], rule);
 		const expected = [2, { severity: 'warning' }];
 
 		expect(actual).toEqual(expected);
@@ -75,8 +76,9 @@ describe('rules whose primary option IS NOT an array', () => {
 		expect(actual).toEqual(expected);
 	});
 
-	it('arrayed boolean with secondary options returns same', () => {
-		const actual = normalizeRuleSettings([true, { severity: 'warning' }], rules['block-no-empty']);
+	it('arrayed boolean with secondary options returns same', async () => {
+		const rule = await rules['block-no-empty'];
+		const actual = normalizeRuleSettings([true, { severity: 'warning' }], rule);
 		const expected = [true, { severity: 'warning' }];
 
 		expect(actual).toEqual(expected);
@@ -92,25 +94,25 @@ describe('rules whose primary option CAN BE an array', () => {
 		expect(normalizeRuleSettings([null], mockRule)).toBeNull();
 	});
 
-	it('solo primary option array is nested within an array', () => {
-		const actual = normalizeRuleSettings(['calc', 'rgba'], rules['function-allowed-list']);
+	it('solo primary option array is nested within an array', async () => {
+		const rule = await rules['function-allowed-list'];
+		const actual = normalizeRuleSettings(['calc', 'rgba'], rule);
 		const expected = [['calc', 'rgba']];
 
 		expect(actual).toEqual(expected);
 	});
 
-	it('primary option array in an array', () => {
-		const actual = normalizeRuleSettings([['calc', 'rgba']], rules['function-allowed-list']);
+	it('primary option array in an array', async () => {
+		const rule = await rules['function-allowed-list'];
+		const actual = normalizeRuleSettings([['calc', 'rgba']], rule);
 		const expected = [['calc', 'rgba']];
 
 		expect(actual).toEqual(expected);
 	});
 
-	it('nested primary option array returns same', () => {
-		const actual = normalizeRuleSettings(
-			[['calc', 'rgba'], { severity: 'warning' }],
-			rules['function-allowed-list'],
-		);
+	it('nested primary option array returns same', async () => {
+		const rule = await rules['function-allowed-list'];
+		const actual = normalizeRuleSettings([['calc', 'rgba'], { severity: 'warning' }], rule);
 		const expected = [['calc', 'rgba'], { severity: 'warning' }];
 
 		expect(actual).toEqual(expected);

lib/__tests__/standalone-deprecations.test.mjs

@@ -1,26 +1,20 @@
-import { createRequire } from 'node:module';
 import readJSONFile from '../testUtils/readJSONFile.mjs';
 import standalone from '../standalone.mjs';
 
 import { jest } from '@jest/globals';
 
-jest.mock('../rules/block-no-empty/index.cjs');
-
-const require = createRequire(import.meta.url);
-const blockNoEmpty = require('../rules/block-no-empty/index.cjs');
+jest.unstable_mockModule('../rules/block-no-empty/index.mjs', () => ({
+	default() {
+		return (root, result) => {
+			result.warn('Some deprecation', { stylelintType: 'deprecation' });
+		};
+	},
+}));
 
 const configBlockNoEmpty = readJSONFile(
 	new URL('./fixtures/config-block-no-empty.json', import.meta.url),
 );
 
-blockNoEmpty.mockImplementation(() => {
-	return (root, result) => {
-		result.warn('Some deprecation', {
-			stylelintType: 'deprecation',
-		});
-	};
-});
-
 describe('standalone with deprecations', () => {
 	it('works', async () => {
 		const { output, results } = await standalone({

lib/__tests__/standalone-quiet-deprecation-warnings.test.mjs

@@ -1,14 +1,8 @@
-import { createRequire } from 'node:module';
 import { jest } from '@jest/globals';
 import report from '../utils/report.mjs';
 import standalone from '../standalone.mjs';
 
-jest.mock('../rules/block-no-empty/index.cjs');
-
-const require = createRequire(import.meta.url);
-const deprecatedRule = require('../rules/block-no-empty/index.cjs');
-
-deprecatedRule.mockImplementation(() => {
+const deprecatedRule = () => {
 	return (root, result) => {
 		report({
 			ruleName: 'block-no-empty',
@@ -17,10 +11,12 @@ deprecatedRule.mockImplementation(() => {
 			result,
 		});
 	};
-});
+};
 
 deprecatedRule.meta = { deprecated: true };
 
+jest.unstable_mockModule('../rules/block-no-empty/index.mjs', () => ({ default: deprecatedRule }));
+
 it('standalone does not silence deprecation warnings by default', async () => {
 	const config = {
 		rules: {

lib/augmentConfig.cjs

@@ -132,7 +132,7 @@ async function augmentConfigFull(stylelint, filePath, cosmiconfigResult) {
 		);
 	}
 
-	augmentedConfig = normalizeAllRuleSettings(augmentedConfig);
+	augmentedConfig = await normalizeAllRuleSettings(augmentedConfig);
 
 	return {
 		config: augmentedConfig,

lib/augmentConfig.mjs

@@ -129,7 +129,7 @@ export async function augmentConfigFull(stylelint, filePath, cosmiconfigResult)
 		);
 	}
 
-	augmentedConfig = normalizeAllRuleSettings(augmentedConfig);
+	augmentedConfig = await normalizeAllRuleSettings(augmentedConfig);
 
 	return {
 		config: augmentedConfig,

lib/lintPostcssResult.cjs

@@ -19,7 +19,7 @@ const index = require('./rules/index.cjs');
  * @param {StylelintConfig} config
  * @returns {Promise<any>}
  */
-function lintPostcssResult(stylelintOptions, postcssResult, config) {
+async function lintPostcssResult(stylelintOptions, postcssResult, config) {
 	postcssResult.stylelint.ruleSeverities = {};
 	postcssResult.stylelint.customMessages = {};
 	postcssResult.stylelint.ruleMetadata = {};
@@ -66,7 +66,7 @@ function lintPostcssResult(stylelintOptions, postcssResult, config) {
 		: [];
 
 	for (const ruleName of ruleNames) {
-		const ruleFunction = getStylelintRule(ruleName, config);
+		const ruleFunction = await getStylelintRule(ruleName, config);
 
 		if (ruleFunction === undefined) {
 			performRules.push(

lib/lintPostcssResult.mjs

@@ -16,7 +16,7 @@ import rules from './rules/index.mjs';
  * @param {StylelintConfig} config
  * @returns {Promise<any>}
  */
-export default function lintPostcssResult(stylelintOptions, postcssResult, config) {
+export default async function lintPostcssResult(stylelintOptions, postcssResult, config) {
 	postcssResult.stylelint.ruleSeverities = {};
 	postcssResult.stylelint.customMessages = {};
 	postcssResult.stylelint.ruleMetadata = {};
@@ -63,7 +63,7 @@ export default function lintPostcssResult(stylelintOptions, postcssResult, confi
 		: [];
 
 	for (const ruleName of ruleNames) {
-		const ruleFunction = getStylelintRule(ruleName, config);
+		const ruleFunction = await getStylelintRule(ruleName, config);
 
 		if (ruleFunction === undefined) {
 			performRules.push(

lib/normalizeAllRuleSettings.cjs

@@ -9,16 +9,16 @@ const normalizeRuleSettings = require('./normalizeRuleSettings.cjs');
 
 /**
  * @param {StylelintConfig} config
- * @return {StylelintConfig}
+ * @return {Promise<StylelintConfig>}
  */
-function normalizeAllRuleSettings(config) {
+async function normalizeAllRuleSettings(config) {
 	if (!config.rules) return config;
 
 	/** @type {StylelintConfig['rules']} */
 	const normalizedRules = {};
 
 	for (const [ruleName, rawRuleSettings] of Object.entries(config.rules)) {
-		const rule = getStylelintRule(ruleName, config);
+		const rule = await getStylelintRule(ruleName, config);
 
 		if (rule) {
 			normalizedRules[ruleName] = normalizeRuleSettings(rawRuleSettings, rule);

lib/normalizeAllRuleSettings.mjs

@@ -5,16 +5,16 @@ import normalizeRuleSettings from './normalizeRuleSettings.mjs';
 
 /**
  * @param {StylelintConfig} config
- * @return {StylelintConfig}
+ * @return {Promise<StylelintConfig>}
  */
-export default function normalizeAllRuleSettings(config) {
+export default async function normalizeAllRuleSettings(config) {
 	if (!config.rules) return config;
 
 	/** @type {StylelintConfig['rules']} */
 	const normalizedRules = {};
 
 	for (const [ruleName, rawRuleSettings] of Object.entries(config.rules)) {
-		const rule = getStylelintRule(ruleName, config);
+		const rule = await getStylelintRule(ruleName, config);
 
 		if (rule) {
 			normalizedRules[ruleName] = normalizeRuleSettings(rawRuleSettings, rule);