@ocavue/eslint-config 2.20.0 → 2.21.0

package/README.md

@@ -77,6 +77,34 @@ 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.
    *
@@ -111,6 +139,41 @@ export interface ESLintConfigOptions {
    * @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
 }
 ```
 

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/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.js

@@ -1,5 +1,4 @@
 import { defineConfig } from 'eslint/config';
-import { basic } from './basic.js';
 import { resolveOptions } from './options.js';
 export * from './basic.js';
 export * from './markdown.js';
@@ -10,7 +9,42 @@ export * from './vue.js';
 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());

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.
      *
@@ -30,8 +55,38 @@ export interface ESLintConfigOptions {
      * @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, unocss, command, }?: 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.
@@ -54,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,11 +1,20 @@
-import { GLOB_TS, GLOB_TSX, GLOB_VUE } from './shared.js';
-export function resolveOptions({ markdown = true, react = false, vue = false, unocss = false, command = 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], } = {}) {
@@ -14,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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ocavue/eslint-config",
   "type": "module",
-  "version": "2.20.0",
+  "version": "2.21.0",
   "description": "",
   "author": "ocavue <ocavue@gmail.com>",
   "license": "MIT",