@ocavue/eslint-config 2.16.0 → 2.18.0

package/README.md

@@ -23,36 +23,45 @@ In your `eslint.config.js` file, add the following to extend the basic config:
 
 ```js
 // eslint.config.js
-import { basic } from '@ocavue/eslint-config'
+import { defineESLintConfig } from '@ocavue/eslint-config'
 
-export default [...basic()]
+export default defineESLintConfig()
 ```
 
-If you want to use the React config, you can do the following:
+You can pass an optional object to the `defineESLintConfig` function to enable or disable the configs. For example, if you want to enable the React config, you can do the following:
 
 ```js
 // eslint.config.js
-import { basic, react } from '@ocavue/eslint-config'
+import { defineESLintConfig } from '@ocavue/eslint-config'
 
-export default [...basic(), ...react()]
+export default defineESLintConfig({ react: true })
 ```
 
-If you want to use the Vue config, you can do the following:
-
-```js
-// eslint.config.js
-import { basic, vue } from '@ocavue/eslint-config'
-
-export default [...basic(), ...vue()]
-```
-
-If you want to use the check the code blocks in markdown files, you can do the following:
-
-```js
-// eslint.config.js
-import { basic, markdown } from '@ocavue/eslint-config'
-
-export default [...basic(), ...markdown()]
+The full type definition for the options is as follows:
+
+```ts
+export interface ESLintConfigOptions {
+  /**
+   * Whether to check code blocks in Markdown files.
+   *
+   * @default true
+   */
+  markdown?: boolean
+
+  /**
+   * Whether to enable React configuration.
+   *
+   * @default false
+   */
+  react?: boolean
+
+  /**
+   * Whether to enable Vue configuration.
+   *
+   * @default false
+   */
+  vue?: boolean
+}
 ```
 
 ### Add script for package.json
@@ -86,7 +95,8 @@ If you are using VS Code, you and install [ESLint extension](https://marketplace
 }
 ```
 
-## Inspired by
+## Alternative solutions
 
 - https://github.com/antfu/eslint-config
 - https://github.com/sxzz/eslint-config
+- https://github.com/ntnyq/eslint-config

package/dist/antfu.d.ts

@@ -0,0 +1,2 @@
+import type { Linter } from 'eslint';
+export declare function antfu(): Linter.Config[];

package/dist/antfu.js

@@ -0,0 +1,15 @@
+import antfuPlugin from 'eslint-plugin-antfu';
+export function antfu() {
+    return [
+        {
+            name: 'antfu',
+            plugins: {
+                antfu: antfuPlugin,
+            },
+            rules: {
+                'antfu/import-dedupe': 'error',
+                'antfu/top-level-function': 'error',
+            },
+        },
+    ];
+}

package/dist/basic.d.ts

@@ -0,0 +1,2 @@
+import type { Linter } from 'eslint';
+export declare function basic(): Linter.Config[];

package/dist/basic.js

@@ -0,0 +1,20 @@
+import { antfu } from './antfu.js';
+import { ignores } from './ignores.js';
+import { imports } from './imports.js';
+import { noOnlyTests } from './no-only-tests.js';
+import { packageJson } from './package-json.js';
+import { prettier } from './prettier.js';
+import { typescript } from './typescript.js';
+import { unicorn } from './unicorn.js';
+export function basic() {
+    return [
+        ...ignores(),
+        ...typescript(),
+        ...imports(),
+        ...packageJson(),
+        ...unicorn(),
+        ...antfu(),
+        ...noOnlyTests(),
+        ...prettier(),
+    ];
+}

package/dist/ignores.d.ts

@@ -0,0 +1,2 @@
+import type { Linter } from 'eslint';
+export declare function ignores(): Linter.Config[];

package/dist/ignores.js

@@ -0,0 +1,8 @@
+import gitignore from 'eslint-config-flat-gitignore';
+import { GLOB_EXCLUDE } from './shared.js';
+export function ignores() {
+    return [
+        { ignores: [...GLOB_EXCLUDE], name: 'basic-global-ignores' },
+        gitignore(),
+    ];
+}

package/dist/imports.d.ts

