@ocavue/eslint-config 2.17.0 → 2.19.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 | ReactOptions
+
+  /**
+   * 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/ignores.js

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

package/dist/index.d.ts

@@ -1,6 +1,10 @@
-export * from './typescript.js';
-export * from './prettier.js';
+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

@@ -1,6 +1,30 @@
-export * from './typescript.js';
-export * from './prettier.js';
+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(trueToUndefined(resolvedOptions.react)));
+    }
+    if (resolvedOptions.vue) {
+        configs.push(...vue(trueToUndefined(resolvedOptions.vue)));
+    }
+    return defineConfig(configs);
+}
+function trueToUndefined(value) {
+    return value === true ? undefined : value;
+}

package/dist/options.d.ts

@@ -0,0 +1,44 @@
+import type { Config } from './types.js';
+export interface ESLintConfigOptions {
+    /**
+     * Whether to check code blocks in Markdown files.
+     *
+     * @default true
+     */
+    markdown?: boolean;
+    /**
+     * Whether to enable React configuration.
+     *
+     * @default false
+     */
+    react?: boolean | ReactOptions;
+    /**
+     * Whether to enable Vue configuration.
+     *
+     * @default false
+     */
+    vue?: boolean | VueOptions;
+}
+export declare function resolveOptions({ markdown, react, vue, }?: ESLintConfigOptions): Required<ESLintConfigOptions>;
+export interface ReactOptions {
+    /**
+     * The default files to lint.
+     *
+     * @default: All typescript files
+     *
+     * @see {@link Config.files}
+     */
+    files?: Config['files'];
+}
+export declare function resolveReactOptions({ files, }?: ReactOptions): Required<ReactOptions>;
+export interface VueOptions {
+    /**
+     * The default files to lint.
+     *
+     * @default: All .vue files
+     *
+     * @see {@link Config.files}
+     */
+    files?: Config['files'];
+}
+export declare function resolveVueOptions({ files, }?: VueOptions): Required<VueOptions>;

package/dist/options.js

@@ -0,0 +1,14 @@
+import { GLOB_TS, GLOB_TSX, GLOB_VUE } from './shared.js';
+export function resolveOptions({ markdown = true, react = false, vue = false, } = {}) {
+    return {
+        markdown,
+        react,
+        vue,
+    };
+}
+export function resolveReactOptions({ files = [GLOB_TS, GLOB_TSX], } = {}) {
+    return { files };
+}
+export function resolveVueOptions({ files = [GLOB_VUE], } = {}) {
+    return { files };
+}

package/dist/react.d.ts

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

package/dist/react.js

@@ -1,13 +1,14 @@
 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 || {};
+import { resolveReactOptions } from './options.js';
+export function react(options) {
+    const { files } = resolveReactOptions(options);
+    const reactRecommended = reactPlugin.configs.flat.recommended;
     return [
         {
             ...reactRecommended,
             name: 'react',
-            files: [GLOB_TS, GLOB_TSX],
+            files: files,
             settings: {
                 react: {
                     version: 'detect',
@@ -21,7 +22,7 @@ export function react() {
         },
         {
             name: 'react-hooks',
-            files: [GLOB_TS, GLOB_TSX],
+            files: files,
             plugins: {
                 'react-hooks': reactHooksPlugin,
             },

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/vue.d.ts

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

package/dist/vue.js

@@ -2,13 +2,14 @@ import prettierConfig from 'eslint-config-prettier';
 import vuePlugin from 'eslint-plugin-vue';
 import globals from 'globals';
 import tseslint from 'typescript-eslint';
-import { GLOB_VUE } from './shared.js';
-export function vue() {
+import { resolveVueOptions } from './options.js';
+export function vue(options) {
+    const { files } = resolveVueOptions(options);
     return [
         ...vuePlugin.configs['flat/recommended'],
         {
             name: 'vue:language-options',
-            files: [GLOB_VUE],
+            files: files,
             languageOptions: {
                 ecmaVersion: 'latest',
                 sourceType: 'module',

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ocavue/eslint-config",
   "type": "module",
-  "version": "2.17.0",
+  "version": "2.19.0",
   "description": "",
   "author": "ocavue <ocavue@gmail.com>",
   "license": "MIT",
@@ -31,10 +31,10 @@
     "@eslint/js": "^9.26.0",
     "@eslint/markdown": "^6.4.0",
     "eslint-config-flat-gitignore": "^2.1.0",
-    "eslint-config-prettier": "^10.1.3",
-    "eslint-import-resolver-typescript": "^4.3.4",
+    "eslint-config-prettier": "^10.1.5",
+    "eslint-import-resolver-typescript": "^4.3.5",
     "eslint-plugin-antfu": "^3.1.1",
-    "eslint-plugin-import-x": "^4.11.0",
+    "eslint-plugin-import-x": "^4.12.2",
     "eslint-plugin-no-only-tests": "^3.3.0",
     "eslint-plugin-package-json": "^0.31.0",
     "eslint-plugin-react": "^7.37.5",
@@ -42,17 +42,16 @@
     "eslint-plugin-unicorn": "^59.0.1",
     "eslint-plugin-vue": "^10.1.0",
     "globals": "^16.1.0",
-    "typescript-eslint": "^8.32.0",
+    "typescript-eslint": "^8.32.1",
     "vue-eslint-parser": "^10.1.3"
   },
   "devDependencies": {
     "@ocavue/tsconfig": "^0.3.7",
-    "@types/eslint-config-prettier": "^6.11.3",
     "@types/node": "^20.17.9",
-    "@typescript-eslint/utils": "^8.32.0",
+    "@typescript-eslint/utils": "^8.32.1",
     "eslint": "^9.26.0",
     "jiti": "^2.4.2",
-    "pkg-pr-new": "^0.0.43",
+    "pkg-pr-new": "^0.0.50",
     "prettier": "^3.5.3",
     "typescript": "^5.8.3"
   },