@vida0905/eslint-config 0.2.0 → 0.4.0

package/README.md

@@ -8,7 +8,7 @@ Self use eslint config, extends [antfu's config](https://github.com/antfu/eslint
 
 - More stricter rules.
 - Support `pinia`.
-- Disable `formatter` and `jsx`
+- Disable `jsx` by default.
 
 ### Setup
 
@@ -19,9 +19,9 @@ npm i -D @vida/eslint-config
 in `eslint.config.js`
 
 ```js
-import { vida } from '@vida0905/eslint-config';
+import { vida } from '@vida0905/eslint-config'
 
-export default vida();
+export default vida()
 ```
 
 in `.vscode/settings.json`, more info to [@antfu/eslint-config](https://github.com/antfu/eslint-config?tab=readme-ov-file#vs-code-support-auto-fix-on-save)

package/dist/index.d.ts

@@ -1,18 +1,76 @@
 import * as eslint_flat_config_utils from 'eslint-flat-config-utils';
 import * as _antfu_eslint_config from '@antfu/eslint-config';
-import { antfu, TypedFlatConfigItem } from '@antfu/eslint-config';
+import { antfu, TypedFlatConfigItem as TypedFlatConfigItem$1 } from '@antfu/eslint-config';
 export * from '@antfu/eslint-config';
+import { Linter } from 'eslint';
+
+/* eslint-disable */
+/* prettier-ignore */
+
+
+interface RuleOptions {
+  /**
+   * Never export an initialized named or default store.
+   * @see https://github.com/lisilinhart/eslint-plugin-pinia/blob/main/docs/rules/never-export-initialized-store.md
+   */
+  'pinia/never-export-initialized-store'?: Linter.RuleEntry<[]>
+  /**
+   * Disallow duplicate store ids.
+   * @see https://github.com/lisilinhart/eslint-plugin-pinia/blob/main/docs/rules/no-duplicate-store-ids.md
+   */
+  'pinia/no-duplicate-store-ids'?: Linter.RuleEntry<[]>
+  /**
+   * Disallows returning globally provided properties from Pinia stores.
+   * @see https://github.com/lisilinhart/eslint-plugin-pinia/blob/main/docs/rules/no-return-global-properties.md
+   */
+  'pinia/no-return-global-properties'?: Linter.RuleEntry<[]>
+  /**
+   * Encourages defining each store in a separate file.
+   * @see https://github.com/lisilinhart/eslint-plugin-pinia/blob/main/docs/rules/prefer-single-store-per-file.md
+   */
+  'pinia/prefer-single-store-per-file'?: Linter.RuleEntry<[]>
+  /**
+   * Enforces the convention of naming stores with the prefix `use` followed by the store name.
+   * @see https://github.com/lisilinhart/eslint-plugin-pinia/blob/main/docs/rules/prefer-use-store-naming-convention.md
+   */
+  'pinia/prefer-use-store-naming-convention'?: Linter.RuleEntry<PiniaPreferUseStoreNamingConvention>
+  /**
+   * In setup stores all state properties must be exported.
+   * @see https://github.com/lisilinhart/eslint-plugin-pinia/blob/main/docs/rules/require-setup-store-properties-export.md
+   */
+  'pinia/require-setup-store-properties-export'?: Linter.RuleEntry<[]>
+}
+
+/* ======= Declarations ======= */
+// ----- pinia/prefer-use-store-naming-convention -----
+type PiniaPreferUseStoreNamingConvention = []|[{
+  checkStoreNameMismatch?: boolean
+  storeSuffix?: string
+  [k: string]: unknown | undefined
+}]
 
 type AntfuOptions = Parameters<typeof antfu>[0];
-type OptionsConfig = AntfuOptions & {
+type Rules = RuleOptions;
+type TypedFlatConfigItem = Omit<Linter.FlatConfig<Linter.RulesRecord & Rules>, 'plugins'> & {
+    /**
+     * An object containing a name-value mapping of plugin names to plugin objects. When `files` is specified, these plugins are only available to the matching files.
+     *
+     * @see [Using plugins in your configuration](https://eslint.org/docs/latest/user-guide/configuring/configuration-files-new#using-plugins-in-your-configuration)
+     */
+    plugins?: Record<string, any>;
+};
+interface OptionsOverrides {
+    overrides?: TypedFlatConfigItem['rules'];
+}
+type OptionsConfig = Omit<AntfuOptions, 'overrides'> & {
     /**
      * Enable Pinia support.
      *
      * @default auto-detect based on the dependencies
      */
-    pinia?: boolean;
+    pinia?: boolean | OptionsOverrides;
 };
 
-declare function vida(options?: OptionsConfig, ...userConfigs: TypedFlatConfigItem[]): eslint_flat_config_utils.FlatConfigComposer<TypedFlatConfigItem, _antfu_eslint_config.ConfigNames>;
+declare function vida(options?: OptionsConfig & TypedFlatConfigItem$1, ...userConfigs: TypedFlatConfigItem$1[]): eslint_flat_config_utils.FlatConfigComposer<TypedFlatConfigItem$1, _antfu_eslint_config.ConfigNames>;
 
 export { vida as default, vida };

package/dist/index.js

@@ -1,30 +1,37 @@
 // src/index.ts
-import antfu from "@antfu/eslint-config";
+import antfu, { resolveSubOptions } from "@antfu/eslint-config";
 import { isPackageExists } from "local-pkg";
 
 // src/configs/pinia.ts
-import { GLOB_JS, GLOB_TS } from "@antfu/eslint-config";
-import pluginPinia from "eslint-plugin-pinia";
-var GLOB_PINIA_JS = `stores/${GLOB_JS}`;
-var GLOB_PINIA_TS = `stores/${GLOB_TS}`;
-var pinia = [
-  {
-    name: "vida/pinia",
-    files: [GLOB_PINIA_JS, GLOB_PINIA_TS],
-    plugins: {
-      pinia: pluginPinia
-    },
-    rules: {
-      "pinia/prefer-single-store-per-file": ["error"],
-      "pinia/prefer-use-store-naming-convention": ["error", {
-        checkStoreNameMismatch: true,
-        storeSuffix: "Store"
-      }],
-      "pinia/require-setup-store-properties-export": ["warn"],
-      "pinia/no-duplicate-store-ids": ["error"]
+import { GLOB_JS, GLOB_TS, interopDefault } from "@antfu/eslint-config";
+var GLOB_PINIA_JS = `**/stores/${GLOB_JS}`;
+var GLOB_PINIA_TS = `**/stores/${GLOB_TS}`;
+async function pinia(options = {}) {
+  const {
+    files = [GLOB_PINIA_JS, GLOB_PINIA_TS],
+    overrides = {}
+  } = options;
+  return [
+    {
+      name: "@vida/pinia",
+      files,
+      plugins: {
+        pinia: await interopDefault(import("eslint-plugin-pinia"))
+      },
+      rules: {
+        "pinia/never-export-initialized-store": "error",
+        "pinia/prefer-single-store-per-file": "warn",
+        "pinia/prefer-use-store-naming-convention": ["error", {
+          checkStoreNameMismatch: true,
+          storeSuffix: "Store"
+        }],
+        "pinia/require-setup-store-properties-export": "warn",
+        "pinia/no-duplicate-store-ids": "error",
+        ...overrides
+      }
     }
-  }
-];
+  ];
+}
 
 // src/overrides/javascript.ts
 var javascript = {
@@ -49,7 +56,7 @@ function vida(options = {}, ...userConfigs) {
   } = options;
   const configs = [];
   if (enablePinia)
-    configs.push(pinia);
+    configs.push(pinia(resolveSubOptions(options, "pinia")));
   const antfuConfig = {
     stylistic: {
       indent: 2,

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@vida0905/eslint-config",
   "type": "module",
-  "version": "0.2.0",
-  "packageManager": "pnpm@9.1.2",
+  "version": "0.4.0",
+  "packageManager": "pnpm@9.5.0",
   "description": "Vida Xie's ESLint Config",
   "author": "Vida Xie <vida_2020@163.com> (https://github.com/9romise/)",
   "license": "MIT",
@@ -33,21 +33,47 @@
     "lint:fix": "eslint . --fix",
     "dev": "tsup --watch",
     "inspect": "npx @eslint/config-inspector",
-    "build": "tsup",
+    "typegen": "tsx scripts/typegen",
+    "build": "npm run typegen && tsup",
     "release": "npm run lint && npm run typecheck && bumpp",
     "typecheck": "tsc --noEmit",
-    "prepublish": "npm run build"
+    "prepack": "npm run build",
+    "prepare": "simple-git-hooks"
+  },
+  "peerDependencies": {
+    "@unocss/eslint-plugin": ">=0.50.0",
+    "eslint": ">=8.40.0",
+    "eslint-plugin-format": ">=0.1.0"
+  },
+  "peerDependenciesMeta": {
+    "@unocss/eslint-plugin": {
+      "optional": true
+    },
+    "eslint-plugin-format": {
+      "optional": true
+    }
   },
   "dependencies": {
-    "@antfu/eslint-config": "^2.18.1",
-    "eslint-plugin-pinia": "^0.1.13",
+    "@antfu/eslint-config": "^2.22.4",
+    "eslint-plugin-pinia": "^0.2.0",
     "local-pkg": "^0.5.0"
   },
   "devDependencies": {
-    "@eslint/config-inspector": "^0.4.8",
+    "@eslint/config-inspector": "^0.5.1",
+    "@types/node": "^20.14.11",
     "bumpp": "^9.4.1",
-    "eslint": "^9.3.0",
-    "tsup": "^8.0.2",
-    "typescript": "^5.4.5"
+    "eslint": "^9.7.0",
+    "eslint-typegen": "^0.2.4",
+    "lint-staged": "^15.2.7",
+    "simple-git-hooks": "^2.11.1",
+    "tsup": "^8.1.0",
+    "tsx": "^4.16.2",
+    "typescript": "^5.5.3"
+  },
+  "simple-git-hooks": {
+    "pre-commit": "npx lint-staged"
+  },
+  "lint-staged": {
+    "*": "eslint --fix"
   }
 }

package/dist/index.cjs

@@ -1,121 +0,0 @@
-"use strict";
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/index.ts
-var src_exports = {};
-__export(src_exports, {
-  default: () => src_default,
-  vida: () => vida
-});
-module.exports = __toCommonJS(src_exports);
-var import_eslint_config2 = __toESM(require("@antfu/eslint-config"), 1);
-var import_local_pkg = require("local-pkg");
-
-// src/configs/pinia.ts
-var import_eslint_config = require("@antfu/eslint-config");
-var import_eslint_plugin_pinia = __toESM(require("eslint-plugin-pinia"), 1);
-var GLOB_PINIA_JS = `stores/${import_eslint_config.GLOB_JS}`;
-var GLOB_PINIA_TS = `stores/${import_eslint_config.GLOB_TS}`;
-var pinia = [
-  {
-    name: "vida/pinia",
-    files: [GLOB_PINIA_JS, GLOB_PINIA_TS],
-    plugins: {
-      pinia: import_eslint_plugin_pinia.default
-    },
-    rules: {
-      "pinia/prefer-single-store-per-file": ["error"],
-      "pinia/prefer-use-store-naming-convention": ["error", {
-        checkStoreNameMismatch: true,
-        storeSuffix: "Store"
-      }],
-      "pinia/require-setup-store-properties-export": ["warn"],
-      "pinia/no-duplicate-store-ids": ["error"]
-    }
-  }
-];
-
-// src/overrides/javascript.ts
-var javascript = {
-  "arrow-body-style": ["error", "as-needed"],
-  "no-unused-private-class-members": "error",
-  "require-atomic-updates": ["error", { allowProperties: true }]
-};
-
-// src/overrides/vue.ts
-var vue = {
-  "vue/max-attributes-per-line": ["error", {
-    singleline: 5,
-    multiline: 1
-  }]
-};
-
-// src/index.ts
-__reExport(src_exports, require("@antfu/eslint-config"), module.exports);
-function vida(options = {}, ...userConfigs) {
-  const {
-    pinia: enablePinia = (0, import_local_pkg.isPackageExists)("pinia")
-  } = options;
-  const configs = [];
-  if (enablePinia)
-    configs.push(pinia);
-  const antfuConfig = {
-    stylistic: {
-      indent: 2,
-      quotes: "single",
-      semi: false,
-      overrides: {
-        "style/arrow-parens": ["error", "always"],
-        "style/brace-style": ["error", "1tbs", { allowSingleLine: true }]
-      }
-    },
-    javascript: {
-      overrides: javascript
-    },
-    vue: {
-      overrides: vue
-    },
-    jsx: false
-  };
-  return (0, import_eslint_config2.default)(
-    {
-      ...antfuConfig,
-      ...options
-    },
-    ...configs,
-    ...userConfigs
-  );
-}
-var src_default = vida;
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  vida,
-  ...require("@antfu/eslint-config")
-});

package/dist/index.d.cts

@@ -1,18 +0,0 @@
-import * as eslint_flat_config_utils from 'eslint-flat-config-utils';
-import * as _antfu_eslint_config from '@antfu/eslint-config';
-import { antfu, TypedFlatConfigItem } from '@antfu/eslint-config';
-export * from '@antfu/eslint-config';
-
-type AntfuOptions = Parameters<typeof antfu>[0];
-type OptionsConfig = AntfuOptions & {
-    /**
-     * Enable Pinia support.
-     *
-     * @default auto-detect based on the dependencies
-     */
-    pinia?: boolean;
-};
-
-declare function vida(options?: OptionsConfig, ...userConfigs: TypedFlatConfigItem[]): eslint_flat_config_utils.FlatConfigComposer<TypedFlatConfigItem, _antfu_eslint_config.ConfigNames>;
-
-export { vida as default, vida };