@@ -0,0 +1,2 @@
+import type { Linter } from 'eslint';
+export declare function imports(): Linter.Config[];

package/dist/imports.js

@@ -0,0 +1,49 @@
+import * as importPlugin from 'eslint-plugin-import-x';
+export function imports() {
+    return [
+        {
+            name: 'import',
+            plugins: {
+                // @ts-expect-error incorrect type
+                import: importPlugin,
+            },
+            settings: {
+                'import-x/resolver': {
+                    // You will also need to install and configure the TypeScript resolver
+                    // See also https://github.com/import-js/eslint-import-resolver-typescript#configuration
+                    typescript: true,
+                    node: true,
+                },
+            },
+            rules: {
+                // External modules must be declared in the package.json. Only enforced in CI.
+                'import/no-extraneous-dependencies': process.env.CI ? 'error' : 'off',
+                'import/first': 'warn',
+                'import/no-mutable-exports': 'warn',
+                'import/no-useless-path-segments': 'warn',
+                'import/newline-after-import': 'warn',
+                // Disable `no-duplicates` because of the following bug
+                // https://github.com/un-ts/eslint-plugin-import-x/issues/167
+                // 'import/no-duplicates': [
+                //   'warn',
+                //   { 'prefer-inline': true },
+                // ],
+                'import/order': [
+                    'warn',
+                    {
+                        'newlines-between': 'always',
+                        alphabetize: { order: 'asc' },
+                        groups: [
+                            'builtin',
+                            'external',
+                            'internal',
+                            'parent',
+                            'sibling',
+                            'index',
+                        ],
+                    },
+                ],
+            },
+        },
+    ];
+}

package/dist/index.d.ts

@@ -1,7 +1,10 @@
-export * from "./src/typescript.js";
-export * from "./src/prettier.js";
-export * from "./src/basic.js";
-export * from "./src/markdown.js";
-export * from "./src/react.js";
-export * from "./src/vue.js";
-//# sourceMappingURL=index.d.ts.map
+import { type ESLintConfigOptions } from './options.js';
+import type { Config } from './types.js';
+export * from './basic.js';
+export * from './markdown.js';
+export * from './prettier.js';
+export * from './react.js';
+export * from './typescript.js';
+export * from './vue.js';
+export type { Config, ESLintConfigOptions };
+export declare function defineESLintConfig(options?: ESLintConfigOptions): Config[];

package/dist/index.js

@@ -0,0 +1,27 @@
+import { defineConfig } from 'eslint/config';
+import { basic } from './basic.js';
+import { markdown } from './markdown.js';
+import { resolveOptions } from './options.js';
+import { react } from './react.js';
+import { vue } from './vue.js';
+export * from './basic.js';
+export * from './markdown.js';
+export * from './prettier.js';
+export * from './react.js';
+export * from './typescript.js';
+export * from './vue.js';
+export function defineESLintConfig(options) {
+    const resolvedOptions = resolveOptions(options);
+    const configs = [];
+    configs.push(...basic());
+    if (resolvedOptions.markdown) {
+        configs.push(...markdown());
+    }
+    if (resolvedOptions.react) {
+        configs.push(...react());
+    }
+    if (resolvedOptions.vue) {
+        configs.push(...vue());
+    }
+    return defineConfig(configs);
+}

package/dist/markdown.d.ts

@@ -0,0 +1,2 @@
+import type { Linter } from 'eslint';
+export declare function markdown(): Linter.Config[];

package/dist/markdown.js

