@darksheep/eslint 6.4.2 → 6.5.0

package/src/plugins/jsdoc.js

@@ -4,9 +4,9 @@ import { getTypescriptFiles } from '../utilities/eslint-files.js';
 import { getPackageJson } from '../utilities/package.js';
 
 /**
- * Get ESLint config for js docs
- * @param {URL} root The root of the package being linted
- * @returns {Promise<import('eslint').Linter.FlatConfig[]>}
+ * Get ESLint config for JSDoc.
+ * @param {URL} root - The root of the package being linted.
+ * @returns {Promise<import('eslint').Linter.Config[]>}
  */
 export async function createEslintJSDocConfig(root) {
   const tsPackage = await getPackageJson(root, 'typescript');
@@ -19,37 +19,65 @@ export async function createEslintJSDocConfig(root) {
       settings: {
         jsdoc: {
           mode: 'typescript',
-          // Prefer 'Object' over 'object'
-          preferredTypes: { object: 'Object' },
+          preferredTypes: { object: [ 'Object' ] },
         },
       },
       rules: {
         'jsdoc/check-access': 'warn',
         'jsdoc/check-alignment': 'warn',
+        'jsdoc/check-examples': 'off',
+        'jsdoc/check-indentation': 'off',
+        'jsdoc/check-line-alignment': [ 'error', 'never', { customSpacings: { postDelimiter: 1, postTag: 1, postType: 1, postName: 1 } } ],
         'jsdoc/check-param-names': 'warn',
         'jsdoc/check-property-names': 'warn',
+        'jsdoc/check-syntax': 'error',
         'jsdoc/check-tag-names': 'warn',
+        'jsdoc/check-template-names': 'off',
+        'jsdoc/check-types': typeChecks,
         'jsdoc/check-values': 'warn',
+        'jsdoc/convert-to-jsdoc-comments': 'off',
         'jsdoc/empty-tags': 'warn',
         'jsdoc/implements-on-classes': 'error',
+        'jsdoc/imports-as-dependencies': 'off',
         'jsdoc/informative-docs': 'warn',
+        'jsdoc/lines-before-block': 'off',
+        'jsdoc/match-description': 'off',
+        'jsdoc/match-name': 'off',
+        'jsdoc/multiline-blocks': 'off',
+        'jsdoc/no-bad-blocks': 'warn',
+        'jsdoc/no-blank-block-descriptions': 'error',
+        'jsdoc/no-blank-blocks': 'error',
         'jsdoc/no-defaults': 'warn',
+        'jsdoc/no-missing-syntax': 'off',
         'jsdoc/no-multi-asterisks': 'warn',
-        'jsdoc/require-jsdoc': [ 1, { publicOnly: true } ],
-        'jsdoc/require-param': 'warn',
+        'jsdoc/no-restricted-syntax': 'off',
+        'jsdoc/no-undefined-types': typeChecks,
+        'jsdoc/require-asterisk-prefix': 'error',
+        'jsdoc/require-description-complete-sentence': 'error',
+        'jsdoc/require-description': 'off',
+        'jsdoc/require-example': 'off',
+        'jsdoc/require-file-overview': 'off', // Could automatically add a licence?
+        'jsdoc/require-hyphen-before-param-description': [ 'error', 'always' ],
+        'jsdoc/require-jsdoc': [ 'warn', { publicOnly: true } ],
         'jsdoc/require-param-description': 'warn',
         'jsdoc/require-param-name': 'warn',
         'jsdoc/require-param-type': 'warn',
-        'jsdoc/require-property': 'warn',
+        'jsdoc/require-param': 'warn',
         'jsdoc/require-property-description': 'warn',
         'jsdoc/require-property-name': 'warn',
         'jsdoc/require-property-type': 'warn',
-        'jsdoc/require-returns': 'warn',
+        'jsdoc/require-property': 'warn',
         'jsdoc/require-returns-check': 'warn',
+        'jsdoc/require-returns-description': 'off',
         'jsdoc/require-returns-type': 'warn',
-
-        'jsdoc/check-types': typeChecks,
-        'jsdoc/no-undefined-types': typeChecks,
+        'jsdoc/require-returns': 'warn',
+        'jsdoc/require-template': 'off',
+        'jsdoc/require-throws': 'off',
+        'jsdoc/require-yields-check': 'off',
+        'jsdoc/require-yields': 'off',
+        'jsdoc/sort-tags': 'error',
+        'jsdoc/tag-lines': 'off',
+        'jsdoc/text-escaping': 'off',
         'jsdoc/valid-types': typeChecks,
       },
     },

package/src/plugins/json.js

@@ -2,8 +2,8 @@ import jsonc from 'eslint-plugin-jsonc';
 import parser from 'jsonc-eslint-parser';
 
 /**
- * Get ESLint config for imports check
- * @returns {Promise<import('eslint').Linter.FlatConfig[]>}
+ * Get ESLint config for imports check.
+ * @returns {Promise<import('eslint').Linter.Config[]>}
  */
 export async function createEslintJsonConfig() {
   return [
@@ -14,10 +14,18 @@ export async function createEslintJsonConfig() {
       // @ts-expect-error jsonc does not match the plugin interface
       plugins: { jsonc },
       rules: {
+        'jsonc/auto': 'off',
+        'jsonc/key-name-casing': 'off',
+        'jsonc/sort-array-values': 'off',
+        'jsonc/sort-keys': 'off',
+
         'jsonc/array-bracket-newline': [ 'error', 'consistent' ],
         'jsonc/array-bracket-spacing': [ 'error', 'always' ],
         'jsonc/array-element-newline': [ 'error', 'consistent' ],
+        'jsonc/comma-style': [ 'error', 'last' ],
         'jsonc/key-spacing': [ 'error' ],
+        'jsonc/no-irregular-whitespace': 'error',
+        'jsonc/no-octal-escape': 'error',
         'jsonc/object-curly-newline': [ 'error', { consistent: true } ],
         'jsonc/object-curly-spacing': [ 'error', 'always' ],
         'jsonc/object-property-newline': [ 'error', { allowAllPropertiesOnSameLine: true } ],

package/src/plugins/node.js

@@ -16,36 +16,28 @@ const module = n.configs['flat/recommended-module'];
 
 /** @type {import('eslint').Linter.RulesRecord} */
 const commonRules = {
-  'n/no-new-require': 'error',
-  'n/no-mixed-requires': 'error',
-
   'n/callback-return': 'error',
+  'n/exports-style': [ 'error', 'module.exports' ],
+  'n/file-extension-in-import': [ 'error', 'always' ],
+  'n/global-require': [ 'error' ],
   'n/handle-callback-err': 'error',
-  'n/no-process-exit': 'warn',
-  'n/no-process-env': 'warn',
-  'n/no-path-concat': 'error',
-  'n/prefer-node-protocol': 'warn',
-
+  'n/hashbang': 'error',
   'n/no-callback-literal': 'off',
+  'n/no-deprecated-api': 'error',
   'n/no-exports-assign': 'off',
-
-  'n/global-require': [ 'error' ],
+  'n/no-mixed-requires': 'error',
+  'n/no-new-require': 'error',
+  'n/no-path-concat': 'error',
+  'n/no-process-env': 'warn',
+  'n/no-process-exit': 'warn',
+  'n/no-restricted-import': 'off',
+  'n/no-restricted-require': 'off',
   'n/no-unpublished-bin': 'error',
   'n/no-unpublished-import': [ 'error', { ignoreTypeImport: true } ],
   'n/no-unpublished-require': 'error',
-
   'n/no-unsupported-features/es-builtins': 'error',
   'n/no-unsupported-features/es-syntax': [ 'error', { ignores: [ 'modules' ] } ],
   'n/no-unsupported-features/node-builtins': 'error',
-
-  'n/process-exit-as-throw': 'error',
-  'n/hashbang': 'error',
-
-  'n/no-deprecated-api': 'error',
-
-  'n/exports-style': [ 'error', 'module.exports' ],
-  'n/file-extension-in-import': [ 'error', 'always' ],
-
   'n/prefer-global/buffer': [ 'warn', 'always' ],
   'n/prefer-global/console': [ 'warn', 'always' ],
   'n/prefer-global/process': [ 'warn', 'always' ],
@@ -53,12 +45,14 @@ const commonRules = {
   'n/prefer-global/text-encoder': [ 'warn', 'never' ],
   'n/prefer-global/url-search-params': [ 'warn', 'never' ],
   'n/prefer-global/url': [ 'warn', 'never' ],
+  'n/prefer-node-protocol': 'warn',
   'n/prefer-promises/dns': 'warn',
   'n/prefer-promises/fs': 'warn',
+  'n/process-exit-as-throw': 'error',
 };
 
 /**
- * @param {string[]} globs A list of file globs whos extensions to get
+ * @param {string[]} globs - A list of file globs whos extensions to get.
  * @returns {string[]}
  */
 function toExt(globs) {
@@ -66,9 +60,9 @@ function toExt(globs) {
 }
 
 /**
- * Get ESLint config for the node plugin
- * @param {URL} root root url
- * @returns {Promise<import('eslint').Linter.FlatConfig[]>}
+ * Get ESLint config for the node plugin.
+ * @param {URL} root - Root url.
+ * @returns {Promise<import('eslint').Linter.Config[]>}
  */
 export async function createEslintNodeConfig(root) {
   const commonFiles = await getCommonFiles(root);

package/src/plugins/package-json.js

@@ -2,8 +2,8 @@ import * as plugin from 'eslint-plugin-package-json';
 import jsoncParser from 'jsonc-eslint-parser';
 
 /**
- * Get ESLint config for the regexp plugin
- * @returns {Promise<import('eslint').Linter.FlatConfig[]>}
+ * Get ESLint config for the regexp plugin.
+ * @returns {Promise<import('eslint').Linter.Config[]>}
  */
 export async function createEslintPackageJsonConfig() {
   return [
@@ -17,17 +17,13 @@ export async function createEslintPackageJsonConfig() {
       files: [ 'package.json', '**/package.json' ],
       rules: {
         'package-json/order-properties': [ 'error', { order: 'sort-package-json' } ],
-        'package-json/sort-collections': 'error',
-
-        // Seems to break renovate finding changelogs
         'package-json/prefer-repository-shorthand': 'off',
-        // Breaks workspace dependency linking
-        // Invalid version range for dependency @darksheep/clone: workspace:~
-        'package-json/valid-package-def': 'warn',
-
+        'package-json/repository-shorthand': [ 'error', { form: 'object' } ],
+        'package-json/sort-collections': 'error',
         'package-json/unique-dependencies': 'error',
         'package-json/valid-local-dependency': 'error',
         'package-json/valid-name': 'error',
+        'package-json/valid-package-def': 'warn',
         'package-json/valid-repository-directory': 'error',
         'package-json/valid-version': 'error',
       },

package/src/plugins/perfectionist.js

@@ -190,16 +190,25 @@ const moduleRules = {
 
 /** @type {import('eslint').Linter.RulesRecord} */
 const typescriptRules = {
+  'perfectionist/sort-astro-attributes': 0,
+  'perfectionist/sort-enums': 0,
   'perfectionist/sort-interfaces': 1,
+  'perfectionist/sort-intersection-types': 0,
+  'perfectionist/sort-jsx-props': 0,
   'perfectionist/sort-object-types': 1,
   'perfectionist/sort-objects': 1,
+  'perfectionist/sort-sets': 0,
+  'perfectionist/sort-svelte-attributes': 0,
+  'perfectionist/sort-switch-case': 1,
   'perfectionist/sort-union-types': 1,
+  'perfectionist/sort-variable-declarations': 0,
+  'perfectionist/sort-vue-attributes': 0,
 };
 
 /**
- * Get ESLint config for imports check
- * @param {URL} root The root of the package being linted
- * @returns {Promise<import('eslint').Linter.FlatConfig[]>}
+ * Get ESLint config for imports check.
+ * @param {URL} root - The root of the package being linted.
+ * @returns {Promise<import('eslint').Linter.Config[]>}
  */
 export async function createEslintPerfectionistConfig(root) {
   return [

package/src/plugins/promise.js

@@ -1,8 +1,8 @@
 import promise from 'eslint-plugin-promise';
 
 /**
- * Get ESLint config for the promise plugin
- * @returns {import('eslint').Linter.FlatConfig[]}
+ * Get ESLint config for the promise plugin.
+ * @returns {import('eslint').Linter.Config[]}
  */
 export function createEslintPromiseConfig() {
   return [ {
@@ -11,7 +11,11 @@ export function createEslintPromiseConfig() {
     rules: {
       ...promise.configs.recommended.rules,
       'promise/catch-or-return': [ 'error', { allowFinally: true } ],
+      'promise/no-multiple-resolved': 'error',
       'promise/no-return-wrap': [ 'error', { allowReject: true } ],
+      'promise/prefer-await-to-callbacks': 'off',
+      'promise/prefer-await-to-then': 'off',
+      'promise/spec-only': 'error',
     },
   } ];
 }

package/src/plugins/react.js

@@ -89,9 +89,9 @@ const rules = {
 };
 
 /**
- * Get ESLint config for imports check
- * @param {URL} root The root of the package being linted
- * @returns {Promise<import('eslint').Linter.FlatConfig[]>}
+ * Get ESLint config for imports check.
+ * @param {URL} root - The root of the package being linted.
+ * @returns {Promise<import('eslint').Linter.Config[]>}
  */
 export async function createEslintReactConfig(root) {
   const packageJson = await getPackageJson(root, 'react');

package/src/plugins/regexp.js

@@ -1,14 +1,107 @@
 import regexp from 'eslint-plugin-regexp';
 
 /**
- * Get ESLint config for the regexp plugin
- * @returns {import('eslint').Linter.FlatConfig[]}
+ * Get ESLint config for the regexp plugin.
+ * @returns {import('eslint').Linter.Config[]}
  */
 export function createEslintRegexpConfig() {
   return [
     {
       name: 'regexp/recommended',
-      ...regexp.configs['flat/recommended'],
+      plugins: { regexp },
+      rules: {
+        'no-control-regex': 'error',
+        'no-empty-character-class': 'off',
+        'no-invalid-regexp': 'off',
+        'no-misleading-character-class': 'error',
+        'no-regex-spaces': 'error',
+        'no-useless-backreference': 'off',
+        'prefer-regex-literals': 'error',
+        'require-unicode-regexp': 'off',
+
+        'regexp/confusing-quantifier': 'warn',
+        'regexp/control-character-escape': 'error',
+        'regexp/grapheme-string-literal': 'error',
+        'regexp/hexadecimal-escape': [ 'error', 'never' ],
+        'regexp/letter-case': 'error',
+        'regexp/match-any': 'error',
+        'regexp/negation': 'error',
+        'regexp/no-contradiction-with-assertion': 'error',
+        'regexp/no-control-character': 'error',
+        'regexp/no-dupe-characters-character-class': 'error',
+        'regexp/no-dupe-disjunctions': 'error',
+        'regexp/no-empty-alternative': 'warn',
+        'regexp/no-empty-capturing-group': 'error',
+        'regexp/no-empty-character-class': 'error',
+        'regexp/no-empty-group': 'error',
+        'regexp/no-empty-lookarounds-assertion': 'error',
+        'regexp/no-empty-string-literal': 'error',
+        'regexp/no-escape-backspace': 'error',
+        'regexp/no-extra-lookaround-assertions': 'error',
+        'regexp/no-invalid-regexp': 'error',
+        'regexp/no-invisible-character': 'error',
+        'regexp/no-lazy-ends': 'warn',
+        'regexp/no-legacy-features': 'error',
+        'regexp/no-misleading-capturing-group': 'error',
+        'regexp/no-misleading-unicode-character': 'error',
+        'regexp/no-missing-g-flag': 'error',
+        'regexp/no-non-standard-flag': 'error',
+        'regexp/no-obscure-range': 'error',
+        'regexp/no-octal': 'error',
+        'regexp/no-optional-assertion': 'error',
+        'regexp/no-potentially-useless-backreference': 'warn',
+        'regexp/no-standalone-backslash': 'error',
+        'regexp/no-super-linear-backtracking': 'error',
+        'regexp/no-super-linear-move': 'error',
+        'regexp/no-trivially-nested-assertion': 'error',
+        'regexp/no-trivially-nested-quantifier': 'error',
+        'regexp/no-unused-capturing-group': 'error',
+        'regexp/no-useless-assertions': 'error',
+        'regexp/no-useless-backreference': 'error',
+        'regexp/no-useless-character-class': 'error',
+        'regexp/no-useless-dollar-replacements': 'error',
+        'regexp/no-useless-escape': 'error',
+        'regexp/no-useless-flag': 'warn',
+        'regexp/no-useless-lazy': 'error',
+        'regexp/no-useless-non-capturing-group': 'error',
+        'regexp/no-useless-quantifier': 'error',
+        'regexp/no-useless-range': 'error',
+        'regexp/no-useless-set-operand': 'error',
+        'regexp/no-useless-string-literal': 'error',
+        'regexp/no-useless-two-nums-quantifier': 'error',
+        'regexp/no-zero-quantifier': 'error',
+        'regexp/optimal-lookaround-quantifier': 'warn',
+        'regexp/optimal-quantifier-concatenation': 'error',
+        'regexp/prefer-character-class': 'error',
+        'regexp/prefer-d': 'error',
+        'regexp/prefer-escape-replacement-dollar-char': 'error',
+        'regexp/prefer-lookaround': 'error',
+        'regexp/prefer-named-backreference': 'error',
+        'regexp/prefer-named-capture-group': 'error',
+        'regexp/prefer-named-replacement': 'error',
+        'regexp/prefer-plus-quantifier': 'error',
+        'regexp/prefer-predefined-assertion': 'error',
+        'regexp/prefer-quantifier': 'error',
+        'regexp/prefer-question-quantifier': 'error',
+        'regexp/prefer-range': 'error',
+        'regexp/prefer-regexp-exec': 'error',
+        'regexp/prefer-regexp-test': 'error',
+        'regexp/prefer-result-array-groups': 'error',
+        'regexp/prefer-set-operation': 'error',
+        'regexp/prefer-star-quantifier': 'error',
+        'regexp/prefer-unicode-codepoint-escapes': 'error',
+        'regexp/prefer-w': 'error',
+        'regexp/require-unicode-regexp': 'error',
+        'regexp/require-unicode-sets-regexp': 'off',
+        'regexp/simplify-set-operations': 'error',
+        'regexp/sort-alternatives': 'off',
+        'regexp/sort-character-class-elements': 'error',
+        'regexp/sort-flags': 'error',
+        'regexp/strict': 'error',
+        'regexp/unicode-escape': 'error',
+        'regexp/unicode-property': 'error',
+        'regexp/use-ignore-case': 'error',
+      },
     },
   ];
 }

package/src/plugins/sca.js

@@ -7,9 +7,9 @@ import {
 } from '../utilities/eslint-files.js';
 
 /**
- * Get ESLint config for the sca plugin
- * @param {URL} root The root url of the package we are linting
- * @returns {Promise<import('eslint').Linter.FlatConfig[]>}
+ * Get ESLint config for the sca plugin.
+ * @param {URL} root - The root url of the package we are linting.
+ * @returns {Promise<import('eslint').Linter.Config[]>}
  */
 export async function createEslintSCAConfig(root) {
   return [

package/src/plugins/security.js

@@ -1,8 +1,8 @@
 import security from 'eslint-plugin-security';
 
 /**
- * Get ESLint config for the security plugin
- * @returns {import('eslint').Linter.FlatConfig[]}
+ * Get ESLint config for the security plugin.
+ * @returns {import('eslint').Linter.Config[]}
  */
 export function createEslintSecurityConfig() {
   return [ {