@ocavue/eslint-config 2.19.0 → 2.21.0

package/README.md

@@ -17,30 +17,94 @@ $ npm install -D eslint prettier @ocavue/eslint-config
 
 ### Config ESLint
 
-You will need to use the new ["flat" ESLint configuration](https://eslint.org/docs/latest/use/configure/configuration-files-new) (i.e. `eslint.config.js`).
-
-In your `eslint.config.js` file, add the following to extend the basic config:
+Create `eslint.config.mjs` in your project root with the following content:
 
 ```js
-// eslint.config.js
+// eslint.config.mjs
 import { defineESLintConfig } from '@ocavue/eslint-config'
 
 export default defineESLintConfig()
 ```
 
-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:
+### Add script for package.json
+
+```json
+{
+  "scripts": {
+    "lint": "eslint .",
+    "check": "prettier --check .",
+    "fix": "eslint --fix . && prettier --write ."
+  }
+}
+```
+
+### Add `.prettierignore`
+
+Add a [`.prettierignore`](https://prettier.io/docs/en/ignore.html#ignoring-files-prettierignore) file in the root of your project. You can copy the `.prettierignore` file from this project.
+
+### VS Code integration
+
+If you are using VS Code, you and install [ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) and [Prettier extension](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode), then add the following to your VS Code settings:
+
+```json
+// .vscode/settings.json
+{
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.formatOnSave": true,
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "explicit"
+  }
+}
+```
+
+## Customization
+
+You can pass an optional object to the `defineESLintConfig` function to enable or disable the configs. Here is an example:
 
 ```js
-// eslint.config.js
+// eslint.config.mjs
 import { defineESLintConfig } from '@ocavue/eslint-config'
 
-export default defineESLintConfig({ react: true })
+export default defineESLintConfig({
+  // Enable React config and only apply for files under `src/react` directory.
+  react: { files: ['src/react/**/*.tsx'] },
+  // Enable Vue config.
+  vue: true,
+})
 ```
 
 The full type definition for the options is as follows:
 
 ```ts
 export interface ESLintConfigOptions {
+  /**
+   * Whether to enable [typescript-eslint](https://github.com/typescript-eslint/typescript-eslint) configuration.
+   *
+   * @default true
+   */
+  typescript?: boolean
+
+  /**
+   * Whether to enable [eslint-plugin-unicorn](https://www.npmjs.com/package/eslint-plugin-unicorn) configuration.
+   *
+   * @default true
+   */
+  unicorn?: boolean
+
+  /**
+   * Whether to enable [eslint-plugin-package-json](https://www.npmjs.com/package/eslint-plugin-package-json) configuration.
+   *
+   * @default true
+   */
+  packageJson?: boolean
+
+  /**
+   * Whether to enable [eslint-plugin-import-x](https://www.npmjs.com/package/eslint-plugin-import-x) configuration.
+   *
+   * @default true
+   */
+  imports?: boolean
+
   /**
    * Whether to check code blocks in Markdown files.
    *
@@ -60,42 +124,84 @@ export interface ESLintConfigOptions {
    *
    * @default false
    */
-  vue?: boolean
-}
-```
+  vue?: boolean | VueOptions
 
-### Add script for package.json
+  /**
+   * Whether to enable UnoCSS configuration.
+   *
+   * @default false
+   */
+  unocss?: boolean
 
-```json
-{
-  "scripts": {
-    "lint": "eslint .",
-    "check": "prettier --check .",
-    "fix": "eslint --fix . && prettier --write ."
-  }
-}
-```
+  /**
+   * Whether to enable [eslint-plugin-command](https://www.npmjs.com/package/eslint-plugin-command) configuration.
+   *
+   * @default false
+   */
+  command?: boolean
 
-### Add `.prettierignore`
+  /**
+   * Ignore some common files that should not be linted.
+   *
+   * @default true
+   */
+  ignores?: boolean | IgnoresOptions
 
-Add a [`.prettierignore`](https://prettier.io/docs/en/ignore.html#ignoring-files-prettierignore) file in the root of your project. You can copy the `.prettierignore` file from this project.
+  /**
+   * Whether to enable [eslint-config-flat-gitignore](https://www.npmjs.com/package/eslint-config-flat-gitignore) configuration.
+   *
+   * @default true
+   */
+  gitignore?: boolean | GitignoreOptions
 
-### VS Code integration
+  /**
+   * Whether to enable [eslint-plugin-antfu](https://www.npmjs.com/package/eslint-plugin-antfu) configuration.
+   *
+   * @default true
+   */
+  antfu?: boolean
 
-If you are using VS Code, you and install [ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) and [Prettier extension](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode), then add the following to your VS Code settings:
+  /**
+   * Whether to enable [eslint-plugin-no-only-tests](https://www.npmjs.com/package/eslint-plugin-no-only-tests) configuration.
+   *
+   * @default true
+   */
+  noOnlyTests?: boolean
 
-```json
-// .vscode/settings.json
-{
-  "editor.defaultFormatter": "esbenp.prettier-vscode",
-  "editor.formatOnSave": true,
-  "editor.codeActionsOnSave": {
-    "source.fixAll.eslint": "explicit"
-  }
+  /**
+   * Whether to enable [eslint-config-prettier](https://www.npmjs.com/package/eslint-config-prettier) configuration.
+   *
+   * @default true
+   */
+  prettier?: boolean
 }
 ```
 
-## Alternative solutions
+You can pass the second and following arguments to the `defineESLintConfig` function to extend the config.
+
+```js
+// eslint.config.mjs
+import { defineESLintConfig } from '@ocavue/eslint-config'
+
+export default defineESLintConfig(
+  {
+    // Your options here
+  },
+  // More configs here:
+  {
+    rules: {
+      '@typescript-eslint/no-explicit-any': 'off',
+    },
+  },
+  {
+    rules: {
+      'no-console': ['warn', { allow: ['warn', 'error', 'assert'] }],
+    },
+  },
+)
+```
+
+## Related projects
 
 - https://github.com/antfu/eslint-config
 - https://github.com/sxzz/eslint-config

package/dist/basic.js

@@ -6,9 +6,11 @@ import { packageJson } from './package-json.js';
 import { prettier } from './prettier.js';
 import { typescript } from './typescript.js';
 import { unicorn } from './unicorn.js';
+import { gitignore } from './gitignore.js';
 export function basic() {
     return [
         ...ignores(),
+        ...gitignore(),
         ...typescript(),
         ...imports(),
         ...packageJson(),

package/dist/command.d.ts

@@ -0,0 +1,2 @@
+import type { Config } from './types.js';
+export declare function command(): Config[];

package/dist/command.js

@@ -0,0 +1,4 @@
+import commandConfig from 'eslint-plugin-command/config';
+export function command() {
+    return [commandConfig()];
+}

package/dist/gitignore.d.ts

@@ -0,0 +1,3 @@
+import type { FlatGitignoreOptions as GitignoreOptions } from 'eslint-config-flat-gitignore';
+import type { Config } from './types.js';
+export declare function gitignore(options?: GitignoreOptions): Config[];

package/dist/gitignore.js

@@ -0,0 +1,4 @@
+import gitignoreConfig from 'eslint-config-flat-gitignore';
+export function gitignore(options) {
+    return [gitignoreConfig(options)];
+}

package/dist/ignores.d.ts

@@ -1,2 +1,3 @@
 import type { Linter } from 'eslint';
-export declare function ignores(): Linter.Config[];
+import { type IgnoresOptions } from './options.js';
+export declare function ignores(options?: IgnoresOptions): Linter.Config[];

package/dist/ignores.js

@@ -1,8 +1,5 @@
-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(),
-    ];
+import { resolveIgnoresOptions } from './options.js';
+export function ignores(options) {
+    const { ignores } = resolveIgnoresOptions(options);
+    return [{ name: 'ocavue/ignores', ignores }];
 }

package/dist/index.d.ts

@@ -7,4 +7,4 @@ export * from './react.js';
 export * from './typescript.js';
 export * from './vue.js';
 export type { Config, ESLintConfigOptions };
-export declare function defineESLintConfig(options?: ESLintConfigOptions): Config[];
+export declare function defineESLintConfig(options?: ESLintConfigOptions, ...userConfigs: Config[]): Promise<Config[]>;

package/dist/index.js

@@ -1,28 +1,71 @@
 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) {
+export async function defineESLintConfig(options, ...userConfigs) {
     const resolvedOptions = resolveOptions(options);
     const configs = [];
-    configs.push(...basic());
+    if (resolvedOptions.antfu) {
+        const { antfu } = await import('./antfu.js');
+        configs.push(...antfu());
+    }
+    if (resolvedOptions.noOnlyTests) {
+        const { noOnlyTests } = await import('./no-only-tests.js');
+        configs.push(...noOnlyTests());
+    }
+    if (resolvedOptions.prettier) {
+        const { prettier } = await import('./prettier.js');
+        configs.push(...prettier());
+    }
+    if (resolvedOptions.ignores) {
+        const { ignores } = await import('./ignores.js');
+        configs.push(...ignores(trueToUndefined(resolvedOptions.ignores)));
+    }
+    if (resolvedOptions.gitignore) {
+        const { gitignore } = await import('./gitignore.js');
+        configs.push(...gitignore(trueToUndefined(resolvedOptions.gitignore)));
+    }
+    if (resolvedOptions.typescript) {
+        const { typescript } = await import('./typescript.js');
+        configs.push(...typescript());
+    }
+    if (resolvedOptions.unicorn) {
+        const { unicorn } = await import('./unicorn.js');
+        configs.push(...unicorn());
+    }
+    if (resolvedOptions.packageJson) {
+        const { packageJson } = await import('./package-json.js');
+        configs.push(...packageJson());
+    }
+    if (resolvedOptions.imports) {
+        const { imports } = await import('./imports.js');
+        configs.push(...imports());
+    }
     if (resolvedOptions.markdown) {
+        const { markdown } = await import('./markdown.js');
         configs.push(...markdown());
     }
     if (resolvedOptions.react) {
+        const { react } = await import('./react.js');
         configs.push(...react(trueToUndefined(resolvedOptions.react)));
     }
     if (resolvedOptions.vue) {
+        const { vue } = await import('./vue.js');
         configs.push(...vue(trueToUndefined(resolvedOptions.vue)));
     }
+    if (resolvedOptions.unocss) {
+        const { unocss } = await import('./unocss.js');
+        configs.push(...unocss());
+    }
+    if (resolvedOptions.command) {
+        const { command } = await import('./command.js');
+        configs.push(...command());
+    }
+    configs.push(...userConfigs);
     return defineConfig(configs);
 }
 function trueToUndefined(value) {

package/dist/options.d.ts

@@ -1,5 +1,30 @@
+import type { FlatGitignoreOptions as GitignoreOptions } from 'eslint-config-flat-gitignore';
 import type { Config } from './types.js';
 export interface ESLintConfigOptions {
+    /**
+     * Whether to enable [typescript-eslint](https://github.com/typescript-eslint/typescript-eslint) configuration.
+     *
+     * @default true
+     */
+    typescript?: boolean;
+    /**
+     * Whether to enable [eslint-plugin-unicorn](https://www.npmjs.com/package/eslint-plugin-unicorn) configuration.
+     *
+     * @default true
+     */
+    unicorn?: boolean;
+    /**
+     * Whether to enable [eslint-plugin-package-json](https://www.npmjs.com/package/eslint-plugin-package-json) configuration.
+     *
+     * @default true
+     */
+    packageJson?: boolean;
+    /**
+     * Whether to enable [eslint-plugin-import-x](https://www.npmjs.com/package/eslint-plugin-import-x) configuration.
+     *
+     * @default true
+     */
+    imports?: boolean;
     /**
      * Whether to check code blocks in Markdown files.
      *
@@ -18,8 +43,50 @@ export interface ESLintConfigOptions {
      * @default false
      */
     vue?: boolean | VueOptions;
+    /**
+     * Whether to enable UnoCSS configuration.
+     *
+     * @default false
+     */
+    unocss?: boolean;
+    /**
+     * Whether to enable [eslint-plugin-command](https://www.npmjs.com/package/eslint-plugin-command) configuration.
+     *
+     * @default false
+     */
+    command?: boolean;
+    /**
+     * Ignore some common files that should not be linted.
+     *
+     * @default true
+     */
+    ignores?: boolean | IgnoresOptions;
+    /**
+     * Whether to enable [eslint-config-flat-gitignore](https://www.npmjs.com/package/eslint-config-flat-gitignore) configuration.
+     *
+     * @default true
+     */
+    gitignore?: boolean | GitignoreOptions;
+    /**
+     * Whether to enable [eslint-plugin-antfu](https://www.npmjs.com/package/eslint-plugin-antfu) configuration.
+     *
+     * @default true
+     */
+    antfu?: boolean;
+    /**
+     * Whether to enable [eslint-plugin-no-only-tests](https://www.npmjs.com/package/eslint-plugin-no-only-tests) configuration.
+     *
+     * @default true
+     */
+    noOnlyTests?: boolean;
+    /**
+     * Whether to enable [eslint-config-prettier](https://www.npmjs.com/package/eslint-config-prettier) configuration.
+     *
+     * @default true
+     */
+    prettier?: boolean;
 }
-export declare function resolveOptions({ markdown, react, vue, }?: ESLintConfigOptions): Required<ESLintConfigOptions>;
+export declare function resolveOptions({ typescript, unicorn, packageJson, imports, markdown, react, vue, unocss, command, ignores, gitignore, antfu, noOnlyTests, prettier, }?: ESLintConfigOptions): Required<ESLintConfigOptions>;
 export interface ReactOptions {
     /**
      * The default files to lint.
@@ -42,3 +109,15 @@ export interface VueOptions {
     files?: Config['files'];
 }
 export declare function resolveVueOptions({ files, }?: VueOptions): Required<VueOptions>;
+export interface IgnoresOptions {
+    /**
+     * An array of glob patterns indicating the files that the configuration
+     * object should not apply to.
+     *
+     * @default: some common files to ignore
+     *
+     * @see {@link Config.ignores}
+     */
+    ignores?: Config['ignores'];
+}
+export declare function resolveIgnoresOptions({ ignores, }?: IgnoresOptions): Required<IgnoresOptions>;

package/dist/options.js

@@ -1,9 +1,20 @@
-import { GLOB_TS, GLOB_TSX, GLOB_VUE } from './shared.js';
-export function resolveOptions({ markdown = true, react = false, vue = false, } = {}) {
+import { GLOB_EXCLUDE, GLOB_TS, GLOB_TSX, GLOB_VUE } from './shared.js';
+export function resolveOptions({ typescript = true, unicorn = true, packageJson = true, imports = true, markdown = true, react = false, vue = false, unocss = false, command = false, ignores = true, gitignore = true, antfu = true, noOnlyTests = true, prettier = true, } = {}) {
     return {
+        typescript,
+        unicorn,
+        packageJson,
+        imports,
         markdown,
         react,
         vue,
+        unocss,
+        command,
+        ignores,
+        gitignore,
+        antfu,
+        noOnlyTests,
+        prettier,
     };
 }
 export function resolveReactOptions({ files = [GLOB_TS, GLOB_TSX], } = {}) {
@@ -12,3 +23,6 @@ export function resolveReactOptions({ files = [GLOB_TS, GLOB_TSX], } = {}) {
 export function resolveVueOptions({ files = [GLOB_VUE], } = {}) {
     return { files };
 }
+export function resolveIgnoresOptions({ ignores = [...GLOB_EXCLUDE], } = {}) {
+    return { ignores };
+}

package/dist/unocss.d.ts

@@ -0,0 +1,2 @@
+import type { Config } from './types.js';
+export declare function unocss(): Config[];

package/dist/unocss.js

@@ -0,0 +1,5 @@
+import unocssConfig from '@unocss/eslint-config/flat';
+export function unocss() {
+    // @ts-expect-error: unmatched types
+    return [unocssConfig];
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ocavue/eslint-config",
   "type": "module",
-  "version": "2.19.0",
+  "version": "2.21.0",
   "description": "",
   "author": "ocavue <ocavue@gmail.com>",
   "license": "MIT",
@@ -30,10 +30,12 @@
   "dependencies": {
     "@eslint/js": "^9.26.0",
     "@eslint/markdown": "^6.4.0",
+    "@unocss/eslint-config": "^66.1.2",
     "eslint-config-flat-gitignore": "^2.1.0",
     "eslint-config-prettier": "^10.1.5",
     "eslint-import-resolver-typescript": "^4.3.5",
     "eslint-plugin-antfu": "^3.1.1",
+    "eslint-plugin-command": "^3.2.0",
     "eslint-plugin-import-x": "^4.12.2",
     "eslint-plugin-no-only-tests": "^3.3.0",
     "eslint-plugin-package-json": "^0.31.0",