linter-bundle 4.0.3 → 5.0.1

package/.linter-bundle.js

@@ -8,7 +8,7 @@ const snippets = {
 	pascalCase: '[A-Z]*([a-zA-Z0-9])'
 };
 
-module.exports = {
+export default {
 	files: {
 		restrictions: [
 			{
@@ -17,30 +17,32 @@ module.exports = {
 					'.git/**',
 					'.github/FUNDING.yml',
 					'.vscode/settings.json',
+					`eslint/rules/package.json`,
 					`eslint/rules/${snippets.kebabCase}.{js,md}`,
-					`eslint/{index.js,overrides-${snippets.kebabCase}.js}`,
+					`eslint/{index.cjs,overrides-${snippets.kebabCase}.cjs}`,
 					'files/index.js',
-					`helper/${snippets.kebabCase}.js`,
+					`helper/${snippets.kebabCase}.{js,cjs,d.ts}`,
 					'markdownlint/base.json',
 					'node_modules/**',
-					'stylelint/index.js',
+					'stylelint/index.cjs',
 					`stylelint/plugins/stylelint-${snippets.kebabCase}.js`,
 					'.editorconfig',
-					'.eslintrc.js',
+					'.eslintrc.cjs',
 					'.gitattributes',
 					'.gitignore',
 					'.linter-bundle.js',
 					'.markdownlint.json',
 					'.npmignore',
 					'*.md',
+					'eslint.cjs',
 					'LICENSE',
 					'lint.js',
 					'package-lock.json',
 					'package.json',
-					'stylelint.config.js',
+					'stylelint.cjs',
+					'stylelint.config.cjs',
+					'test-stylelint.js',
 					'tsconfig.json',
-					'types.d.ts',
-					'validate-stylelint-options.mjs',
 					'vscode-eslint-1.png',
 					'vscode-eslint-2.png'
 				]

package/CHANGELOG.md

@@ -6,7 +6,34 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## [Unreleased]
 
-[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v4.0.3...HEAD)
+[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v5.0.1...HEAD)
+
+## [5.0.1] - 2023-09-03
+
+### Changed
+
+- [general] Updated [README.md](./README.md) to reflect breaking changes in v5.0.0.
+
+[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v5.0.0...v5.0.1)
+
+## [5.0.0] - 2023-09-03
+
+### Breaking change
+
+- [general] Migrated the code base from CommonJS to ESModules (as far as possible, because ESLint currently does not support ESModules)
+- [general] The linter-bundle configuration can now be a ESModule (`.linter-bundle.mjs` is supported)
+- [general] `"extends"` in the .eslintrc.js needs to be suffixed with the ".cjs" file extension (e.g. `require.resolve('linter-bundle/eslint.cjs')`)
+- [general] `"extends"` in the stylelint.config.js needs to be suffixed with the ".cjs" file extension (e.g. `require.resolve('linter-bundle/stylelint.cjs')`)
+
+### Changed
+
+- [files] Report unmatched `allowed` pattern
+- [markdownlint] Updated `markdownlint-cli` from `0.35.0` to `0.36.0`
+- [eslint] Disabled `considerComments` option of [`import/new-after-import`](https://github.com/import-js/eslint-plugin-import/blob/v2.28.1/docs/rules/newline-after-import.md) rule
+  as it conflicts with the [`import/order`](https://github.com/import-js/eslint-plugin-import/blob/v2.28.1/docs/rules/order.md) rule
+- [eslint/overrides-javascript] Disable [`import/dynamic-import-chunkname`](https://github.com/import-js/eslint-plugin-import/blob/v2.28.1/docs/rules/dynamic-import-chunkname.md) for JavaScript files
+
+[Show all code changes](https://github.com/jens-duttke/linter-bundle/compare/v4.0.3...v5.0.0)
 
 ## [4.0.3] - 2023-08-31
 

package/README.md

@@ -86,16 +86,16 @@ npm install linter-bundle --save-dev
 ```js
 module.exports = {
   extends: [
-    require.resolve('linter-bundle/eslint'),
-    // require.resolve('linter-bundle/eslint/overrides-gatsby'),
-    // require.resolve('linter-bundle/eslint/overrides-javascript'),
-    require.resolve('linter-bundle/eslint/overrides-javascript-lazy'),
-    // require.resolve('linter-bundle/eslint/overrides-jest'),
-    require.resolve('linter-bundle/eslint/overrides-jsdoc'),
-    // require.resolve('linter-bundle/eslint/overrides-react'),
-    // require.resolve('linter-bundle/eslint/overrides-storybook'),
-    // require.resolve('linter-bundle/eslint/overrides-type-declarations'),
-    // require.resolve('linter-bundle/eslint/overrides-worker')
+    require.resolve('linter-bundle/eslint.cjs'),
+    // require.resolve('linter-bundle/eslint/overrides-gatsby.cjs'),
+    // require.resolve('linter-bundle/eslint/overrides-javascript.cjs'),
+    require.resolve('linter-bundle/eslint/overrides-javascript-lazy.cjs'),
+    // require.resolve('linter-bundle/eslint/overrides-jest.cjs'),
+    require.resolve('linter-bundle/eslint/overrides-jsdoc.cjs'),
+    // require.resolve('linter-bundle/eslint/overrides-react.cjs'),
+    // require.resolve('linter-bundle/eslint/overrides-storybook.cjs'),
+    // require.resolve('linter-bundle/eslint/overrides-type-declarations.cjs'),
+    // require.resolve('linter-bundle/eslint/overrides-worker.cjs')
   ]
 };
 ```
@@ -104,22 +104,22 @@ module.exports = {
 
 Source | Description | Rules setup
 -|-|-
-`linter-bundle/eslint` | General rule setup. This is also the base for the following **overrides**. | [View](./eslint/index.js)
-`linter-bundle/eslint/overrides-gatsby` | Settings for Gatsby-based projects. | [View](./eslint/overrides-gatsby.js)
-`linter-bundle/eslint/overrides-javascript` |  Strict settings for JavaScript files, which enforces correct types everywhere. | [View](./eslint/overrides-javascript.js)
-`linter-bundle/eslint/overrides-javascript-lazy` | Can be used instead of `overrides-javascript`. It's less strict and allows the `any` type. | [View](./eslint/overrides-javascript-lazy.js)
-`linter-bundle/eslint/overrides-jest` | Settings for projects using Jest. | [View](./eslint/overrides-jest.js)
-`linter-bundle/eslint/overrides-jsdoc` | Settings for projects using JSDoc comments. | [View](./eslint/overrides-jsdoc.js)
-`linter-bundle/eslint/overrides-react` | Settings for projects using React comments. | [View](./eslint/overrides-react.js)
-`linter-bundle/eslint/overrides-storybook` | Settings for projects using Storybook comments. | [View](./eslint/overrides-storybook.js)
-`linter-bundle/eslint/overrides-type-declarations` | Settings for type declaration files (.d.ts). | [View](./eslint/overrides-type-declarations.js)
-`linter-bundle/eslint/overrides-worker` | Settings for projects using Web Workers. | [View](./eslint/overrides-worker.js)
+`linter-bundle/eslint.cjs` | General rule setup. This is also the base for the following **overrides**. | [View](./eslint/index.cjs)
+`linter-bundle/eslint/overrides-gatsby.cjs` | Settings for Gatsby-based projects. | [View](./eslint/overrides-gatsby.js)
+`linter-bundle/eslint/overrides-javascript.cjs` |  Strict settings for JavaScript files, which enforces correct types everywhere. | [View](./eslint/overrides-javascript.cjs)
+`linter-bundle/eslint/overrides-javascript-lazy.cjs` | Can be used instead of `overrides-javascript`. It's less strict and allows the `any` type. | [View](./eslint/overrides-javascript-lazy.cjs)
+`linter-bundle/eslint/overrides-jest.cjs` | Settings for projects using Jest. | [View](./eslint/overrides-jest.cjs)
+`linter-bundle/eslint/overrides-jsdoc.cjs` | Settings for projects using JSDoc comments. | [View](./eslint/overrides-jsdoc.cjs)
+`linter-bundle/eslint/overrides-react.cjs` | Settings for projects using React comments. | [View](./eslint/overrides-react.cjs)
+`linter-bundle/eslint/overrides-storybook.cjs` | Settings for projects using Storybook comments. | [View](./eslint/overrides-storybook.cjs)
+`linter-bundle/eslint/overrides-type-declarations.cjs` | Settings for type declaration files (.d.ts). | [View](./eslint/overrides-type-declarations.cjs)
+`linter-bundle/eslint/overrides-worker.cjs` | Settings for projects using Web Workers. | [View](./eslint/overrides-worker.cjs)
 
 #### stylelint.config.js
 
 ```js
 module.exports = {
-  extends: 'linter-bundle/stylelint'
+  extends: 'linter-bundle/stylelint.cjs'
 };
 
 ```
@@ -309,7 +309,7 @@ module.exports = {
      */
     overrides: {
       /**
-       * Rules that are applied to `linter-bundle/eslint`.
+       * Rules that are applied to `linter-bundle/eslint.cjs`.
        */
       general: {
         'no-restricted-globals': {
@@ -363,7 +363,7 @@ module.exports = {
       },
 
       /**
-       * Rules that are applied to `linter-bundle/eslint/overrides-react`.
+       * Rules that are applied to `linter-bundle/eslint/overrides-react.cjs`.
        */
       react: {
         'react/forbid-component-props': {
@@ -622,7 +622,7 @@ This can be done by adding these options to your `.vscode/settings.json`:
 {
   "eslint.nodePath": "./node_modules/linter-bundle/node_modules/eslint",
   "eslint.options": {
-    "overrideConfigFile": "./.eslintrc.js",
+    "overrideConfigFile": "./.eslintrc.js", // or "./.eslintrc.cjs" or "./eslintrc.json"
     "resolvePluginsRelativeTo": "./node_modules/linter-bundle",
     "rulePaths": ["./node_modules/linter-bundle/eslint/rules"],
     "reportUnusedDisableDirectives": "error",

package/eslint/{index.js → index.cjs}

@@ -8,8 +8,8 @@
 const fs = require('node:fs');
 const path = require('node:path');
 
-const config = require('../helper/config.js');
-const ensureType = require('../helper/ensure-type');
+const ensureType = require('../helper/ensure-type.cjs');
+const { linterBundleConfig } = require('../helper/linter-bundle-config.cjs');
 
 module.exports = {
 	ignorePatterns: [
@@ -283,16 +283,16 @@ module.exports = {
 						name: 'isNaN',
 						message: 'Use Number.isNaN() instead, and ensure that the input value is of type number. isNaN(undefined) !== Number.isNaN(undefined)'
 					},
-					...ensureType.array(config.ts?.overrides?.general?.['no-restricted-globals']?.additionalRestrictions)
+					...ensureType.array(linterBundleConfig.ts?.overrides?.general?.['no-restricted-globals']?.additionalRestrictions)
 				],
 				'no-restricted-imports': 'off', // Covered by @typescript-eslint/no-restricted-imports
 				'no-restricted-properties': [
 					'error',
-					...ensureType.array(config.ts?.overrides?.general?.['no-restricted-properties']?.additionalRestrictions)
+					...ensureType.array(linterBundleConfig.ts?.overrides?.general?.['no-restricted-properties']?.additionalRestrictions)
 				],
 				'no-restricted-syntax': [
 					'error',
-					...ensureType.array(config.ts?.overrides?.general?.['no-restricted-syntax']?.additionalRestrictions)
+					...ensureType.array(linterBundleConfig.ts?.overrides?.general?.['no-restricted-syntax']?.additionalRestrictions)
 				],
 				'no-return-assign': 'error',
 				'no-script-url': 'error',
@@ -821,7 +821,7 @@ module.exports = {
 				'import/max-dependencies': ['error', { max: 20, ignoreTypeImports: true }],
 				'import/named': 'error',
 				'import/namespace': ['error', { allowComputed: true }],
-				'import/newline-after-import': ['error', { considerComments: true }],
+				'import/newline-after-import': ['error', { considerComments: false }],
 				'import/no-absolute-path': 'error',
 				'import/no-amd': 'error',
 				'import/no-anonymous-default-export': 'error',
@@ -866,7 +866,7 @@ module.exports = {
 					'newlines-between': 'always',
 					'pathGroupsExcludedImportTypes': [],
 					'pathGroups': [
-						...ensureType.array(config.ts?.overrides?.general?.['import/order']?.additionalExternalPatterns).map(
+						...ensureType.array(linterBundleConfig.ts?.overrides?.general?.['import/order']?.additionalExternalPatterns).map(
 							/**
 							 * Creates an "external" group using the additional external pattern configuration.
 							 * @param {string} pattern - A given pattern

package/eslint/{overrides-javascript-lazy.js → overrides-javascript-lazy.cjs}

@@ -2,7 +2,7 @@
  * @file Extends `./overrides-javascript` but ignores unsafe types.
  */
 
-const overridesJavaScript = require('./overrides-javascript');
+const overridesJavaScript = require('./overrides-javascript.cjs');
 
 module.exports = {
 	...overridesJavaScript,

package/eslint/{overrides-javascript.js → overrides-javascript.cjs}

@@ -43,6 +43,7 @@ module.exports = {
 				'import/no-import-module-exports': 'error',
 				'import/no-internal-modules': 'off',
 				'import/no-nodejs-modules': 'off',
+				'import/dynamic-import-chunkname': 'off',
 
 				/**
 				 * eslint-plugin-n

package/eslint/{overrides-react.js → overrides-react.cjs}

@@ -2,8 +2,8 @@
  * @file Settings for React code in TypeScript (TSX) files.
  */
 
-const config = require('../helper/config.js');
-const ensureType = require('../helper/ensure-type');
+const ensureType = require('../helper/ensure-type.cjs');
+const { linterBundleConfig } = require('../helper/linter-bundle-config.cjs');
 
 module.exports = {
 	overrides: [
@@ -91,11 +91,11 @@ module.exports = {
 				'react/forbid-component-props': ['error', { forbid: [
 					{
 						propName: 'className',
-						allowedFor: ensureType.array(config.ts?.overrides?.react?.['react/forbid-component-props']?.allowClassNameFor)
+						allowedFor: ensureType.array(linterBundleConfig.ts?.overrides?.react?.['react/forbid-component-props']?.allowClassNameFor)
 					},
 					{
 						propName: 'style',
-						allowedFor: ensureType.array(config.ts?.overrides?.react?.['react/forbid-component-props']?.allowStyleFor)
+						allowedFor: ensureType.array(linterBundleConfig.ts?.overrides?.react?.['react/forbid-component-props']?.allowStyleFor)
 					}
 				] }],
 				'react/forbid-dom-props': 'error',

package/eslint/rules/no-unnecessary-typeof.js

@@ -6,7 +6,6 @@
 
 const ts = require('typescript');
 
-// @ts-expect-error -- TypeScript is not able to resolve the folder since @typescript-eslint v6.0.0
 const { ESLintUtils } = require('@typescript-eslint/utils');
 
 /**
@@ -22,8 +21,20 @@ module.exports = {
 			text: 'Unnecessary `typeof`, because the only possible type of {{ variableName }} is `{{ typeName }}`.'
 		}
 	},
+	/**
+	 * Create a new rule.
+	 *
+	 * @param {Readonly<import('@typescript-eslint/utils/ts-eslint').RuleContext<'text', []>>} context - RuleContext of @typescript-eslint instead of ESlint
+	 * @returns {import('@typescript-eslint/utils/ts-eslint').RuleListener} RuleListener of @typescript-eslint, instead of ESlint
+	 */
 	create (context) {
 		return {
+			/**
+			 * Rule function to handle unary expressions.
+			 *
+			 * @param {import('@typescript-eslint/typescript-estree').TSESTree.UnaryExpression} node - UnaryExpression of @typescript-eslint instead of ESlint
+			 * @returns {import('@typescript-eslint/utils/ts-eslint').RuleFunction<import('@typescript-eslint/typescript-estree').TSESTree.UnaryExpression> | void} RuleFunction of @typescript-eslint instead of ESlint
+			 */
 			UnaryExpression (node) {
 				if (node.operator !== 'typeof') {
 					return;

package/eslint/rules/package.json

@@ -0,0 +1,8 @@
+{
+	"type": "commonjs",
+	"peerDependencies": {
+		"@typescript-eslint/utils": "*",
+		"micromatch": "*",
+		"typescript": "*"
+	}
+}

package/eslint/rules/restricted-filenames.js

@@ -6,7 +6,8 @@ const path = require('node:path');
 
 const micromatch = require('micromatch');
 
-const config = require('../../helper/config.js');
+// eslint-disable-next-line n/no-process-env -- Only merge the linter-bundle config, if the linting is not started by the linter-bundle CLI tool (e.g. if ESlint is running separately in VSCode), to get warnings shown there too
+const linterBundleConfig = (!process.env['LINTER_BUNDLE'] ? require('../../helper/linter-bundle-config.cjs').linterBundleConfig : undefined);
 
 /**
  * @type {import('eslint').Rule.RuleModule}
@@ -50,10 +51,9 @@ module.exports = {
 		}
 	},
 	create: (context) => {
-		const filePath = context.getFilename();
+		const filePath = context.filename;
 		/** @type {{ basePath: string, allowed?: string[]; disallowed?: string[]; }[]} */
-		// eslint-disable-next-line n/no-process-env -- Only merge the linter-bundle config, if the linting is not started by the linter-bundle CLI tool (e.g. if ESlint is running separately in VSCode), to get warnings shown there too
-		const options = (!process.env['LINTER_BUNDLE'] && config.files?.restrictions ? [...config.files.restrictions, ...context.options] : context.options);
+		const options = linterBundleConfig?.files?.restrictions ? [...linterBundleConfig.files.restrictions, ...context.options] : context.options;
 
 		for (const { basePath, allowed, disallowed } of options) {
 			const normalizedName = path.relative(path.join(process.cwd(), basePath), filePath);

package/eslint/rules/restricted-filenames.md

@@ -64,7 +64,7 @@ If both are set, `disallowed` wins over `allowed` and all unspecified files are
 
 Instead of defining the same complex patterns over and over again, e.g. for casing, you can write them into a variable and use them within the pattern, for example by using template strings.
 
-Example of `.eslintrc.js`:
+Example of `.eslintrc.cjs`:
 
 ```js
 const snippets = {

package/eslint.cjs

@@ -0,0 +1,5 @@
+/**
+ * @file Wrapper which allows to extend "linter-bundle/eslint.cjs" instead of "linter-bundle/eslint/index.cjs"
+ */
+
+module.exports = require('./eslint/index.cjs');

package/files/index.js

@@ -2,17 +2,18 @@
  * @file Ensures that only files which match given glob patterns are part of the project.
  */
 
-const fs = require('node:fs');
-const path = require('node:path');
+import * as fs from 'node:fs';
+import * as path from 'node:path';
 
-const micromatch = require('micromatch');
+import micromatch from 'micromatch';
 
-const config = require('../helper/config.js');
+import { linterBundleConfig } from '../helper/linter-bundle-config.js';
 
-const restrictions = config.files?.restrictions;
+const restrictions = linterBundleConfig.files?.restrictions;
+const matcherOptions = { dot: true };
 
 if (Array.isArray(restrictions)) {
-	let noOfErrors = 0;
+	let noOfDisallowedFiles = 0;
 
 	const argFiles = process.argv.splice(2).map((filePath) => path.join(process.cwd(), filePath));
 
@@ -25,7 +26,24 @@ if (Array.isArray(restrictions)) {
 	const report = (filePath) => {
 		process.stderr.write(`Disallowed filename "${filePath}"\n`);
 
-		noOfErrors++;
+		noOfDisallowedFiles++;
+	};
+
+	/**
+	 * Reports the error to the `console` and increase the error counter.
+	 *
+	 * @param {[string, (str: string) => boolean][]} matchers - Array of micromatch matchers
+	 * @param {string} filePath - Path to the file to check
+	 * @returns {string | undefined} On match returns the matching pattern, otherwise `undefined`
+	 */
+	const isMatch = (matchers, filePath) => {
+		for (const [pattern, matcher] of matchers) {
+			if (matcher(filePath)) {
+				return pattern;
+			}
+		}
+
+		return;
 	};
 
 	for (const { basePath, allowed, disallowed } of restrictions) {
@@ -33,38 +51,50 @@ if (Array.isArray(restrictions)) {
 
 		const files = (argFiles.length > 0 ? argFiles.filter((filePath) => !path.relative(absoluteBasePath, filePath).startsWith('..')) : getFiles(absoluteBasePath));
 
+		const allowedMatchers = allowed?.map((pattern) => /** @type {[string, (str: string) => boolean]} */([pattern, micromatch.matcher(pattern, matcherOptions)]));
+		const disallowedMatchers = disallowed?.map((pattern) => /** @type {[string, (str: string) => boolean]} */([pattern, micromatch.matcher(pattern, matcherOptions)]));
+
+		const unmatchedAllowedPatterns = new Set(allowed);
+
 		for (const filePath of files) {
 			const normalizedFilePath = path.relative(absoluteBasePath, filePath);
 
-			if (allowed && !disallowed) {
-				if (!micromatch.isMatch(normalizedFilePath, allowed, { dot: true })) {
-					report(normalizedFilePath);
+			if (allowedMatchers && !disallowedMatchers) {
+				const pattern = isMatch(allowedMatchers, normalizedFilePath);
 
-					continue;
+				if (pattern) {
+					unmatchedAllowedPatterns.delete(pattern);
 				}
-			}
-			else if (!allowed && disallowed) {
-				if (micromatch.isMatch(normalizedFilePath, disallowed, { dot: true })) {
+				else {
 					report(normalizedFilePath);
-
-					continue;
 				}
 			}
-			else if (allowed && disallowed) {
-				if (
-					micromatch.isMatch(normalizedFilePath, disallowed, { dot: true }) ||
-					!micromatch.isMatch(normalizedFilePath, allowed, { dot: true })
-				) {
+			else if (!allowedMatchers && disallowedMatchers) {
+				if (isMatch(disallowedMatchers, normalizedFilePath)) {
 					report(normalizedFilePath);
+				}
+			}
+			else if (allowedMatchers && disallowedMatchers) {
+				const pattern = isMatch(allowedMatchers, normalizedFilePath);
 
-					continue;
+				if (pattern) {
+					unmatchedAllowedPatterns.delete(pattern);
 				}
+				else if (isMatch(disallowedMatchers, normalizedFilePath)) {
+					report(normalizedFilePath);
+				}
+			}
+		}
+
+		if (unmatchedAllowedPatterns.size > 0) {
+			for (const [pattern] of unmatchedAllowedPatterns.entries()) {
+				process.stderr.write(`Unmatched "allowed" pattern: "${pattern}"\n`);
 			}
 		}
 	}
 
-	if (noOfErrors > 0) {
-		process.stderr.write(`\nFound ${noOfErrors} disallowed file${(noOfErrors !== 0 ? 's' : '')}\n`);
+	if (noOfDisallowedFiles > 0) {
+		process.stderr.write(`\nFound ${noOfDisallowedFiles} disallowed file${(noOfDisallowedFiles !== 0 ? 's' : '')}\n`);
 
 		process.exitCode = -1;
 	}

package/helper/{ensure-type.js → ensure-type.cjs}

@@ -1,5 +1,7 @@
 /**
  * @file Ensures that a value is of a specific type, if not it converts the value into that type.
+ *
+ * This module has to be CommonJS as it is only used by `eslint` which does not support ESModules.
  */
 
 /**

package/helper/get-git-files.js

@@ -2,9 +2,9 @@
  * @file Handling of changed files from Git.
  */
 
-const { runProcess } = require('./run-process.js');
+import { runProcess } from './run-process.js';
 
-/** @typedef {import('./run-process').ProcessResult} ProcessResult */
+/** @typedef {import('./run-process.js').ProcessResult} ProcessResult */
 
 /** @type {{ diff: Promise<ProcessResult>; modified: Promise<ProcessResult>; deleted: Promise<ProcessResult>; } | undefined} */
 let gitFilesProcessPromise;
@@ -17,7 +17,7 @@ let gitFiles;
  * @public
  * @returns {Promise<string[]>} The list of changed files.
  */
-async function getGitFiles () {
+export async function getGitFiles () {
 	if (!gitFilesProcessPromise) {
 		gitFilesProcessPromise = {
 			// Returns changed files, also stashed and committed
@@ -46,7 +46,3 @@ async function getGitFiles () {
 
 	return gitFiles;
 }
-
-module.exports = {
-	getGitFiles
-};

package/helper/get-outdated-dependencies.js

@@ -0,0 +1,48 @@
+/**
+ * @file Ensures that the installed dependencies of the project matches to the versions used by the linter-bundle.
+ *
+ * @see https://docs.npmjs.com/cli/v8/configuring-npm/package-json#overrides
+ * @see https://classic.yarnpkg.com/en/docs/selective-version-resolutions/
+ */
+
+import * as fs from 'node:fs/promises';
+import * as path from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const dirname = path.dirname(fileURLToPath(import.meta.url));
+
+/** @typedef {{ name: string; configuredVersion: string; expectedVersion: string; }} Dependency */
+
+/**
+ * Detects if installed versions of dependencies don't match to the required dependencies.
+ *
+ * @public
+ * @returns {Promise<Dependency[]>} An array of missing overrides (=wrong versions).
+ */
+export async function getOutdatedDependencies () {
+	const linterBundleDependencies = JSON.parse(await fs.readFile(path.resolve(dirname, '../package.json'), 'utf8')).dependencies;
+
+	const outdatedDependencies = await Promise.all(Object.entries(linterBundleDependencies).map(async ([name, expectedVersion]) => {
+		let dependencyPackageJson;
+
+		try {
+			dependencyPackageJson = JSON.parse(await fs.readFile(path.join(process.cwd(), 'node_modules', name, 'package.json'), 'utf8'));
+		}
+		catch {
+			// If the file does not exist, we ignore it, because in this case it's most likely a linter-bundle-only dependency.
+			return;
+		}
+
+		if (dependencyPackageJson.version !== expectedVersion) {
+			return {
+				name,
+				configuredVersion: dependencyPackageJson.version,
+				expectedVersion
+			};
+		}
+
+		return;
+	}));
+
+	return /** @type {Dependency[]} */(outdatedDependencies.filter((dependency) => dependency !== undefined));
+}

package/helper/{validate-package-overrides.js → get-outdated-overrides.js}

@@ -5,8 +5,11 @@
  * @see https://classic.yarnpkg.com/en/docs/selective-version-resolutions/
  */
 
-const fs = require('node:fs');
-const path = require('node:path');
+import * as fs from 'node:fs/promises';
+import * as path from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const dirname = path.dirname(fileURLToPath(import.meta.url));
 
 /** @typedef {{ name: string; configuredVersion: string; expectedVersion: string; }} Dependency */
 
@@ -14,11 +17,11 @@ const path = require('node:path');
  * Detects outdated "overrides"/"resolutions" dependencies.
  *
  * @public
- * @returns {{ overrides: Dependency[]; resolutions: Dependency[]; }} Either the input array, or an empty array, if the input array is not an array.
+ * @returns {Promise<{ overrides: Dependency[]; resolutions: Dependency[]; }>} Either the input array, or an empty array, if the input array is not an array.
  */
-function validatePackageOverrides () {
-	const linterBundleDependencies = JSON.parse(fs.readFileSync(path.resolve(__dirname, '../package.json'), 'utf8')).dependencies;
-	const projectPackageJson = JSON.parse(fs.readFileSync(path.join(process.cwd(), 'package.json'), 'utf8'));
+export async function getOutdatedOverrides () {
+	const linterBundleDependencies = JSON.parse(await fs.readFile(path.resolve(dirname, '../package.json'), 'utf8')).dependencies;
+	const projectPackageJson = JSON.parse(await fs.readFile(path.join(process.cwd(), 'package.json'), 'utf8'));
 
 	const overrides = [];
 	const resolutions = [];
@@ -57,7 +60,3 @@ function validatePackageOverrides () {
 
 	return { overrides, resolutions };
 }
-
-module.exports = {
-	validatePackageOverrides
-};

package/helper/get-stylelint-path.js

@@ -2,31 +2,34 @@
  * @file Returns the path to the Stylelint CLI script.
  */
 
-const fs = require('node:fs');
-const path = require('node:path');
+import * as fs from 'node:fs/promises';
+import { createRequire } from 'node:module';
+import * as path from 'node:path';
+
+const require = createRequire(import.meta.url);
 
 /**
  * Returns if the project is using npm or yarn.
  *
  * @public
- * @returns {string | null} Return the path to the Stylelint CLI script, or `null` if it can't be found.
+ * @returns {Promise<string | null>} Return the path to the Stylelint CLI script, or `null` if it can't be found.
  */
-function getStylelintPath () {
+export async function getStylelintPath () {
 	const stylelintLibPath = path.dirname(require.resolve('stylelint'));
 
-	for (const stylelintBinPath of [
+	for await (const stylelintBinPath of [
 		path.join(stylelintLibPath, '../bin/stylelint.mjs'),
 		path.join(stylelintLibPath, '../bin/stylelint.js')
 	]) {
-		if (fs.existsSync(stylelintBinPath)) {
-			return stylelintBinPath;
+		try {
+			const stat = await fs.stat(stylelintBinPath);
+
+			if (stat.isFile()) {
+				return stylelintBinPath;
+			}
 		}
+		catch { /* Do nothing */ }
 	}
 
 	return null;
 }
-
-module.exports = {
-	getStylelintPath
-};
-