@darksheep/eslint 8.0.7 → 9.0.0

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
+## [9.0.0](https://github.com/DarkSheepSoftware/eslint/compare/v8.1.0...v9.0.0) (2025-10-10)
+
+
+### ⚠ BREAKING CHANGES
+
+* add new rules and plugins ([#1047](https://github.com/DarkSheepSoftware/eslint/issues/1047))
+
+### 🌟 Features
+
+* add new rules and plugins ([#1047](https://github.com/DarkSheepSoftware/eslint/issues/1047)) ([ae05958](https://github.com/DarkSheepSoftware/eslint/commit/ae05958b65ff5d7750c402064d3e2f0f683c6737))
+
+
+### 📦 Dependencies
+
+* **pkg:** pin dependencies ([#1050](https://github.com/DarkSheepSoftware/eslint/issues/1050)) ([91609d1](https://github.com/DarkSheepSoftware/eslint/commit/91609d15085d697fbdddeb4e905b45a3cf371868))
+* **pkg:** update dependency eslint-plugin-jsdoc to v61.1.0 ([#1051](https://github.com/DarkSheepSoftware/eslint/issues/1051)) ([790f781](https://github.com/DarkSheepSoftware/eslint/commit/790f7812aa0b951da19edc3c83726017a19e277a))
+
+## [8.1.0](https://github.com/DarkSheepSoftware/eslint/compare/v8.0.7...v8.1.0) (2025-10-09)
+
+
+### 🌟 Features
+
+* support node 24 in engines ([5724c9d](https://github.com/DarkSheepSoftware/eslint/commit/5724c9da36bce46e0b319572e5fb63e8ca6d9021))
+
 ## [8.0.7](https://github.com/DarkSheepSoftware/eslint/compare/v8.0.6...v8.0.7) (2025-10-09)
 
 

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@darksheep/eslint",
-  "version": "8.0.7",
+  "version": "9.0.0",
+  "description": "A fairly complete (opinionated) eslint config",
   "repository": {
     "type": "git",
     "url": "https://github.com/DarkSheepSoftware/eslint"
@@ -19,6 +20,7 @@
   ],
   "scripts": {
     "githooks": "git config core.hooksPath .githooks",
+    "inspect": "config-inspector",
     "prepack": "tsc"
   },
   "dependencies": {
@@ -30,7 +32,9 @@
     "@typescript-eslint/eslint-plugin": "8.46.0",
     "@typescript-eslint/parser": "8.46.0",
     "editorconfig": "3.0.1",
-    "eslint-plugin-jsdoc": "61.0.1",
+    "eslint-plugin-command": "3.3.1",
+    "eslint-plugin-jest": "29.0.1",
+    "eslint-plugin-jsdoc": "61.1.0",
     "eslint-plugin-jsonc": "2.21.0",
     "eslint-plugin-n": "17.23.1",
     "eslint-plugin-package-json": "0.56.3",
@@ -48,6 +52,7 @@
   },
   "devDependencies": {
     "@darksheep/eslint-formatter-github": "2.2.0",
+    "@eslint/config-inspector": "~1.3.0",
     "@types/node": "~22.18.0",
     "eslint": "~9.37.0",
     "type-fest": "~5.0.0",
@@ -63,7 +68,7 @@
   },
   "packageManager": "yarn@4.10.3",
   "engines": {
-    "node": "^20 || ^22"
+    "node": "^20.13.1 || >=22.2.0"
   },
   "volta": {
     "node": "22.20.0",

package/src/configs/eslint-base.js

@@ -1,4 +1,7 @@
-/** @type {import('eslint').Linter.RulesRecord} */
+/**
+ * @import { Linter } from 'eslint';
+ */
+/** @type {Linter.RulesRecord} */
 const rules = {
   'no-else-return': 'error',
 
@@ -109,7 +112,7 @@ const rules = {
 
 /**
  * Get the ESLint base config.
- * @returns {Promise<import('eslint').Linter.Config[]>}
+ * @returns {Promise<Linter.Config[]>}
  */
 export async function createEslintBaseConfig() {
   return [ {

package/src/configs/eslint-complexity.js

@@ -1,6 +1,9 @@
+/**
+ * @import { Linter } from 'eslint';
+ */
 /**
  * Get the ESLint config for complexity checks.
- * @returns {import('eslint').Linter.Config[]}
+ * @returns {Linter.Config[]}
  */
 export function createEslintComplexityConfig() {
   return [ {

package/src/configs/eslint-ignores.js

@@ -1,3 +1,7 @@
+/**
+ * @import { URL } from 'node:url';
+ * @import { Linter } from 'eslint';
+ */
 import * as fs from 'node:fs/promises';
 import { resolve } from 'node:path';
 import { fileURLToPath } from 'node:url';
@@ -5,7 +9,7 @@ import { fileURLToPath } from 'node:url';
 import { findUp } from '../utilities/filesystem.js';
 
 /**
- * @param {import('node:url').URL} root - Root url.
+ * @param {URL} root - Root url.
  * @returns {Promise<string[]>}
  */
 async function getGitignore(root) {
@@ -30,8 +34,8 @@ async function getGitignore(root) {
 
 /**
  * Get basic ESLint ignores config.
- * @param {import('node:url').URL} root - Root url.
- * @returns {Promise<import('eslint').Linter.Config[]>}
+ * @param {URL} root - Root url.
+ * @returns {Promise<Linter.Config[]>}
  */
 export async function createEslintIgnoresConfig(root) {
   const ignores = await getGitignore(root);

package/src/configs/eslint-style.js

@@ -1,6 +1,9 @@
+/**
+ * @import { Linter } from 'eslint';
+ */
 import { createEditorOverrides } from '../utilities/editorconfig.js';
 
-/** @type {import('eslint').Linter.RulesRecord} */
+/** @type {Linter.RulesRecord} */
 const rules = {
   'dot-notation': 'error',
   'curly': 'error',
@@ -12,8 +15,8 @@ const rules = {
 
 /**
  * Get basic ESLint style config.
- * @param {import('node:url').URL} root - Root url.
- * @returns {Promise<import('eslint').Linter.Config[]>}
+ * @param {URL} root - Root url.
+ * @returns {Promise<Linter.Config[]>}
  */
 export async function createStyleConfig(root) {
   return [

package/src/configs/react.js

@@ -1,6 +1,9 @@
+/**
+ * @import { Linter } from 'eslint';
+ */
 /**
  * Get basic ESLint style config.
- * @returns {Promise<import('eslint').Linter.Config[]>}
+ * @returns {Promise<Linter.Config[]>}
  */
 export async function createReactConfig() {
   return [

package/src/custom-logger/index.js

@@ -1,9 +1,12 @@
+/**
+ * @import { ESLint, Linter } from 'eslint';
+ */
 import { relative } from 'node:path';
 
 import { getEnvString } from '@darksheep/environment';
 
 /**
- * @param {import('eslint').Linter.LintMessage[][]} files - Some messages.
+ * @param {Linter.LintMessage[][]} files - Some messages.
  * @returns {number}
  */
 function getSeverity(files) {
@@ -58,7 +61,7 @@ const icons = [
 
 /** @type {Set<string>} */
 const files = new Set();
-/** @type {import('eslint').ESLint.Plugin} */
+/** @type {ESLint.Plugin} */
 export default {
   processors: {
     logger: {

package/src/custom-rules/instance-of-array.js

@@ -1,10 +1,14 @@
 /**
- * @param {import('eslint').Rule.RuleContext} context - ESLint rule context.
- * @returns {import('eslint').Rule.RuleListener}
+ * @import { Rule } from 'eslint';
+ */
+
+/**
+ * @param {Rule.RuleContext} context - ESLint rule context.
+ * @returns {Rule.RuleListener}
  */
 const preferInstance = (context) => ({
   /**
-   * @param {import('eslint').Rule.Node} node - The AST function node.
+   * @param {Rule.Node} node - The AST function node.
    * @returns {void}
    */
   'CallExpression[callee.object.name = "Array"][callee.property.name = "isArray"]': (node) => {
@@ -19,7 +23,7 @@ const preferInstance = (context) => ({
     }
 
     const left = context.sourceCode.getText(node.arguments[0]);
-    /** @type {import('eslint').Rule.ReportFixer} */
+    /** @type {Rule.ReportFixer} */
     const fix = (fixer) => fixer.replaceText(node, `${left} instanceof Array`);
 
     context.report({ node, message, fix });
@@ -27,12 +31,12 @@ const preferInstance = (context) => ({
 });
 
 /**
- * @param {import('eslint').Rule.RuleContext} context - ESLint rule context.
- * @returns {import('eslint').Rule.RuleListener}
+ * @param {Rule.RuleContext} context - ESLint rule context.
+ * @returns {Rule.RuleListener}
  */
 const preferIsArray = (context) => ({
   /**
-   * @param {import('eslint').Rule.Node} node - The AST function node.
+   * @param {Rule.Node} node - The AST function node.
    * @returns {void}
    */
   'BinaryExpression[operator="instanceof"][right.type="Identifier"][right.name="Array"]': (node) => {
@@ -43,14 +47,14 @@ const preferIsArray = (context) => ({
     const message = 'Use `Array.isArray()` instead of `instanceof Array`';
 
     const argument = context.sourceCode.getText(node.left);
-    /** @type {import('eslint').Rule.ReportFixer} */
+    /** @type {Rule.ReportFixer} */
     const fix = (fixer) => fixer.replaceText(node, `Array.isArray(${argument})`);
 
     context.report({ node, message, fix });
   },
 });
 
-/** @type {import('eslint').Rule.RuleModule} */
+/** @type {Rule.RuleModule} */
 const rule = {
   meta: {
     type: 'suggestion',

package/src/custom-rules/loose-types.js

@@ -1,3 +1,7 @@
+/**
+ * @import { Rule } from 'eslint';
+ */
+
 /**
  * @param {unknown} input - The possible object.
  * @returns {input is { [key: string]: unknown }}
@@ -8,15 +12,15 @@ function isObject(input) {
 
 /**
  * @param {string} optionName - Name of the property option.
- * @param {import('eslint').Rule.RuleContext} context - ESLint rule context.
+ * @param {Rule.RuleContext} context - ESLint rule context.
  * @param {string} message - Error message on report.
- * @returns {(node: import('eslint').Rule.Node) => void}
+ * @returns {(node: Rule.Node) => void}
  */
 function createReporter(optionName, context, message) {
   const [ options ] = context.options;
 
   /**
-   * @param {import('eslint').Rule.Node} node - The AST function node.
+   * @param {Rule.Node} node - The AST function node.
    * @returns {void}
    */
   function validateNode(node) {
@@ -31,7 +35,7 @@ function createReporter(optionName, context, message) {
   return validateNode;
 }
 
-/** @type {import('eslint').Rule.RuleModule} */
+/** @type {Rule.RuleModule} */
 const rule = {
   meta: {
     type: 'problem',

package/src/custom-rules/no-useless-expression.js

@@ -1,3 +1,7 @@
+/**
+ * @import { Rule } from 'eslint';
+ */
+
 const selector = [
   // test || false, false || test
   'LogicalExpression[operator="||"] > [type=/Literal$/]',
@@ -5,14 +9,14 @@ const selector = [
   'LogicalExpression[operator="&&"] > [type=/Literal$/]',
 ].join(', ');
 
-/** @type {import('eslint').Rule.RuleModule} */
+/** @type {Rule.RuleModule} */
 const rule = {
   meta: { type: 'suggestion' },
 
   create: function (context) {
     return {
       /**
-       * @param {import('eslint').Rule.Node} node - The AST function node.
+       * @param {Rule.Node} node - The AST function node.
        * @returns {void}
        */
       [selector]: (node) => {

package/src/custom-rules/sequence-expression.js

@@ -1,11 +1,14 @@
-/** @type {import('eslint').Rule.RuleModule} */
+/**
+ * @import { Rule } from 'eslint';
+ */
+/** @type {Rule.RuleModule} */
 const rule = {
   meta: { type: 'suggestion' },
 
   create: function (context) {
     return {
       /**
-       * @param {import('eslint').Rule.Node} node - The AST function node.
+       * @param {Rule.Node} node - The AST function node.
        * @returns {void}
        */
       SequenceExpression: (node) => {

package/src/helper/disable-plugin.js

@@ -0,0 +1,17 @@
+/**
+ * @import { Linter } from 'eslint'
+ */
+
+/**
+ * @param {string} plugin - The name of the plugin.
+ * @param {Linter.Config[]} configs - The name of the rule.
+ * @returns {void}
+ */
+export function disablePlugin(plugin, configs) {
+  for (let i = configs.length - 1; i >= 0; i--) {
+    const config = configs[i];
+    if (config?.plugins?.[plugin] != null) {
+      configs.splice(i, 1);
+    }
+  }
+}

package/src/helper/disable-rule.js

@@ -0,0 +1,17 @@
+/**
+ * @import { Linter } from 'eslint'
+ */
+
+/**
+ * @param {string} rule - The name of the rule.
+ * @param {Linter.Config[]} configs - The name of the rule.
+ * @returns {void}
+ */
+export function disableRule(rule, configs) {
+  for (let i = configs.length - 1; i >= 0; i--) {
+    const config = configs[i];
+    if (config?.rules?.[rule] != null) {
+      config.rules[rule] = 0;
+    }
+  }
+}

package/src/helper/edit-rule.js

@@ -0,0 +1,33 @@
+/**
+ * @import { Linter } from 'eslint'
+ */
+
+/**
+ * @param {Linter.RuleEntry} rule - The original rule.
+ * @returns {Linter.RuleSeverity}
+ */
+function getCurrentSeverity(rule) {
+  if (typeof rule === 'string' || typeof rule === 'number') {
+    return rule;
+  }
+
+  return rule[0];
+}
+
+/**
+ * @param {Linter.Config[]} configs - The name of the rule.
+ * @param {string} rule - The name of the rule.
+ * @param {Linter.RuleSeverity | undefined} severity - The new severity.
+ * @param {unknown} [options] - Additional options for the rule.
+ * @returns {void}
+ */
+export function editRule(configs, rule, severity, options) {
+  for (const config of configs) {
+    if (config?.rules?.[rule] != null) {
+      config.rules[rule] = [
+        severity ?? getCurrentSeverity(config.rules[rule]),
+        options,
+      ];
+    }
+  }
+}

package/src/index.js

@@ -1,3 +1,6 @@
+/**
+ * @import { Linter } from 'eslint';
+ */
 import { pathToFileURL, URL } from 'node:url';
 
 import { createEslintBaseConfig } from './configs/eslint-base.js';
@@ -6,7 +9,9 @@ import { createEslintIgnoresConfig } from './configs/eslint-ignores.js';
 import { createEslintRecommendsConfig } from './configs/eslint-recommended.js';
 import { createStyleConfig } from './configs/eslint-style.js';
 import { createReactConfig } from './configs/react.js';
+import { createEslintCommandConfig } from './plugins/command.js';
 import { createEslintCommentsConfig } from './plugins/eslint-comments.js';
+import { createEslintJestConfig } from './plugins/jest.js';
 import { createEslintJSDocConfig } from './plugins/jsdoc.js';
 import { createEslintJsonConfig } from './plugins/json.js';
 import { createEslintNodeConfig } from './plugins/node.js';
@@ -30,10 +35,12 @@ const configBuilders = [
   createEslintBaseConfig,
   createEslintComplexityConfig,
   createStyleConfig,
+  createEslintCommandConfig,
   createEslintCommentsConfig,
   createEslintNodeConfig,
   createEslintPerfectionistConfig,
   createEslintPackageJsonConfig,
+  createEslintJestConfig,
   createEslintJsonConfig,
   createEslintYmlConfig,
   createEslintPromiseConfig,
@@ -51,8 +58,8 @@ const configBuilders = [
 ];
 
 /**
- * @param {import('node:url').URL} root - The root url object for the project config.
- * @returns {Promise<import('eslint').Linter.Config[]>}
+ * @param {URL} root - The root url object for the project config.
+ * @returns {Promise<Linter.Config[]>}
  */
 async function createConfigUrl(root) {
   const configs = await Promise.all(
@@ -63,8 +70,8 @@ async function createConfigUrl(root) {
 }
 
 /**
- * @param {string | import('node:url').URL} root - Root url.
- * @returns {Promise<import('eslint').Linter.Config[]>}
+ * @param {string | URL} root - Root url.
+ * @returns {Promise<Linter.Config[]>}
  */
 export async function createConfig(root) {
   if (root instanceof URL) {

package/src/plugins/command.js

@@ -0,0 +1,20 @@
+/**
+ * @import { Linter } from 'eslint';
+ */
+import command from 'eslint-plugin-command';
+
+/**
+ * Get ESLint config for the node plugin.
+ * @returns {Promise<Linter.Config[]>}
+ */
+export async function createEslintCommandConfig() {
+  return [
+    {
+      name: 'command/common',
+      plugins: { command },
+      rules: {
+        'command/command': 'error',
+      },
+    },
+  ];
+}

package/src/plugins/eslint-comments.js

@@ -1,8 +1,11 @@
+/**
+ * @import { Linter } from 'eslint';
+ */
 import eslintComments from '@eslint-community/eslint-plugin-eslint-comments';
 
 /**
  * Get ESLint config for comments check.
- * @returns {import('eslint').Linter.Config[]}
+ * @returns {Linter.Config[]}
  */
 export function createEslintCommentsConfig() {
   return [

package/src/plugins/jest.js

@@ -0,0 +1,135 @@
+import { getTypescriptFiles } from '../utilities/eslint-files.js';
+/**
+ * @import { URL } from 'node:url';
+ * @import { Linter } from 'eslint';
+ */
+import { getPackageJson } from '../utilities/package.js';
+
+/**
+ * @template {Object} T
+ * @param {T | { default: T }} target - The module to optionally check for default exports.
+ * @returns {T}
+ */
+function idef(target) {
+  return /** @type {{ default: T }} */ (target)?.default ?? target;
+}
+
+/**
+ * Get ESLint config for the typescript plugin.
+ * @param {URL} root - Root url.
+ * @returns {Promise<Linter.Config[]>}
+ */
+export async function createEslintJestConfig(root) {
+  const packageJson = await getPackageJson(root, 'jest');
+  if (packageJson == null) {
+    return [];
+  }
+
+  const jest = idef(await import('eslint-plugin-jest'));
+
+  return [
+    {
+      name: 'jest/base',
+      files: [
+        '**/test/**',
+        '**/spec/**',
+        '**/__mocks__/**',
+        '**/{test,spec,jest}.{js,ts}',
+        '**/*.{test,spec}.{js,ts}',
+      ],
+      plugins: { jest },
+      languageOptions: {
+        globals: jest.environments.globals.globals,
+      },
+      settings: {
+        jest: {
+          version: packageJson.version,
+        },
+      },
+
+      rules: {
+        'max-lines': 'off',
+        'max-lines-per-function': 'off',
+        'max-nested-callbacks': 'off',
+        'max-params': 'off',
+
+        'n/global-require': 'off',
+        'global-require': 'off',
+
+        'jest/consistent-test-it': [ 'error', { fn: 'test', withinDescribe: 'test' } ],
+        'jest/expect-expect': [ 'error', { assertFunctionNames: [ 'expect' ] } ],
+        'jest/max-expects': 'off',
+        'jest/max-nested-describe': 'off',
+        'jest/no-alias-methods': 'error',
+        'jest/no-commented-out-tests': 'error',
+        'jest/no-conditional-expect': 'error',
+        'jest/no-conditional-in-test': 'warn',
+        'jest/no-confusing-set-timeout': 'warn',
+        'jest/no-deprecated-functions': 'error',
+        'jest/no-disabled-tests': 'warn',
+        'jest/no-done-callback': 'error',
+        'jest/no-duplicate-hooks': 'error',
+        'jest/no-export': 'error',
+        'jest/no-focused-tests': 'warn',
+        'jest/no-hooks': 'off',
+        'jest/no-identical-title': 'error',
+        'jest/no-interpolation-in-snapshots': 'off',
+        'jest/no-jasmine-globals': 'error',
+        'jest/no-large-snapshots': 'off',
+        'jest/no-mocks-import': 'error',
+        'jest/no-restricted-jest-methods': 'off',
+        'jest/no-restricted-matchers': 'off',
+        'jest/no-standalone-expect': 'error',
+        'jest/no-test-prefixes': 'error',
+        'jest/no-test-return-statement': 'error',
+        'jest/prefer-called-with': 'warn',
+        'jest/prefer-comparison-matcher': 'warn',
+        'jest/prefer-each': 'warn',
+        'jest/prefer-ending-with-an-expect': 'off',
+        'jest/prefer-equality-matcher': 'warn',
+        'jest/prefer-expect-assertions': [ 'warn', { onlyFunctionsWithAsyncKeyword: true } ],
+        'jest/prefer-expect-resolves': 'warn',
+        'jest/prefer-hooks-in-order': 'warn',
+        'jest/prefer-hooks-on-top': 'warn',
+        'jest/prefer-importing-jest-globals': 'off',
+        'jest/prefer-jest-mocked': 'error',
+        'jest/prefer-lowercase-title': 'off',
+        'jest/prefer-mock-promise-shorthand': 'warn',
+        'jest/prefer-snapshot-hint': 'off',
+        'jest/prefer-spy-on': 'warn',
+        'jest/prefer-strict-equal': 'error',
+        'jest/prefer-to-be': 'warn',
+        'jest/prefer-to-contain': 'warn',
+        'jest/prefer-to-have-length': 'warn',
+        'jest/prefer-todo': 'warn',
+        'jest/require-hook': 'warn',
+        'jest/require-to-throw-message': 'error',
+        'jest/require-top-level-describe': 'error',
+        'jest/unbound-method': 'off',
+        'jest/valid-describe-callback': 'error',
+        'jest/valid-expect-in-promise': 'error',
+        'jest/valid-expect': 'error',
+        'jest/valid-title': 'error',
+
+        // Jest style
+
+        'jest/padding-around-after-all-blocks': 'off',
+        'jest/padding-around-after-each-blocks': 'off',
+        'jest/padding-around-all': 'off',
+        'jest/padding-around-before-all-blocks': 'off',
+        'jest/padding-around-before-each-blocks': 'off',
+        'jest/padding-around-describe-blocks': 'off',
+        'jest/padding-around-expect-groups': 'off',
+        'jest/padding-around-test-blocks': 'off',
+      },
+    },
+    {
+      name: 'jest/typescript',
+      files: getTypescriptFiles(),
+      plugins: { jest },
+      rules: {
+        'jest/no-untyped-mock-factory': 'warn',
+      },
+    },
+  ];
+}