@@ -0,0 +1,41 @@
+import markdownPlugin from '@eslint/markdown';
+import { GLOB_MARKDOWN, GLOB_SRC, GLOB_VUE } from './shared.js';
+export function markdown() {
+    const recommended = markdownPlugin.configs.processor;
+    const extra = {
+        files: [`${GLOB_MARKDOWN}/${GLOB_SRC}`, `${GLOB_MARKDOWN}/${GLOB_VUE}`],
+        languageOptions: {
+            parserOptions: {
+                projectService: null,
+            },
+        },
+        rules: {
+            // Disable type-aware TypeScript rules, because the code blocks are not
+            // part of a compilable `tsconfig.json` project.
+            '@typescript-eslint/no-redeclare': 'off',
+            '@typescript-eslint/no-unused-vars': 'off',
+            '@typescript-eslint/no-use-before-define': 'off',
+            '@typescript-eslint/no-var-requires': 'off',
+            '@typescript-eslint/restrict-plus-operands': 'off',
+            '@typescript-eslint/no-unsafe-call': 'off',
+            '@typescript-eslint/no-unsafe-return': 'off',
+            '@typescript-eslint/no-unsafe-argument': 'off',
+            '@typescript-eslint/no-unsafe-member-access': 'off',
+            '@typescript-eslint/no-unsafe-assignment': 'off',
+            '@typescript-eslint/no-floating-promises': 'off',
+            '@typescript-eslint/no-misused-promises': 'off',
+            '@typescript-eslint/await-thenable': 'off',
+            '@typescript-eslint/unbound-method': 'off',
+            '@typescript-eslint/require-await': 'off',
+            '@typescript-eslint/no-unnecessary-type-assertion': 'off',
+            // Disable some import rules because they are not working well with
+            // twoslash ---cut--- imports.
+            'import/first': 'off',
+            'import/order': 'off',
+            'no-alert': 'off',
+            'no-console': 'off',
+            'no-restricted-imports': 'off',
+        },
+    };
+    return [...recommended, extra];
+}

package/dist/no-only-tests.d.ts

@@ -0,0 +1,2 @@
+import type { Linter } from 'eslint';
+export declare function noOnlyTests(): Linter.Config[];

package/dist/no-only-tests.js

@@ -0,0 +1,14 @@
+import plugin from 'eslint-plugin-no-only-tests';
+export function noOnlyTests() {
+    return [
+        {
+            name: 'no-only-tests',
+            plugins: {
+                'no-only-tests': plugin,
+            },
+            rules: {
+                'no-only-tests/no-only-tests': 'error',
+            },
+        },
+    ];
+}

package/dist/options.d.ts

@@ -0,0 +1,21 @@
+export interface ESLintConfigOptions {
+    /**
+     * Whether to check code blocks in Markdown files.
+     *
+     * @default true
+     */
+    markdown?: boolean;
+    /**
+     * Whether to enable React configuration.
+     *
+     * @default false
+     */
+    react?: boolean;
+    /**
+     * Whether to enable Vue configuration.
+     *
+     * @default false
+     */
+    vue?: boolean;
+}
+export declare function resolveOptions({ markdown, react, vue, }?: ESLintConfigOptions): Required<ESLintConfigOptions>;

package/dist/options.js

@@ -0,0 +1,7 @@
+export function resolveOptions({ markdown = true, react = false, vue = false, } = {}) {
+    return {
+        markdown,
+        react,
+        vue,
+    };
+}

package/dist/package-json.d.ts

@@ -0,0 +1,5 @@
+import type { Linter } from 'eslint';
+/**
+ * Sort package.json keys
+ */
+export declare function packageJson(): Linter.Config[];

package/dist/package-json.js

@@ -0,0 +1,70 @@
+import pkgJson from 'eslint-plugin-package-json';
+/**
+ * Sort package.json keys
+ */
+export function packageJson() {
+    const config = {
+        ...pkgJson.configs.recommended,
+        rules: {
+            ...pkgJson.configs.recommended.rules,
+            'package-json/no-empty-fields': 'off',
+            'package-json/valid-package-definition': 'off',
+            'package-json/require-description': 'warn',
+            'package-json/sort-collections': [
+                'warn',
+                [
+                    // 'scripts', // Don't sort scripts
+                    'devDependencies',
+                    'dependencies',
+                    'peerDependencies',
+                    'config',
+                    'exports',
+                ],
+            ],
+            'package-json/order-properties': [
+                'warn',
+                {
+                    order: [
+                        'name',
+                        'displayName',
+                        'publisher',
+                        'type',
+                        'version',
+                        'private',
+                        'packageManager',
+                        'description',
+                        'author',
+                        'license',
+                        'funding',
+                        'homepage',
+                        'repository',
+                        'bugs',
+                        'contributes',
+                        'keywords',
+                        'categories',
+                        'sideEffects',
+                        'main',
+                        'module',
+                        'types',
+                        'exports',
+                        'typesVersions',
+                        'bin',
+                        'icon',
+                        'files',
+                        'engines',
+                        'scripts',
+                        'dependencies',
+                        'peerDependencies',
+                        'peerDependenciesMeta',
+                        'optionalDependencies',
+                        'devDependencies',
+                        'publishConfig',
+                        'overrides',
+                        'resolutions',
+                    ],
+                },
+            ],
+        },
+    };
+    return [config];
+}

