@lincy/eslint-config 3.0.5 → 3.0.7

package/dist/index.d.cts

@@ -0,0 +1,149 @@
+import { FlatESLintConfigItem } from 'eslint-define-config';
+export { default as pluginAntfu } from 'eslint-plugin-antfu';
+export { default as pluginComments } from 'eslint-plugin-eslint-comments';
+export { default as pluginImport } from 'eslint-plugin-i';
+export { default as pluginJsdoc } from 'eslint-plugin-jsdoc';
+export { default as pluginJsonc } from 'eslint-plugin-jsonc';
+export { default as pluginMarkdown } from 'eslint-plugin-markdown';
+export { default as pluginNode } from 'eslint-plugin-n';
+export { default as pluginStylisticJs } from '@stylistic/eslint-plugin-js';
+export { default as pluginStylisticTs } from '@stylistic/eslint-plugin-ts';
+export { default as pluginTs } from '@typescript-eslint/eslint-plugin';
+export { default as pluginUnicorn } from 'eslint-plugin-unicorn';
+export { default as pluginUnusedImports } from 'eslint-plugin-unused-imports';
+export { default as pluginVue } from 'eslint-plugin-vue';
+export { default as pluginYml } from 'eslint-plugin-yml';
+export { default as pluginNoOnlyTests } from 'eslint-plugin-no-only-tests';
+export { default as parserTs } from '@typescript-eslint/parser';
+export { default as parserVue } from 'vue-eslint-parser';
+export { default as parserYml } from 'yaml-eslint-parser';
+export { default as parserJsonc } from 'jsonc-eslint-parser';
+
+interface OptionsComponentExts {
+    /**
+     * Additional extensions for components.
+     *
+     * @example ['vue']
+     * @default []
+     */
+    componentExts?: string[];
+}
+interface OptionsTypeScriptWithLanguageServer {
+    tsconfigPath: string;
+    tsconfigRootDir?: string;
+}
+interface OptionsHasTypeScript {
+    typescript?: boolean;
+}
+interface OptionsIsInEditor {
+    isInEditor?: boolean;
+}
+interface OptionsConfig {
+    /**
+     * Enable TypeScript support.
+     *
+     * Passing an object to enable TypeScript Language Server support.
+     *
+     * @default auto-detect based on the dependencies
+     */
+    typescript?: boolean | OptionsTypeScriptWithLanguageServer;
+    /**
+     * Enable test support.
+     *
+     * @default true
+     */
+    test?: boolean;
+    /**
+     * Enable Vue support.
+     *
+     * @default auto-detect based on the dependencies
+     */
+    vue?: boolean;
+    /**
+     * Enable JSONC support.
+     *
+     * @default true
+     */
+    jsonc?: boolean;
+    /**
+     * Enable YAML support.
+     *
+     * @default true
+     */
+    yaml?: boolean;
+    /**
+     * Enable Markdown support.
+     *
+     * @default true
+     */
+    markdown?: boolean;
+    /**
+     * Enable stylistic rules.
+     *
+     * @default true
+     */
+    stylistic?: boolean;
+    /**
+     * Control to disable some rules in editors.
+     * @default auto-detect based on the process.env
+     */
+    isInEditor?: boolean;
+}
+
+/**
+ * Construct an array of ESLint flat config items.
+ */
+declare function factoryFunc(options?: OptionsConfig, ...userConfigs: (FlatESLintConfigItem | FlatESLintConfigItem[])[]): FlatESLintConfigItem[];
+
+declare const comments: FlatESLintConfigItem[];
+
+declare const ignores: FlatESLintConfigItem[];
+
+declare const imports: FlatESLintConfigItem[];
+
+declare function javascript(options?: OptionsIsInEditor): FlatESLintConfigItem[];
+
+declare const jsdoc: FlatESLintConfigItem[];
+
+declare const jsonc: FlatESLintConfigItem[];
+
+declare function markdown(options?: OptionsComponentExts): FlatESLintConfigItem[];
+
+declare const node: FlatESLintConfigItem[];
+
+/**
+ * Sort package.json
+ *
+ * Requires `jsonc` config
+ */
+declare const sortPackageJson: FlatESLintConfigItem[];
+/**
+ * Sort tsconfig.json
+ *
+ * Requires `jsonc` config
+ */
+declare const sortTsconfig: FlatESLintConfigItem[];
+
+declare const javascriptStylistic: FlatESLintConfigItem[];
+declare const typescriptStylistic: FlatESLintConfigItem[];
+
+declare function typescript(options?: OptionsComponentExts): FlatESLintConfigItem[];
+declare function typescriptWithLanguageServer(options: OptionsTypeScriptWithLanguageServer & OptionsComponentExts): FlatESLintConfigItem[];
+
+declare const unicorn: FlatESLintConfigItem[];
+
+declare function vue(options?: OptionsHasTypeScript): FlatESLintConfigItem[];
+
+declare const yml: FlatESLintConfigItem[];
+
+declare function test(options?: OptionsIsInEditor): FlatESLintConfigItem[];
+
+/**
+ * Combine array and non-array configs into a single array.
+ */
+declare function combine(...configs: (FlatESLintConfigItem | FlatESLintConfigItem[])[]): FlatESLintConfigItem[];
+declare function renameRules(rules: Record<string, any>, from: string, to: string): {
+    [k: string]: any;
+};
+
+export { OptionsComponentExts, OptionsConfig, OptionsHasTypeScript, OptionsIsInEditor, OptionsTypeScriptWithLanguageServer, combine, comments, factoryFunc as default, factoryFunc, ignores, imports, javascript, javascriptStylistic, jsdoc, jsonc, markdown, node, renameRules, sortPackageJson, sortTsconfig, test, typescript, typescriptStylistic, typescriptWithLanguageServer, unicorn, vue, yml };

