@fullstacksjs/eslint-config 12.0.0 → 12.1.1

package/README.md

@@ -57,10 +57,7 @@ You can fine-tune module detection by overriding it, the `defineConfig` function
 ```typescript
 interface Options {
   react?: boolean; // controls react, react-hooks, jsx/a11y plugins
-  typescript?: { // controls typescript plugin
-    projectService?: boolean | ProjectService; tsconfigRootDir: string; cacheLifetime?: number; // https://typescript-eslint.io/packages/parser#projectservice
-    tsconfigRootDir?: string // https://typescript-eslint.io/packages/parser#tsconfigrootdir
-  };
+  typescript?: ParserOptions // https://typescript-eslint.io/packages/parser#configuration
   node?: boolean; // controls node plugin
   sort?: boolean; // controls perfectionist plugin
   strict?: boolean; // controls strict rules

package/cjs/index.js

@@ -97,17 +97,17 @@ function defineConfig(initOptions = {}, ...extend) {
   if (enableSort) rules.push((0, _perfectionist.default)(options));
   if (enableImport) rules.push((0, _imports.default)(options));
   if (enableTailwind) rules.push((0, _tailwind.default)(options));
-  if (enableTest) rules.push((0, _tests.default)(options));
   if (enableNode) rules.push((0, _node.default)(options));
-  if (enableJest) rules.push((0, _jest.default)(options));
-  if (enableVitest) rules.push((0, _vitest.default)(options));
-  if (enableCypress) rules.push((0, _cypress.default)(options));
   if (enableReact) rules.push((0, _react.default)(options));
   if (enableStorybook) rules.push((0, _storybook.default)(options));
   if (enableTypescript) rules.push((0, _typescript.default)(options));
-  if (enablePlaywright) rules.push((0, _playwright.default)(options));
-  if (enableNext && enableNext) rules.push((0, _next.default)(options));
+  if (enableNext) rules.push((0, _next.default)(options));
   if (enablePrettier) rules.push((0, _prettier.default)(options));
+  if (enableJest) rules.push((0, _jest.default)(options));
+  if (enableVitest) rules.push((0, _vitest.default)(options));
+  if (enableTest) rules.push((0, _tests.default)(options));
+  if (enableCypress) rules.push((0, _cypress.default)(options));
+  if (enablePlaywright) rules.push((0, _playwright.default)(options));
   if (Object.keys(eslintOptions).length > 0) rules.push(eslintOptions);
   if (extend) Array.prototype.push.apply(rules, extend);
   return (0, _config.defineConfig)(rules);

package/cjs/modules/tests.js

@@ -34,6 +34,7 @@ function tests(options = {}) {
       'jest-formatting/padding-around-test-blocks': 'warn',
       'max-lines-per-function': 'off',
       'no-sparse-arrays': 'off',
+      'no-empty-function': 'off',
       ...(0, _conditions.predicate)(options.react, {
         'react/jsx-no-constructed-context-values': 'off'
       }),
@@ -42,7 +43,8 @@ function tests(options = {}) {
         '@typescript-eslint/no-namespace': 'off',
         '@typescript-eslint/unbound-method': 'off',
         '@typescript-eslint/no-empty-function': 'off',
-        '@typescript-eslint/no-floating-promises': 'off'
+        '@typescript-eslint/no-floating-promises': 'off',
+        '@typescript-eslint/prefer-promise-reject-errors': 'off'
       })
     }
   };

package/cjs/modules/typescript.js

@@ -13,6 +13,7 @@ var _namingConvention = require("../utils/naming-convention.js");
  * @return { import('eslint').Linter.Config }
  */
 function typescript(options = {}) {
+  const projectService = options.typescript && options.typescript.tsconfigRootDir && options.typescript.projectService;
   return {
     files: [_globs.globs.ts, _globs.globs.tsx],
     plugins: {
@@ -55,7 +56,7 @@ function typescript(options = {}) {
       '@typescript-eslint/member-naming': 'off',
       '@typescript-eslint/member-ordering': 'off',
       '@typescript-eslint/method-signature-style': ['warn', 'property'],
-      '@typescript-eslint/naming-convention': ['warn', ..._namingConvention.namingConvention, ...(options.typescript && options.typescript.projects ? [{
+      '@typescript-eslint/naming-convention': ['warn', ..._namingConvention.namingConvention, ...(projectService ? [{
         selector: 'variable',
         types: ['boolean'],
         format: ['PascalCase'],
@@ -160,7 +161,7 @@ function typescript(options = {}) {
       }],
       '@typescript-eslint/unified-signatures': 'error',
       '@typescript-eslint/key-spacing': 'off',
-      ...(0, _conditions.predicate)(options.typescript && options.typescript.projects, {
+      ...(0, _conditions.predicate)(projectService, {
         '@typescript-eslint/await-thenable': 'error',
         '@typescript-eslint/consistent-return': 'off',
         '@typescript-eslint/consistent-type-exports': 'warn',
@@ -246,6 +247,7 @@ function typescript(options = {}) {
       // Need useless-fragment for JSX return type
 
       // Conflicts with @typescript-eslint
+      'no-empty-function': 'off',
       'default-case': 'off',
       'import/named': 'off',
       'import/namespace': 'off',

package/cjs/option.d.ts

@@ -8,23 +8,93 @@ interface ProjectService {
 }
 
 export interface Options extends Linter.Config {
+  /**
+   * @default true if you have `react` or `react-dom` in your dependencies
+   * Controls react plugin.
+   */
   react?: boolean;
+  /**
+   * @default true
+   */
   sort?: boolean;
+  /**
+   * @default true if you have `next` in your dependencies
+   * Controls next plugin.
+   */
   next?: boolean;
+  /**
+   * @default true if you have `tailwind` in your dependencies
+   * Controls tailwind plugin.
+   */
   tailwind?: boolean | { callees: string[] };
+  /**
+   * @default false
+   * Controls [node plugin](https://www.npmjs.com/package/eslint-plugin-n).
+   */
   node?: boolean;
+  /**
+   * @default false
+   * Enables all strict rules.
+   */
   strict?: boolean;
+  /**
+   * @default true
+   * Controls [import plugin](https://www.npmjs.com/package/eslint-plugin-import-x).
+   */
   import?: boolean | { internalRegExp?: string; lifetime?: number; projects?: string | string[] };
+  /**
+   * @default true if you have `type: module` in your `package.json`.
+   */
   esm?: boolean;
+  /**
+   * @default true if you have one of `jest`, `vitest`, `cypress`, `playwright`, `storybook`, `prettier` in your dependencies.
+   * Controls [test plugin](https://www.npmjs.com/package/eslint-plugin-jest-formatting).
+   */
   test?: boolean;
+  /**
+   * @default true if you have `jest` in your dependencies.
+   * Controls [jest plugin](https://www.npmjs.com/package/eslint-plugin-jest).
+   */
   jest?: boolean;
+  /**
+   * @default true if you have `vitest` in your dependencies.
+   * Controls [vitest plugin](https://www.npmjs.com/package/eslint-plugin-vitest).
+   */
   vitest?: boolean;
+  /**
+   * @default true if you have `cypress` in your dependencies.
+   * Controls [cypress plugin](https://www.npmjs.com/package/eslint-plugin-cypress).
+   */
   cypress?: boolean;
+  /**
+   * @default true if you have `storybook` in your dependencies.
+   * Controls [storybook plugin](https://www.npmjs.com/package/eslint-plugin-storybook).
+   */
   storybook?: boolean;
+  /**
+   * @default true if you have `prettier` in your dependencies.
+   * Controls [prettier plugin](https://www.npmjs.com/package/eslint-plugin-prettier).
+   */
   prettier?: boolean;
+  /**
+   * @default true if you have `playwright` in your dependencies.
+   * Controls [playwright plugin](https://www.npmjs.com/package/eslint-plugin-playwright).
+   */
   playwright?: boolean;
+  /**
+   * @default true if you have `typescript` in your dependencies.
+   * Controls [typescript plugin](https://www.npmjs.com/package/typescript-eslint).
+   */
   typescript?: { projectService?: boolean | ProjectService; tsconfigRootDir: string; cacheLifetime?: number };
+  /**
+   * @default false
+   * Disables expensive rules.
+   */
   disableExpensiveRules?: boolean;
+  /**
+   * @default []
+   * List of globs to ignore.
+   */
   ignores?: string[];
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fullstacksjs/eslint-config",
-  "version": "12.0.0",
+  "version": "12.1.1",
   "license": "MIT",
   "author": "fullstacks <fullstacksjs@gmail.com>",
   "description": "fullstacks eslint config",

package/src/index.mjs

@@ -92,17 +92,17 @@ export function defineConfig(initOptions = {}, ...extend) {
   if (enableSort) rules.push(perfectionist(options));
   if (enableImport) rules.push(imports(options));
   if (enableTailwind) rules.push(tailwind(options));
-  if (enableTest) rules.push(tests(options));
   if (enableNode) rules.push(node(options));
-  if (enableJest) rules.push(jest(options));
-  if (enableVitest) rules.push(vitest(options));
-  if (enableCypress) rules.push(cypress(options));
   if (enableReact) rules.push(react(options));
   if (enableStorybook) rules.push(storybook(options));
   if (enableTypescript) rules.push(typescript(options));
-  if (enablePlaywright) rules.push(playwright(options));
-  if (enableNext && enableNext) rules.push(next(options));
+  if (enableNext) rules.push(next(options));
   if (enablePrettier) rules.push(prettier(options));
+  if (enableJest) rules.push(jest(options));
+  if (enableVitest) rules.push(vitest(options));
+  if (enableTest) rules.push(tests(options));
+  if (enableCypress) rules.push(cypress(options));
+  if (enablePlaywright) rules.push(playwright(options));
 
   if (Object.keys(eslintOptions).length > 0) rules.push(eslintOptions);
   if (extend) Array.prototype.push.apply(rules, extend);

package/src/modules/tests.mjs

@@ -25,6 +25,7 @@ function tests(options = {}) {
 
       'max-lines-per-function': 'off',
       'no-sparse-arrays': 'off',
+      'no-empty-function': 'off',
 
       ...predicate(options.react, {
         'react/jsx-no-constructed-context-values': 'off',
@@ -36,6 +37,7 @@ function tests(options = {}) {
         '@typescript-eslint/unbound-method': 'off',
         '@typescript-eslint/no-empty-function': 'off',
         '@typescript-eslint/no-floating-promises': 'off',
+        '@typescript-eslint/prefer-promise-reject-errors': 'off',
       }),
     },
   };

package/src/modules/typescript.mjs

@@ -9,6 +9,8 @@ import { namingConvention } from '../utils/naming-convention.mjs';
  * @return { import('eslint').Linter.Config }
  */
 function typescript(options = {}) {
+  const projectService = options.typescript && options.typescript.tsconfigRootDir && options.typescript.projectService;
+
   return {
     files: [globs.ts, globs.tsx],
     plugins: { '@typescript-eslint': plugin },
@@ -54,7 +56,7 @@ function typescript(options = {}) {
       '@typescript-eslint/naming-convention': [
         'warn',
         ...namingConvention,
-        ...(options.typescript && options.typescript.projects
+        ...(projectService
           ? [
               {
                 selector: 'variable',
@@ -142,7 +144,7 @@ function typescript(options = {}) {
       '@typescript-eslint/unified-signatures': 'error',
       '@typescript-eslint/key-spacing': 'off',
 
-      ...predicate(options.typescript && options.typescript.projects, {
+      ...predicate(projectService, {
         '@typescript-eslint/await-thenable': 'error',
         '@typescript-eslint/consistent-return': 'off',
         '@typescript-eslint/consistent-type-exports': 'warn',
@@ -218,6 +220,7 @@ function typescript(options = {}) {
       'react/jsx-no-useless-fragment': 'off', // Need useless-fragment for JSX return type
 
       // Conflicts with @typescript-eslint
+      'no-empty-function': 'off',
       'default-case': 'off',
       'import/named': 'off',
       'import/namespace': 'off',

package/src/option.d.ts

@@ -8,23 +8,93 @@ interface ProjectService {
 }
 
 export interface Options extends Linter.Config {
+  /**
+   * @default true if you have `react` or `react-dom` in your dependencies
+   * Controls react plugin.
+   */
   react?: boolean;
+  /**
+   * @default true
+   */
   sort?: boolean;
+  /**
+   * @default true if you have `next` in your dependencies
+   * Controls next plugin.
+   */
   next?: boolean;
+  /**
+   * @default true if you have `tailwind` in your dependencies
+   * Controls tailwind plugin.
+   */
   tailwind?: boolean | { callees: string[] };
+  /**
+   * @default false
+   * Controls [node plugin](https://www.npmjs.com/package/eslint-plugin-n).
+   */
   node?: boolean;
+  /**
+   * @default false
+   * Enables all strict rules.
+   */
   strict?: boolean;
+  /**
+   * @default true
+   * Controls [import plugin](https://www.npmjs.com/package/eslint-plugin-import-x).
+   */
   import?: boolean | { internalRegExp?: string; lifetime?: number; projects?: string | string[] };
+  /**
+   * @default true if you have `type: module` in your `package.json`.
+   */
   esm?: boolean;
+  /**
+   * @default true if you have one of `jest`, `vitest`, `cypress`, `playwright`, `storybook`, `prettier` in your dependencies.
+   * Controls [test plugin](https://www.npmjs.com/package/eslint-plugin-jest-formatting).
+   */
   test?: boolean;
+  /**
+   * @default true if you have `jest` in your dependencies.
+   * Controls [jest plugin](https://www.npmjs.com/package/eslint-plugin-jest).
+   */
   jest?: boolean;
+  /**
+   * @default true if you have `vitest` in your dependencies.
+   * Controls [vitest plugin](https://www.npmjs.com/package/eslint-plugin-vitest).
+   */
   vitest?: boolean;
+  /**
+   * @default true if you have `cypress` in your dependencies.
+   * Controls [cypress plugin](https://www.npmjs.com/package/eslint-plugin-cypress).
+   */
   cypress?: boolean;
+  /**
+   * @default true if you have `storybook` in your dependencies.
+   * Controls [storybook plugin](https://www.npmjs.com/package/eslint-plugin-storybook).
+   */
   storybook?: boolean;
+  /**
+   * @default true if you have `prettier` in your dependencies.
+   * Controls [prettier plugin](https://www.npmjs.com/package/eslint-plugin-prettier).
+   */
   prettier?: boolean;
+  /**
+   * @default true if you have `playwright` in your dependencies.
+   * Controls [playwright plugin](https://www.npmjs.com/package/eslint-plugin-playwright).
+   */
   playwright?: boolean;
+  /**
+   * @default true if you have `typescript` in your dependencies.
+   * Controls [typescript plugin](https://www.npmjs.com/package/typescript-eslint).
+   */
   typescript?: { projectService?: boolean | ProjectService; tsconfigRootDir: string; cacheLifetime?: number };
+  /**
+   * @default false
+   * Disables expensive rules.
+   */
   disableExpensiveRules?: boolean;
+  /**
+   * @default []
+   * List of globs to ignore.
+   */
   ignores?: string[];
 }