package/dist/{src/prettier.d.ts → prettier.d.ts}

@@ -1,8 +1,8 @@
+import type { Linter } from 'eslint';
 /**
  * Turns off all rules that are unnecessary or might conflict with Prettier.
  *
  * Notice that this config does not run `prettier` as an ESLint rule, so you
  * have to run `pretter` separately for formatting.
  */
-export function prettier(): import("eslint").Linter.Config<import("eslint").Linter.RulesRecord>[];
-//# sourceMappingURL=prettier.d.ts.map
+export declare function prettier(): Linter.Config[];

package/{src → dist}/prettier.js

@@ -1,5 +1,4 @@
-import prettierConfig from 'eslint-config-prettier'
-
+import prettierConfig from 'eslint-config-prettier';
 /**
  * Turns off all rules that are unnecessary or might conflict with Prettier.
  *
@@ -7,15 +6,12 @@ import prettierConfig from 'eslint-config-prettier'
  * have to run `pretter` separately for formatting.
  */
 export function prettier() {
-  /** @type {import('eslint').Linter.Config[]} */
-  const config = [
-    {
-      name: 'prettier',
-      rules: {
-        ...prettierConfig.rules,
-      },
-    },
-  ]
-
-  return config
+    return [
+        {
+            name: 'prettier',
+            rules: {
+                ...prettierConfig.rules,
+            },
+        },
+    ];
 }

package/dist/react.d.ts

@@ -0,0 +1,2 @@
+import type { Linter } from 'eslint';
+export declare function react(): Linter.Config[];

package/dist/react.js

@@ -0,0 +1,34 @@
+import reactPlugin from 'eslint-plugin-react';
+import reactHooksPlugin from 'eslint-plugin-react-hooks';
+import { GLOB_TS, GLOB_TSX } from './shared.js';
+export function react() {
+    const reactRecommended = reactPlugin.configs.flat?.recommended || {};
+    return [
+        {
+            ...reactRecommended,
+            name: 'react',
+            files: [GLOB_TS, GLOB_TSX],
+            settings: {
+                react: {
+                    version: 'detect',
+                },
+            },
+            rules: {
+                ...reactRecommended.rules,
+                'react/prop-types': 'off',
+                'react/react-in-jsx-scope': 'off',
+            },
+        },
+        {
+            name: 'react-hooks',
+            files: [GLOB_TS, GLOB_TSX],
+            plugins: {
+                'react-hooks': reactHooksPlugin,
+            },
+            rules: {
+                'react-hooks/rules-of-hooks': 'error',
+                'react-hooks/exhaustive-deps': 'warn',
+            },
+        },
+    ];
+}

package/dist/shared.d.ts