package/dist/index.js

@@ -1147,6 +1147,15 @@ function vue(options = {}) {
         "vue/html-comment-content-spacing": ["error", "always", {
           exceptions: ["-"]
         }],
+        "vue/html-self-closing": ["error", {
+          html: {
+            void: "never",
+            normal: "any",
+            component: "any"
+          },
+          svg: "always",
+          math: "always"
+        }],
         "vue/key-spacing": ["error", { afterColon: true, beforeColon: false }],
         "vue/keyword-spacing": ["error", { after: true, before: true }],
         "vue/max-attributes-per-line": OFF,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@lincy/eslint-config",
   "type": "module",
-  "version": "3.0.5",
+  "version": "3.0.7",
   "packageManager": "pnpm@8.7.6",
   "description": "LinCenYing's ESLint config",
   "author": "LinCenYing <lincenying@gmail.com> (https://github.com/lincenying/)",
@@ -10,20 +10,29 @@
   "keywords": [
     "eslint-config"
   ],
-  "main": "dist/index.js",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "dist/index.d.ts",
+      "require": "dist/index.cjs",
+      "import": "dist/index.js"
+    }
+  },
   "files": [
     "dist"
   ],
   "scripts": {
-    "build": "tsup src/index.ts --format esm --clean --dts",
-    "stub": "tsup src/index.ts --format esm --clean",
+    "build": "tsup src/index.ts --format esm,cjs --shims --clean --dts",
+    "stub": "tsup src/index.ts --format esm,cjs --shims --clean",
     "lint": "pnpm run stub && eslint .",
     "postpublish": "open https://npmmirror.com/package/@lincy/eslint-config",
     "prepublishOnly": "nr build",
     "release": "bumpp && npm publish -r --access public",
     "test": "vitest",
     "typecheck": "tsc --noEmit",
-    "prepare": "simple-git-hooks"
+    "prepare": "sh simple-git-hooks.sh"
   },
   "peerDependencies": {
     "eslint": ">=8.0.0"
@@ -36,7 +45,7 @@
     "@typescript-eslint/eslint-plugin": "^6.7.2",
     "@typescript-eslint/parser": "^6.7.2",
     "eslint-define-config": "^1.23.0",
-    "eslint-plugin-antfu": "^1.0.0-beta.2",
+    "eslint-plugin-antfu": "1.0.0-beta.3",
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-i": "^2.28.1",
     "eslint-plugin-jsdoc": "^46.8.2",
@@ -80,10 +89,10 @@
     }
   },
   "simple-git-hooks": {
-    "pre-commit": "pnpm lint-staged"
+    "pre-commit": "npx lint-staged"
   },
   "lint-staged": {
-    "*.{ts,tsx,vue}": "eslint --fix"
+    "*.{[jt]s?(x),vue,md}": "eslint --fix"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"