@perfective/eslint-config 0.33.0 → 0.34.0

package/README.adoc

@@ -78,7 +78,7 @@ import { perfectiveEslintConfig } from '@perfective/eslint-config';
 
 // Optional dependencies.
 import { cypressConfig } from '@perfective/eslint-config/cypress';
-import { jestConfig } from '@perfective/eslint-config/jest';
+import { jestConfig, jestTypescriptConfig } from '@perfective/eslint-config/jest';
 import { jestDomConfig } from '@perfective/eslint-config/jest-dom';
 import { rxjsConfig } from '@perfective/eslint-config/rxjs';
 import { testingLibraryConfig } from '@perfective/eslint-config/testing-library';
@@ -86,6 +86,7 @@ import { testingLibraryConfig } from '@perfective/eslint-config/testing-library'
 const eslintConfig = perfectiveEslintConfig([
     cypressConfig,
     jestConfig,
+    jestTypescriptConfig,
     jestDomConfig,
     rxjsConfig,
     testingLibraryConfig,
@@ -188,6 +189,12 @@ a nominal type for glob patterns.
 ** `jestFiles: Glob[]`
 — the link:https://jestjs.io/docs/configuration#testmatch-arraystring[default] glob patterns
 Jest uses to find test files.
+** `jestJavascriptFiles: Glob[]`
+— the link:https://jestjs.io/docs/configuration#testmatch-arraystring[default] glob patterns
+Jest uses to find JavaScript test files.
+** `jestTypescriptFiles: Glob[]`
+— the link:https://jestjs.io/docs/configuration#testmatch-arraystring[default] glob patterns
+Jest uses to find TypeScript test files.
 ** `cypressFiles: Glob`
 — the link:https://docs.cypress.io/app/references/configuration#e2e[default] glob pattern
 Cypress uses to load test files.
@@ -231,6 +238,11 @@ Overrides some rules for `perfectiveEslintConfig` for compatibility with Cypress
 
 * `jestConfig(files: Glob[] = jestFiles): Linter.Config`
 — creates a flat config for `eslint-plugin-jest` for a given list of files globs.
+This config excludes the rules that require `@typescript-eslint` plugin.
++
+* `jestTypescriptConfig(files: Glob[] = jestTypescriptFiles): Linter.Config`
+— creates a flat config for `eslint-plugin-jest` for a given list of TypeScript file globs.
+This config includes only the rules that require `@typescript-eslint` plugin.
 
 === `@perfective/eslint-config/jest-dom`
 
@@ -257,6 +269,9 @@ Allows to splice `internal` scope packages imports between the global and relati
 
 === `@perfective/eslint-config/typescript-eslint`
 
+* `typescriptEslintDependentConfig(plugin: ESLint.Plugin, rules: Linter.RulesRecord, files: Glob[] = typescriptFiles): Linter.Config`
+— a function to create a flat config for a given `plugin` that requires TypeScript ESLint plugin.
++
 * `interface TypescriptEslintNamingConvention`
 — configuration options for the
 `link:https://typescript-eslint.io/rules/naming-convention/[@typescript-eslint/naming-convention]` rule.
@@ -270,7 +285,7 @@ Allows to splice `internal` scope packages imports between the global and relati
 — values for the `@typescript-eslint/naming-convention` rule `format` option.
 ** `type TypescriptEslintNamingConventionUnderscore`
 — values for the `@typescript-eslint/naming-convention` rule `leadingUnderscore` and `trailingUnderscore` options.
-** `function typescriptEslintNamingConvention(extensions: TypescriptEslintNamingConvention[] = []): TypescriptEslintNamingConvention[]`
+** `typescriptEslintNamingConvention(extensions: TypescriptEslintNamingConvention[] = []): TypescriptEslintNamingConvention[]`
 — creates configuration with the given extensions for the `@typescript-eslint/naming-convention` rule.
 
 === `@perfective/eslint-config/unicorn`
@@ -280,5 +295,5 @@ Allows to splice `internal` scope packages imports between the global and relati
 `link:https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/prevent-abbreviations.md[unicorn/prevent-abbreviation]` rule.
 ** `type UnicornPreventAbbreviationReplacements`
 — nominal type for the `replacements` option of the `unicorn/prevent-abbreviation` rule.
-** `function unicornPreventAbbreviations( replacements: UnicornPreventAbbreviationReplacements = {}, options: Partial<Pick<UnicornPreventAbbreviations, 'checkProperties'>> = {}): UnicornPreventAbbreviations`
+** `unicornPreventAbbreviations(replacements: UnicornPreventAbbreviationReplacements = {}, options: Partial<Pick<UnicornPreventAbbreviations, 'checkProperties'>> = {}): UnicornPreventAbbreviations`
 — creates configuration for the `unicorn/prevent-abbreviation` rule with the given replacements and options.

package/config/jest/index.d.ts

@@ -1 +1,2 @@
 export { jestConfig } from './jest-config';
+export { jestTypescriptConfig } from './jest-typescript-config';

package/config/jest/index.js

@@ -1 +1,2 @@
-export { jestConfig } from "./jest-config.js";
+export { jestConfig } from "./jest-config.js";
+export { jestTypescriptConfig } from "./jest-typescript-config.js";

package/config/jest/jest-config.d.ts

@@ -3,6 +3,8 @@ import { Glob } from '../../linter/glob';
 /**
  * Creates a flat config for `eslint-plugin-jest` for a given list of files globs.
  *
+ * This config excludes the rules that require `@typescript-eslint` plugin.
+ *
  * @since v0.31.0
  */
 export declare function jestConfig(files?: Glob[]): Linter.Config;

package/config/jest/jest-config.js

@@ -1,7 +1,6 @@
 import eslintPluginJest from 'eslint-plugin-jest';
 import { jestFiles } from "../../linter/glob.js";
-import { importNoExtraneousDependencies } from "../import/index.js";
-import { typescriptEslintJestRules } from "./typescript-eslint-jest-rules.js";
+import { importNoExtraneousDependencies } from "../import/rules/no-extraneous-dependencies.js";
 export function jestConfig(files = jestFiles) {
   return {
     files,
@@ -11,7 +10,7 @@ export function jestConfig(files = jestFiles) {
     languageOptions: {
       globals: eslintPluginJest.environments.globals.globals
     },
-    rules: Object.assign(Object.assign(Object.assign({}, perfectiveRules()), typescriptEslintJestRules), {
+    rules: Object.assign(Object.assign({}, perfectiveRules()), {
       'jest/consistent-test-it': ['warn', {
         fn: 'test',
         withinDescribe: 'it'
@@ -110,14 +109,6 @@ export function jestConfig(files = jestFiles) {
 }
 function perfectiveRules() {
   return {
-    '@typescript-eslint/ban-ts-comment': ['error', {
-      'ts-expect-error': 'allow-with-description',
-      'ts-ignore': true,
-      'ts-nocheck': true,
-      'ts-check': false
-    }],
-    '@typescript-eslint/init-declarations': 'off',
-    '@typescript-eslint/unbound-method': 'off',
     'import/no-extraneous-dependencies': ['error', importNoExtraneousDependencies({
       devDependencies: jestFiles
     })],
@@ -130,6 +121,6 @@ function perfectiveRules() {
     }],
     'prefer-arrow/prefer-arrow-functions': 'off',
     'promise/always-return': 'off',
-    '@smarttools/rxjs/no-topromise': 'off'
+    'rxjs-x/no-topromise': 'off'
   };
 }

package/config/jest/jest-typescript-config.d.ts

@@ -0,0 +1,10 @@
+import { Linter } from 'eslint';
+import { Glob } from '../../linter/glob';
+/**
+ * Creates a flat config for `eslint-plugin-jest` for a given list of TypeScript file globs.
+ *
+ * This config includes only the rules that require `@typescript-eslint` plugin.
+ *
+ * @since v0.34.0
+ */
+export declare function jestTypescriptConfig(files?: Glob[]): Linter.Config;

package/config/jest/jest-typescript-config.js

@@ -0,0 +1,24 @@
+import eslintPluginJest from 'eslint-plugin-jest';
+import { jestTypescriptFiles } from "../../linter/glob.js";
+import { typescriptEslintDependentConfig } from "../typescript-eslint/typescript-eslint-config.js";
+const jestTypescriptRules = {
+  'jest/no-error-equal': 'error',
+  'jest/no-unnecessary-assertion': 'error',
+  'jest/unbound-method': ['error', {
+    ignoreStatic: false
+  }],
+  'jest/valid-expect-with-promise': 'error'
+};
+const jestTypescriptEslintRulesOverrides = {
+  '@typescript-eslint/ban-ts-comment': ['error', {
+    'ts-expect-error': 'allow-with-description',
+    'ts-ignore': true,
+    'ts-nocheck': true,
+    'ts-check': false
+  }],
+  '@typescript-eslint/init-declarations': 'off',
+  '@typescript-eslint/unbound-method': 'off'
+};
+export function jestTypescriptConfig(files = jestTypescriptFiles) {
+  return typescriptEslintDependentConfig(eslintPluginJest, Object.assign(Object.assign({}, jestTypescriptRules), jestTypescriptEslintRulesOverrides), files);
+}

package/config/typescript-eslint/index.d.ts

@@ -1 +1,2 @@
 export { TypescriptEslintNamingConvention, typescriptEslintNamingConvention, TypescriptEslintNamingConventionFormat, TypescriptEslintNamingConventionGroupSelector, TypescriptEslintNamingConventionIndividualSelector, TypescriptEslintNamingConventionSelector, TypescriptEslintNamingConventionUnderscore, } from './rules/typescript-eslint-naming-convention';
+export { typescriptEslintDependentConfig } from './typescript-eslint-config';

package/config/typescript-eslint/index.js

@@ -1 +1,2 @@
-export { typescriptEslintNamingConvention } from "./rules/typescript-eslint-naming-convention.js";
+export { typescriptEslintNamingConvention } from "./rules/typescript-eslint-naming-convention.js";
+export { typescriptEslintDependentConfig } from "./typescript-eslint-config.js";

package/config/typescript-eslint/typescript-eslint-config.d.ts

@@ -1,2 +1,16 @@
-import { Linter } from 'eslint';
+import { ESLint, Linter } from 'eslint';
+import { Glob } from '../../linter/glob';
 export declare function typescriptEslintConfig(): Linter.Config;
+/**
+ * A function to create a flat config for a given `plugin` that requires TypeScript ESLint plugin.
+ *
+ * This function should be used by other plugin configurations to enable rules that require type information
+ * or to change the behavior of the `@typescript-eslint` plugin rules.
+ *
+ * @param plugin - An ESLint plugin with the rules.
+ * @param rules - Rules for the plugin or for the `@typescript-eslint` plugin.
+ * @param files - An optional list of globs to narrow down the applicable files.
+ *
+ * @since v0.34.0
+ */
+export declare function typescriptEslintDependentConfig(plugin: ESLint.Plugin, rules: Linter.RulesRecord, files?: Glob[]): Linter.Config;

package/config/typescript-eslint/typescript-eslint-config.js

@@ -1,4 +1,4 @@
-import { plugin } from 'typescript-eslint';
+import { plugin as typescriptEslintPlugin } from 'typescript-eslint';
 import { typescriptFiles } from "../../linter/glob.js";
 import { typescriptLanguageOptions } from "../../linter/language-options.js";
 import { extensionRules } from "./extension-rules.js";
@@ -8,8 +8,19 @@ export function typescriptEslintConfig() {
     files: typescriptFiles,
     languageOptions: typescriptLanguageOptions(),
     plugins: {
-      '@typescript-eslint': plugin
+      '@typescript-eslint': typescriptEslintPlugin
     },
     rules: Object.assign(Object.assign({}, supportedRules), extensionRules)
   };
+}
+export function typescriptEslintDependentConfig(plugin, rules, files = typescriptFiles) {
+  return {
+    files,
+    languageOptions: typescriptLanguageOptions(),
+    plugins: {
+      '@typescript-eslint': typescriptEslintPlugin,
+      plugin
+    },
+    rules
+  };
 }

package/linter/glob.d.ts

@@ -40,6 +40,22 @@ export declare const typescriptDeclarationFiles: Glob;
  * @since v0.31.0
  */
 export declare const configurationFiles: string[];
+/**
+ * The default glob patterns Jest uses to find JavaScript test files.
+ *
+ * @see https://jestjs.io/docs/configuration#testmatch-arraystring
+ *
+ * @since v0.34.0
+ */
+export declare const jestJavascriptFiles: Glob[];
+/**
+ * The default glob patterns Jest uses to find TypeScript test files.
+ *
+ * @see https://jestjs.io/docs/configuration#testmatch-arraystring
+ *
+ * @since v0.34.0
+ */
+export declare const jestTypescriptFiles: Glob[];
 /**
  * The default glob patterns Jest uses to find test files.
  *

package/linter/glob.js

@@ -4,5 +4,7 @@ export const tsxFiles = '**/*.tsx';
 export const typescriptFiles = ['**/*.{ts,cts,mts}', tsxFiles];
 export const typescriptDeclarationFiles = '**/*.d.{ts,cts,mts}';
 export const configurationFiles = ['**/.*.js', '**/*.config.js', '**/gulpfile.js'];
-export const jestFiles = ['**/__tests__/**/*.[jt]s?(x)', '**/?(*.)+(spec|test).[jt]s?(x)'];
+export const jestJavascriptFiles = ['**/__tests__/**/*.js?(x)', '**/?(*.)+(spec|test).js?(x)'];
+export const jestTypescriptFiles = ['**/__tests__/**/*.ts?(x)', '**/?(*.)+(spec|test).ts?(x)'];
+export const jestFiles = [...jestJavascriptFiles, ...jestTypescriptFiles];
 export const cypressFiles = 'cypress/e2e/**/*.cy.{js,jsx,ts,tsx}';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@perfective/eslint-config",
-    "version": "0.33.0",
+    "version": "0.34.0",
     "description": "ESLint shareable rules configuration",
     "keywords": ["code quality", "code standard", "code style", "eslint", "eslint config", "lint", "perfective", "tslint", "tslint config", "typescript"],
     "author": "Andrey Mikheychik <a.mikheychik@gmail.com>",
@@ -21,7 +21,7 @@
         "eslint-plugin-import": "^2.32.0",
         "eslint-plugin-jest": "^29.12.1",
         "eslint-plugin-jest-dom": "^5.5.0",
-        "eslint-plugin-jsdoc": "^61.5.0",
+        "eslint-plugin-jsdoc": "^61.7.1",
         "eslint-plugin-n": "^17.23.1",
         "eslint-plugin-prefer-arrow": "^1.2.3",
         "eslint-plugin-promise": "^7.2.1",

package/config/jest/typescript-eslint-jest-rules.d.ts

@@ -1,2 +0,0 @@
-import { Linter } from 'eslint';
-export declare const typescriptEslintJestRules: Linter.RulesRecord;

package/config/jest/typescript-eslint-jest-rules.js

@@ -1,8 +0,0 @@
-export const typescriptEslintJestRules = {
-  'jest/no-error-equal': 'error',
-  'jest/no-unnecessary-assertion': 'error',
-  'jest/unbound-method': ['error', {
-    ignoreStatic: false
-  }],
-  'jest/valid-expect-with-promise': 'error'
-};