@ocavue/eslint-config 2.18.0 → 2.20.0

package/README.md

@@ -17,24 +17,60 @@ $ 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:
@@ -53,49 +89,56 @@ export interface ESLintConfigOptions {
    *
    * @default false
    */
-  react?: boolean
+  react?: boolean | ReactOptions
 
   /**
    * Whether to enable Vue configuration.
    *
    * @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`
-
-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
+You can pass the second and following arguments to the `defineESLintConfig` function to extend the config.
 
-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:
+```js
+// eslint.config.mjs
+import { defineESLintConfig } from '@ocavue/eslint-config'
 
-```json
-// .vscode/settings.json
-{
-  "editor.defaultFormatter": "esbenp.prettier-vscode",
-  "editor.formatOnSave": true,
-  "editor.codeActionsOnSave": {
-    "source.fixAll.eslint": "explicit"
-  }
-}
+export default defineESLintConfig(
+  {
+    // Your options here
+  },
+  // More configs here:
+  {
+    rules: {
+      '@typescript-eslint/no-explicit-any': 'off',
+    },
+  },
+  {
+    rules: {
+      'no-console': ['warn', { allow: ['warn', 'error', 'assert'] }],
+    },
+  },
+)
 ```
 
-## Alternative solutions
+## Related projects
 
 - https://github.com/antfu/eslint-config
 - https://github.com/sxzz/eslint-config

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/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,27 +1,39 @@
 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.markdown) {
+        const { markdown } = await import('./markdown.js');
         configs.push(...markdown());
     }
     if (resolvedOptions.react) {
-        configs.push(...react());
+        const { react } = await import('./react.js');
+        configs.push(...react(trueToUndefined(resolvedOptions.react)));
     }
     if (resolvedOptions.vue) {
-        configs.push(...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) {
+    return value === true ? undefined : value;
+}

package/dist/options.d.ts

@@ -1,3 +1,4 @@
+import type { Config } from './types.js';
 export interface ESLintConfigOptions {
     /**
      * Whether to check code blocks in Markdown files.
@@ -10,12 +11,46 @@ export interface ESLintConfigOptions {
      *
      * @default false
      */
-    react?: boolean;
+    react?: boolean | ReactOptions;
     /**
      * Whether to enable Vue configuration.
      *
      * @default false
      */
-    vue?: boolean;
+    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;
+}
+export declare function resolveOptions({ markdown, react, vue, unocss, command, }?: 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 resolveOptions({ markdown, react, vue, }?: ESLintConfigOptions): Required<ESLintConfigOptions>;
+export declare function resolveVueOptions({ files, }?: VueOptions): Required<VueOptions>;

package/dist/options.js

@@ -1,7 +1,16 @@
-export function resolveOptions({ markdown = true, react = false, vue = false, } = {}) {
+import { GLOB_TS, GLOB_TSX, GLOB_VUE } from './shared.js';
+export function resolveOptions({ markdown = true, react = false, vue = false, unocss = false, command = false, } = {}) {
     return {
         markdown,
         react,
         vue,
+        unocss,
+        command,
     };
 }
+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/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/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.18.0",
+  "version": "2.20.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",