linter-bundle 6.2.2 → 7.0.0

package/eslint/rules/{no-unnecessary-typeof.js → no-unnecessary-typeof.mjs}

@@ -2,31 +2,29 @@
  * @file ESLint rule which ensures that a `typeof` operant has more than one type in TypeScript, to prevent unnecessary checks of types at runtime.
  */
 
-/* eslint-disable unicorn/prefer-module -- For ESLint, we still need to rely on CommonJS modules */
-
 /** @typedef {ts.Type & { intrinsicName?: string; types?: ts.Type[]; objectFlags?: ts.ObjectFlags; }} Type */
 
-const ts = require('typescript');
+import * as ts from 'typescript';
 
-const { ESLintUtils } = require('@typescript-eslint/utils');
+import { ESLintUtils } from '@typescript-eslint/utils';
 
-/**
- * @type {import('eslint').Rule.RuleModule}
- */
-module.exports = {
+export default {
 	meta: {
+		type: 'problem',
 		docs: {
 			description: 'If a `typeof` operant has only one type in TypeScript, it\'s unnecessary to check it\'s type at runtime.',
-			recommended: true
+			recommended: true,
+			requiresTypeChecking: true
 		},
 		messages: {
 			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
+	 * @param {import('@typescript-eslint/utils/ts-eslint').RuleContext<any, any>} 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) {
@@ -136,7 +134,7 @@ function getTypeString (checker, type) {
  * @returns {boolean} Returns `true` if the type is either `any` or `unknown`, or an object which is based on `unknown`
  */
 function isAnyOrUnknown (type) {
-	// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- `symbol` on Object is `undefined` for `Omit<unknown, 'undefined'>`
+	// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- @todo I've seen `symbol` to be undefined. Is that an issue in the TypeScript type definition?
 	return (type.flags === ts.TypeFlags.Any || type.flags === ts.TypeFlags.Unknown || (type.flags === ts.TypeFlags.Object && type.symbol === undefined));
 }
 

package/eslint/rules/restricted-filenames.md

@@ -7,7 +7,7 @@ In projects in which several developers or even teams work together, it is impor
 Example configuration for this rule:
 
 ```js
-'restricted-filenames': ['error', {
+'linter-bundle/restricted-filenames': ['error', {
   basePath: './src',
   allowed: [
     'components/**/index.tsx',
@@ -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.cjs`:
+Example of `eslint.config.mjs`:
 
 ```js
 const snippets = {
@@ -77,9 +77,9 @@ const snippets = {
   pascalCase: '[A-Z]*([a-zA-Z0-9])'
 };
 
-module.exports = {
+export default {
   rules: {
-    'restricted-filenames': ['error', {
+    'linter-bundle/restricted-filenames': ['error', {
       basePath: './src',
       allowed: [
         `components/${snippets.pascalCase}/index.tsx`,

package/eslint/rules/{restricted-filenames.js → restricted-filenames.mjs}

@@ -2,19 +2,20 @@
  * @file ESLint rule which ensures that only files which match given glob patterns are part of your project.
  */
 
-/* eslint-disable unicorn/prefer-module -- For ESLint, we still need to rely on CommonJS modules */
+import path from 'node:path';
 
-const path = require('node:path');
+import micromatch from 'micromatch';
 
-const micromatch = require('micromatch');
+// eslint-disable-next-line n/no-process-env -- If the ESLint sub-process is running from within the linter-bundle, we make use of its configuration.
+const isInLinterBundle = !process.env['LINTER_BUNDLE'];
 
-// 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);
+// eslint-disable-next-line n/no-unpublished-import -- @todo Is that a false-positive?
+const { linterBundleConfig } = (isInLinterBundle ? await import('../../helper/linter-bundle-config.js') : {});
 
 /**
  * @type {import('eslint').Rule.RuleModule}
  */
-module.exports = {
+export default {
 	meta: {
 		docs: {
 			description: 'Restrict file and path names with given glob patterns.',

package/eslint/storybook.mjs

@@ -0,0 +1,42 @@
+/**
+ * @file Settings for Storybook configuration and stories.
+ */
+
+export default [
+	{
+		files: ['**/*.stories.[jt]s?(x)'],
+		rules: {
+			/**
+			 * eslint-plugin-import
+			 *
+			 * @see https://github.com/import-js/eslint-plugin-import
+			 */
+			'import/no-default-export': 'off'
+		}
+	},
+	{
+		files: ['.storybook/main.ts'],
+		rules: {
+			/**
+			 * eslint-plugin-import
+			 *
+			 * @see https://github.com/import-js/eslint-plugin-import
+			 */
+			'import/no-nodejs-modules': 'off'
+		}
+	},
+	{
+		files: ['.storybook/preview.{js,cjs,mjs,jsx,ts,cts,mts,tsx}'],
+		rules: {
+			/**
+			 * eslint
+			 *
+			 * @see https://eslint.org/docs/rules/
+			 */
+			'no-underscore-dangle': ['error', {
+				allow: ['__BASE_PATH__', '___loader', '___navigate'],
+				allowAfterThis: true
+			}]
+		}
+	}
+];

package/eslint/type-declarations.mjs

@@ -0,0 +1,49 @@
+/**
+ * @file Settings for TypeScript type definition files.
+ */
+
+export default [
+	{
+		files: ['**/*.d.ts'],
+		rules: {
+			/**
+			 * eslint
+			 *
+			 * @see https://eslint.org/docs/rules/
+			 */
+			'max-classes-per-file': 'off',
+			'one-var': 'off',
+
+			/**
+			 * eslint-plugin-import
+			 *
+			 * @see https://github.com/import-js/eslint-plugin-import
+			 */
+			'import/no-default-export': 'off',
+			'import/no-unused-modules': 'off',
+
+			/**
+			 * eslint-plugin-unicorn
+			 *
+			 * @see https://github.com/sindresorhus/eslint-plugin-unicorn
+			 */
+			'unicorn/filename-case': ['off', { // Disabled in favour of the linter-bundle `files` task
+				cases: {
+					kebabCase: true,
+					pascalCase: true
+				}
+			}]
+		}
+	},
+	{
+		files: ['**/*.scss.d.ts'],
+		rules: {
+			/**
+			 * eslint
+			 *
+			 * @see https://eslint.org/docs/rules/
+			 */
+			'linebreak-style': 'off' // Ignore for automatically generated .scss.d.ts files, since that does not affect the project.
+		}
+	}
+];

package/eslint/{overrides-worker.cjs → worker.mjs}

@@ -8,18 +8,16 @@
  * export default undefined as unknown as WebpackWorker;
  */
 
-module.exports = {
-	overrides: [
-		{
-			files: ['*.worker.ts'],
-			rules: {
-				/**
-				 * eslint-plugin-import
-				 *
-				 * @see https://github.com/import-js/eslint-plugin-import
-				 */
-				'import/no-default-export': 'off'
-			}
+export default [
+	{
+		files: ['**/*.worker.ts'],
+		rules: {
+			/**
+			 * eslint-plugin-import
+			 *
+			 * @see https://github.com/import-js/eslint-plugin-import
+			 */
+			'import/no-default-export': 'off'
 		}
-	]
-};
+	}
+];

package/eslint.mjs

@@ -0,0 +1,5 @@
+/**
+ * @file Wrapper which allows to extend "linter-bundle/eslint.mjs" instead of "linter-bundle/eslint/index.mjs".
+ */
+
+export { default } from './eslint/index.mjs';

package/files/index.js

@@ -2,8 +2,8 @@
  * @file Ensures that only files which match given glob patterns are part of the project.
  */
 
-import * as fs from 'node:fs';
-import * as path from 'node:path';
+import fs from 'node:fs';
+import path from 'node:path';
 
 import micromatch from 'micromatch';
 
@@ -43,7 +43,7 @@ if (Array.isArray(restrictions)) {
 			}
 		}
 
-		return;
+		return undefined;
 	};
 
 	for (const { basePath, allowed, disallowed } of restrictions) {

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

@@ -12,11 +12,7 @@
  * @param {T} value - The value which should be checked
  * @returns {T extends Array<any> ? T : []} Either the input array, or an empty array, if the input array is not an array
  */
-function array (value) {
+export function array (value) {
 	// @ts-expect-error -- Right now the type definition of `Array.isArray()` is incorrect since it uses `arg is any[]` instead of the correct type of `arg`.
 	return (Array.isArray(value) ? value : []);
 }
-
-module.exports = {
-	array
-};

package/helper/get-outdated-dependencies.js

@@ -5,8 +5,8 @@
  * @see https://classic.yarnpkg.com/en/docs/selective-version-resolutions/
  */
 
-import * as fs from 'node:fs/promises';
-import * as path from 'node:path';
+import fs from 'node:fs/promises';
+import path from 'node:path';
 import { fileURLToPath } from 'node:url';
 
 const dirname = path.dirname(fileURLToPath(import.meta.url));
@@ -30,7 +30,7 @@ export async function getOutdatedDependencies () {
 		}
 		catch {
 			// If the file does not exist, we ignore it, because in this case it's most likely a linter-bundle-only dependency.
-			return;
+			return undefined;
 		}
 
 		if (dependencyPackageJson.version !== expectedVersion) {
@@ -41,7 +41,7 @@ export async function getOutdatedDependencies () {
 			};
 		}
 
-		return;
+		return undefined;
 	}));
 
 	return /** @type {Dependency[]} */(outdatedDependencies.filter((dependency) => dependency !== undefined));

package/helper/get-outdated-overrides.js

@@ -5,8 +5,8 @@
  * @see https://classic.yarnpkg.com/en/docs/selective-version-resolutions/
  */
 
-import * as fs from 'node:fs/promises';
-import * as path from 'node:path';
+import fs from 'node:fs/promises';
+import path from 'node:path';
 import { fileURLToPath } from 'node:url';
 
 const dirname = path.dirname(fileURLToPath(import.meta.url));

package/helper/get-stylelint-path.js

@@ -2,9 +2,9 @@
  * @file Returns the path to the Stylelint CLI script.
  */
 
-import * as fs from 'node:fs/promises';
+import fs from 'node:fs/promises';
 import { createRequire } from 'node:module';
-import * as path from 'node:path';
+import path from 'node:path';
 
 const require = createRequire(import.meta.url);
 
@@ -17,11 +17,12 @@ const require = createRequire(import.meta.url);
 export async function getStylelintPath () {
 	const stylelintLibPath = path.dirname(require.resolve('stylelint'));
 
-	for await (const stylelintBinPath of [
+	for (const stylelintBinPath of [
 		path.join(stylelintLibPath, '../bin/stylelint.mjs'),
 		path.join(stylelintLibPath, '../bin/stylelint.js')
 	]) {
 		try {
+			// eslint-disable-next-line no-await-in-loop -- As we return from the method on the first file which exist, we cannot run the promises in parallel.
 			const stat = await fs.stat(stylelintBinPath);
 
 			if (stat.isFile()) {

package/helper/is-npm-or-yarn.js

@@ -2,8 +2,8 @@
  * @file Check if the project is using npm or yarn by checking the existence of a `package-lock.json` or a `yarn.lock`.
  */
 
-import * as fs from 'node:fs/promises';
-import * as path from 'node:path';
+import fs from 'node:fs/promises';
+import path from 'node:path';
 
 /**
  * Returns if the project is using npm or yarn.

package/helper/linter-bundle-config.d.ts

@@ -2,6 +2,29 @@
  * @file Type definition of `.linter-bundle.js` configuration.
  */
 
+interface NamingConventionOption {
+	// format options
+	format: ('camelCase' | 'strictCamelCase' | 'PascalCase' | 'StrictPascalCase' | 'snake_case' | 'UPPER_CASE')[] | null;
+	custom?: {
+		regex: string;
+		match: boolean;
+	};
+	leadingUnderscore?: 'forbid' | 'require' | 'requireDouble' | 'allow' | 'allowDouble' | 'allowSingleOrDouble';
+	trailingUnderscore?: 'forbid' | 'require' | 'requireDouble' | 'allow' | 'allowDouble' | 'allowSingleOrDouble';
+	prefix?: string[];
+	suffix?: string[];
+
+	// selector options
+	selector: string | string[];
+	filter?: string | {
+		regex: string;
+		match: boolean;
+	};
+	// the allowed values for these are dependent on the selector - see below
+	modifiers?: string[];
+	types?: string[];
+}
+
 export interface LinterBundleConfig {
 	verbose?: boolean;
 	timing?: boolean;
@@ -27,6 +50,7 @@ export interface LinterBundleConfig {
 				'no-restricted-properties'?: { additionalRestrictions?: { object: string; property: string; message: string; }[]; };
 				'no-restricted-syntax'?: { additionalRestrictions?: { selector: string; message: string; }[]; };
 				'import/order'?: { additionalExternalPatterns?: string[]; };
+				'@typescript-eslint/naming-convention'?: { additionalOptions?: NamingConventionOption[]; };
 			};
 			react?: {
 				'react/forbid-component-props'?: { allowClassNameFor?: string[]; allowStyleFor?: string[]; };

package/helper/linter-bundle-config.js

@@ -2,8 +2,8 @@
  * @file Returns the `.linter-bundle.js` configuration result.
  */
 
-import * as fs from 'node:fs/promises';
-import * as path from 'node:path';
+import fs from 'node:fs/promises';
+import path from 'node:path';
 
 export const linterBundleConfig = (
 	await loadConfig('.linter-bundle.json') ??
@@ -23,7 +23,7 @@ async function loadConfig (fileName) {
 	const filePath = path.join(process.cwd(), fileName);
 
 	if (!await fs.access(filePath, fs.constants.F_OK).then(() => true).catch(() => false)) {
-		return;
+		return undefined;
 	}
 
 	try {
@@ -33,9 +33,11 @@ async function loadConfig (fileName) {
 			return JSON.parse(content);
 		}
 
-		const fileUri = path.join('file://', filePath);
+		const fileUrl = new URL('file:');
 
-		const config = await import(fileUri);
+		fileUrl.pathname = filePath;
+
+		const config = await import(fileUrl.toString());
 
 		if ('default' in config) {
 			return config.default;
@@ -44,15 +46,8 @@ async function loadConfig (fileName) {
 		return config;
 	}
 	catch (error) {
-		process.stderr.write(`Error reading ${filePath}\n`);
-
-		if (error instanceof Error) {
-			process.stderr.write(`${error.stack}\n`);
-		}
-		else {
-			process.stderr.write(`${error}\n`);
-		}
+		process.stderr.write(`Error reading ${filePath}\n${error}\n`);
 	}
 
-	return;
+	return undefined;
 }

package/helper/run-process.js

@@ -28,7 +28,7 @@ export async function runProcess (command, options) {
 		const lintingProcess = childProcess.exec(command, {
 			...options,
 			env: {
-				// eslint-disable-next-line n/no-process-env -- We need to access `process.env`, because this is the default value if `env` is not set.
+				// eslint-disable-next-line n/no-process-env -- Pass all environment variables to the child process
 				...process.env,
 				...options?.env,
 				LINTER_BUNDLE: '1'

package/lint.js

@@ -5,8 +5,8 @@
  */
 
 import { createRequire } from 'node:module';
-import * as path from 'node:path';
-import * as tty from 'node:tty';
+import path from 'node:path';
+import tty from 'node:tty';
 import { fileURLToPath } from 'node:url';
 
 import micromatch from 'micromatch';
@@ -22,12 +22,14 @@ import { runProcess } from './helper/run-process.js';
 const require = createRequire(import.meta.url);
 const dirname = path.dirname(fileURLToPath(import.meta.url));
 
-/** @typedef {'files' | 'tsc' | 'ts' | 'sass' | 'md' | 'audit'} TaskNames */
-/** @typedef {Partial<Record<string, (string | boolean)[]>>} TaskConfig */
-/** @typedef {import('./helper/run-process.js').ProcessResult} ProcessResult */
-/** @typedef {{ taskName: TaskNames; taskConfig: TaskConfig; }} TaskNameAndConfig */
-/** @typedef {TaskNameAndConfig & { command: string; options?: import('child_process').ExecOptions; }} TaskSetup */
-/** @typedef {{ jobTitle: string; taskSetup: TaskSetup; job: Promise<ProcessResult>; }} Job */
+/**
+ * @typedef {'files' | 'tsc' | 'ts' | 'sass' | 'md' | 'audit'} TaskNames
+ * @typedef {Partial<Record<string, (string | boolean)[]>>} TaskConfig
+ * @typedef {import('./helper/run-process.js').ProcessResult} ProcessResult
+ * @typedef {{ taskName: TaskNames; taskConfig: TaskConfig; }} TaskNameAndConfig
+ * @typedef {TaskNameAndConfig & { command: string; options?: import('child_process').ExecOptions; }} TaskSetup
+ * @typedef {{ jobTitle: string; taskSetup: TaskSetup; job: Promise<ProcessResult>; }} Job
+ */
 
 const isTerminal = tty.isatty(1);
 
@@ -104,7 +106,7 @@ await (async () => {
 			showTimingForAllJobs = false;
 		}
 
-		if (process.exitCode === undefined || code > process.exitCode) {
+		if (process.exitCode === undefined || code > Number.parseInt(String(process.exitCode), 10)) {
 			process.exitCode = code;
 		}
 	}
@@ -199,14 +201,12 @@ async function runESLintTask (taskName, taskConfig) {
 			`"${path.join(path.dirname(require.resolve('eslint')), '../bin/eslint.js')}"`,
 			includes,
 			newTaskConfig.exclude?.map((exclude) => `--ignore-pattern ${exclude}`).join(' '),
-			`--rulesdir "${path.resolve(dirname, './eslint/rules/')}"`,
-			'--format unix',
-			`--resolve-plugins-relative-to "${dirname}"`
+			'--format unix'
 		].filter((argument) => Boolean(argument)).join(' '),
 		taskConfig: newTaskConfig,
 		options: {
 			env: {
-				TIMING: '10', // Show timing information about the 10 slowest rules
+				TIMING: (getConfigValue(taskName, taskConfig, 'timing')?.[0] ? '10' : undefined), // Show timing information about the 10 slowest rules
 				TSCONFIG: (typeof newTaskConfig.tsconfig?.[0] === 'string' ? newTaskConfig.tsconfig[0] : undefined)
 			}
 		}
@@ -253,7 +253,12 @@ async function runStylelintTask (taskName, taskConfig) {
 			(newTaskConfig.verbose?.[0] ? '--verbose' : undefined),
 			'--formatter unix'
 
-		].filter((argument) => Boolean(argument)).join(' ')
+		].filter((argument) => Boolean(argument)).join(' '),
+		options: {
+			env: {
+				TIMING: (getConfigValue(taskName, taskConfig, 'timing')?.[0] ? '10' : undefined) // Show timing information about the 10 slowest rules
+			}
+		}
 	});
 }
 
@@ -312,7 +317,7 @@ async function runAuditTask (taskName, taskConfig) {
 					'npx',
 					'--yes',
 					'--',
-					'better-npm-audit@3.7.3',
+					'better-npm-audit@3.11.0',
 					'audit',
 					`-l ${newTaskConfig.minSeverity?.[0] ?? 'moderate'}`,
 					'-p',
@@ -596,5 +601,5 @@ function getConfigValue (taskName, taskConfig, optionName) {
 		}
 	}
 
-	return;
+	return undefined;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "linter-bundle",
-	"version": "6.2.2",
+	"version": "7.0.0",
 	"type": "module",
 	"description": "Ready-to use bundle of linting tools, containing configurations for ESLint, stylelint and markdownlint.",
 	"keywords": [
@@ -23,7 +23,7 @@
 		"lint": "lint.js"
 	},
 	"engines": {
-		"node": ">=18.12.0"
+		"node": "^20.9.0 || >=21.1.0"
 	},
 	"repository": {
 		"type": "git",
@@ -37,46 +37,48 @@
 		"preversion": "npm run check-outdated && npm run lint",
 		"postversion": "git push && git push --tags && npm publish",
 		"check-outdated": "npx --yes -- check-outdated --ignore-pre-releases",
-		"_stylelint-find-rules": "stylelint-find-new-rules ./stylelint/index.cjs",
+		"_stylelint-find-rules": "stylelint-find-new-rules ./stylelint/index.mjs",
 		"_test-stylelint": "node ./test-stylelint.js"
 	},
 	"dependencies": {
-		"@typescript-eslint/eslint-plugin": "6.19.1",
-		"@typescript-eslint/parser": "6.19.1",
-		"@typescript-eslint/utils": "6.19.1",
-		"eslint": "8.56.0",
-		"eslint-import-resolver-typescript": "3.6.1",
-		"eslint-import-resolver-webpack": "0.13.8",
+		"@stylistic/eslint-plugin": "4.2.0",
+		"@stylistic/eslint-plugin-jsx": "4.2.0",
+		"eslint": "9.22.0",
+		"eslint-formatter-unix": "8.40.0",
+		"eslint-import-resolver-typescript": "3.8.4",
+		"eslint-import-resolver-webpack": "0.13.10",
 		"eslint-plugin-eslint-comments": "3.2.0",
-		"eslint-plugin-functional": "6.0.0",
-		"eslint-plugin-import": "2.29.1",
-		"eslint-plugin-jest": "27.6.3",
-		"eslint-plugin-jsdoc": "48.0.3",
-		"eslint-plugin-jsx-a11y": "6.8.0",
-		"eslint-plugin-n": "16.6.2",
-		"eslint-plugin-promise": "6.1.1",
-		"eslint-plugin-react": "7.33.2",
-		"eslint-plugin-react-hooks": "4.6.0",
-		"eslint-plugin-unicorn": "50.0.1",
-		"markdownlint-cli": "0.38.0",
-		"micromatch": "4.0.5",
+		"eslint-plugin-functional": "9.0.1",
+		"eslint-plugin-import": "2.31.0",
+		"eslint-plugin-jest": "28.11.0",
+		"eslint-plugin-jsdoc": "50.6.6",
+		"eslint-plugin-jsx-a11y": "6.10.2",
+		"eslint-plugin-n": "17.16.2",
+		"eslint-plugin-promise": "7.2.1",
+		"eslint-plugin-react": "7.37.4",
+		"eslint-plugin-react-hooks": "5.2.0",
+		"eslint-plugin-unicorn": "57.0.0",
+		"globals": "16.0.0",
+		"markdownlint-cli": "0.44.0",
+		"micromatch": "4.0.8",
 		"postcss-scss": "4.0.9",
-		"stylelint": "16.2.0",
+		"stylelint": "16.15.0",
 		"stylelint-declaration-block-no-ignored-properties": "2.8.0",
-		"stylelint-high-performance-animation": "1.10.0",
+		"stylelint-high-performance-animation": "1.11.0",
 		"stylelint-order": "6.0.4",
-		"stylelint-scss": "6.1.0",
-		"stylelint-use-logical-spec": "5.0.1"
+		"stylelint-scss": "6.11.1",
+		"stylelint-use-logical-spec": "5.0.1",
+		"typescript-eslint": "8.26.1"
 	},
 	"peerDependencies": {
 		"postcss-value-parser": "*",
 		"typescript": ">=4.0.0"
 	},
 	"devDependencies": {
-		"@types/eslint": "8.56.2",
-		"@types/micromatch": "4.0.6",
-		"@types/node": "20.11.6",
+		"@types/eslint": "9.6.1",
+		"@types/micromatch": "4.0.9",
+		"@types/node": "22.13.10",
 		"stylelint-find-new-rules": "5.0.0",
-		"typescript": "5.3.3"
+		"typescript": "5.8.2"
 	}
 }