@@ -0,0 +1,23 @@
+export declare const GLOB_SRC_EXT = "?([cm])[jt]s?(x)";
+export declare const GLOB_SRC = "**/*.?([cm])[jt]s?(x)";
+export declare const GLOB_JS = "**/*.?([cm])js";
+export declare const GLOB_JSX = "**/*.?([cm])jsx";
+export declare const GLOB_TS = "**/*.?([cm])ts";
+export declare const GLOB_TSX = "**/*.?([cm])tsx";
+export declare const GLOB_TEST = "**/*.(spec|test).?([cm])[jt]s?(x)";
+export declare const GLOB_STYLE = "**/*.{c,le,sc}ss";
+export declare const GLOB_CSS = "**/*.css";
+export declare const GLOB_LESS = "**/*.less";
+export declare const GLOB_SCSS = "**/*.scss";
+export declare const GLOB_JSON = "**/*.json";
+export declare const GLOB_JSON5 = "**/*.json5";
+export declare const GLOB_JSONC = "**/*.jsonc";
+export declare const GLOB_MARKDOWN = "**/*.md";
+export declare const GLOB_VUE = "**/*.vue";
+export declare const GLOB_YAML = "**/*.y?(a)ml";
+export declare const GLOB_HTML = "**/*.htm?(l)";
+export declare const GLOB_ALL_SRC: readonly ["**/*.?([cm])[jt]s?(x)", "**/*.{c,le,sc}ss", "**/*.json", "**/*.json5", "**/*.md", "**/*.vue", "**/*.y?(a)ml", "**/*.htm?(l)"];
+export declare const GLOB_NODE_MODULES: "**/node_modules";
+export declare const GLOB_LOCKFILE: readonly ["**/package-lock.json", "**/yarn.lock", "**/pnpm-lock.yaml"];
+export declare const GLOB_EXCLUDE: readonly ["**/node_modules", "**/package-lock.json", "**/yarn.lock", "**/pnpm-lock.yaml", "**/fixtures", "**/.changeset", "**/CHANGELOG*.md", "**/*.min.*", "**/LICENSE*", "**/__snapshots__", "**/.tsup"];
+export declare const EXTENSIONS: string[];

package/dist/shared.js

@@ -0,0 +1,49 @@
+export const GLOB_SRC_EXT = '?([cm])[jt]s?(x)';
+export const GLOB_SRC = '**/*.?([cm])[jt]s?(x)';
+export const GLOB_JS = '**/*.?([cm])js';
+export const GLOB_JSX = '**/*.?([cm])jsx';
+export const GLOB_TS = '**/*.?([cm])ts';
+export const GLOB_TSX = '**/*.?([cm])tsx';
+export const GLOB_TEST = '**/*.(spec|test).?([cm])[jt]s?(x)';
+export const GLOB_STYLE = '**/*.{c,le,sc}ss';
+export const GLOB_CSS = '**/*.css';
+export const GLOB_LESS = '**/*.less';
+export const GLOB_SCSS = '**/*.scss';
+export const GLOB_JSON = '**/*.json';
+export const GLOB_JSON5 = '**/*.json5';
+export const GLOB_JSONC = '**/*.jsonc';
+export const GLOB_MARKDOWN = '**/*.md';
+export const GLOB_VUE = '**/*.vue';
+export const GLOB_YAML = '**/*.y?(a)ml';
+export const GLOB_HTML = '**/*.htm?(l)';
+export const GLOB_ALL_SRC = [
+    GLOB_SRC,
+    GLOB_STYLE,
+    GLOB_JSON,
+    GLOB_JSON5,
+    GLOB_MARKDOWN,
+    GLOB_VUE,
+    GLOB_YAML,
+    GLOB_HTML,
+];
+export const GLOB_NODE_MODULES = '**/node_modules';
+export const GLOB_LOCKFILE = [
+    '**/package-lock.json',
+    '**/yarn.lock',
+    '**/pnpm-lock.yaml',
+];
+export const GLOB_EXCLUDE = [
+    GLOB_NODE_MODULES,
+    ...GLOB_LOCKFILE,
+    '**/fixtures',
+    '**/.changeset',
+    '**/CHANGELOG*.md',
+    '**/*.min.*',
+    '**/LICENSE*',
+    '**/__snapshots__',
+    '**/.tsup',
+];
+export const EXTENSIONS = ['ts', 'js']
+    .flatMap((ext) => [ext, ext + 'x'])
+    .flatMap((ext) => [ext, 'm' + ext, 'c' + ext])
+    .flatMap((ext) => [ext, 'd.' + ext]);

package/dist/types.d.ts

@@ -0,0 +1,2 @@
+import type { Linter } from 'eslint';
+export type Config = Linter.Config;

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/dist/typescript.d.ts

@@ -0,0 +1,4 @@
+import type { Linter } from 'eslint';
+import tseslint from 'typescript-eslint';
+export { tseslint };
+export declare function typescript(): Linter.Config[];