@lincy/eslint-config 2.5.3 → 3.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019-PRESENT Anthony Fu<https://github.com/antfu>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,22 +1,253 @@
 # @lincy/eslint-config
 
-A set of opinionated ESLint (http://eslint.org) rules (all rules included) tailored for Vue.js projects
+[![npm](https://img.shields.io/npm/v/@lincy/eslint-config?color=444&label=)](https://npmjs.com/package/@lincy/eslint-config)
 
-自动区分vue2和vue3的规则
-如果依赖安装了 typescript, 则自动应用 ts 的规则
-如果依赖安装了 prettier, 则自动应用 prettier 的规则
+- 单引号，无结尾分号
+- 自动格式化
+- 专为与 TypeScript、Vue(2/3) 一起使用而设计，开箱即用
+- Lint 也适用于 json、yaml、markdown
+- import导入排序, 对象字⾯量项尾逗号
+- 合理的默认值，最佳实践，只需一行配置
+- [ESLint Flat config](https://eslint.org/docs/latest/use/configure/configuration-files-new)
+- 使用 [ESLint Stylistic](https://github.com/eslint-stylistic/eslint-stylistic)
+- **风格原则**: 读取最小，差异稳定
 
-Usage
+## Usage
 
-- pnpm install -D eslint @lincy/eslint-config
-- create a file named .eslintrc in your project:
+### Install
+
+```bash
+pnpm add -D eslint @lincy/eslint-config
+```
+
+### Create config file
+
+```js
+// eslint.config.js
+import eslintConfig from '@lincy/eslint-config'
+
+export default eslintConfig()
+```
+
+> 通常您不需要`.eslintignore`，因为它已由预设提供。
+
+### Add script for package.json
+
+For example:
+
+```json
+{
+  "scripts": {
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix"
+  }
+}
+```
+
+## VS Code support (auto fix)
+
+安装[VS Code ESLint扩展](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
+
+将以下设置添加到您的“settings.json”：
+
+```jsonc
+{
+  // Enable the flat config support
+  "eslint.experimental.useFlatConfig": true,
+
+  // Disable the default formatter
+  "prettier.enable": false,
+  "editor.formatOnSave": false,
+
+  // Auto fix
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": true,
+    "source.organizeImports": false
+  },
+
+  // Silent the stylistic rules in you IDE, but still auto fix them
+  "eslint.rules.customizations": [
+    { "rule": "@stylistic/*", "severity": "off" },
+    { "rule": "*-indent", "severity": "off" },
+    { "rule": "*-spacing", "severity": "off" },
+    { "rule": "*-spaces", "severity": "off" },
+    { "rule": "*-order", "severity": "off" },
+    { "rule": "*-dangle", "severity": "off" },
+    { "rule": "*-newline", "severity": "off" },
+    { "rule": "*quotes", "severity": "off" },
+    { "rule": "*semi", "severity": "off" }
+  ],
+
+  // The following is optional.
+  // It's better to put under project setting `.vscode/settings.json`
+  // to avoid conflicts with working with different eslint configs
+  // that does not support all formats.
+  "eslint.validate": [
+    "javascript",
+    "javascriptreact",
+    "typescript",
+    "typescriptreact",
+    "vue",
+    "html",
+    "markdown",
+    "json",
+    "jsonc",
+    "yaml"
+  ]
+}
+```
+
+## 定制化
+
+通常你只需要导入 `eslintConfig` 预设：
+
+```js
+// eslint.config.js
+import eslintConfig from '@lincy/eslint-config'
+
+export default eslintConfig()
+```
+
+您可以单独配置每个功能，例如：
+
+```js
+// eslint.config.js
+import eslintConfig from '@lincy/eslint-config'
+
+export default eslintConfig({
+  stylistic: true, // enable stylistic formatting rules
+  typescript: true,
+  vue: true,
+  jsonc: false,
+  yml: false,
+})
+```
+
+`eslintConfig` 工厂函数还接受任意数量的自定义配置覆盖：
+
+```js
+// eslint.config.js
+import eslintConfig from '@lincy/eslint-config'
+
+export default eslintConfig(
+  {
+    // Configures for config
+  },
+
+  // From the second arguments they are ESLint Flat Configs
+  // you can have multiple configs
+  {
+    rules: {},
+  },
+  {
+    rules: {},
+  },
+)
+```
+
+更高级的是，您还可以导入非常细粒度的配置并根据需要组合它们：
+
+```js
+// eslint.config.js
+import {
+  comments,
+  ignores,
+  imports,
+  javascript,
+  javascriptStylistic,
+  jsdoc,
+  jsonc,
+  markdown,
+  node,
+  sortPackageJson,
+  sortTsconfig,
+  typescript,
+  typescriptStylistic,
+  unicorn,
+  vue,
+  yml,
+} from '@lincy/eslint-config'
+
+export default [
+  ...ignores,
+  ...javascript(),
+  ...comments,
+  ...node,
+  ...jsdoc,
+  ...imports,
+  ...unicorn,
+  ...javascriptStylistic,
+
+  ...typescript(),
+  ...typescriptStylistic,
+
+  ...vue(),
+  ...jsonc,
+  ...yml,
+  ...markdown(),
+]
 ```
+
+查看 [configs](https://github.com/lincenying/eslint-config/blob/main/src/configs) 和 [factory](https://github.com/lincenying/eslint-config/blob/ main/src/factory.ts）了解更多详细信息。
+
+> Thanks to [sxzz/eslint-config](https://github.com/sxzz/eslint-config) for the inspiration and reference.
+
+## Plugins Renaming
+
+由于平面配置支持显式提供了插件名称，因此我们重命名了一些插件以使它们更加一致并隐藏实现细节。
+
+| Original Prefix | New Prefix | Source Plugin |
+| --------------- | ---------- | ------------- |
+| `i/*` | `import/*` | [eslint-plugin-i](https://github.com/un-es/eslint-plugin-i) |
+| `n/*` | `node` | [eslint-plugin-n](https://github.com/eslint-community/eslint-plugin-n)
+| `@typescript-eslint/*` | `ts/*` | [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint) |
+| `@stylistic/js` | `style/*` | [@stylistic/eslint-plugin-js](https://github.com/eslint-stylistic/eslint-stylistic) |
+| `@stylistic/ts` | `style-ts/` | [@stylistic/eslint-plugin-ts](https://github.com/eslint-stylistic/eslint-stylistic) |
+
+当您想要覆盖规则或内联禁用它们时，您需要更新到新的前缀：
+
+```diff
+-// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
++// eslint-disable-next-line ts/consistent-type-definitions
+type foo = { bar: 2 }
+```
+
+### Type Aware Rules
+
+您可以选择通过将选项对象传递给“typescript”配置来启用[类型感知规则](https://typescript-eslint.io/linting/typed-linting/)：
+
+```js
+// eslint.config.js
+import eslintConfig from '@lincy/eslint-config'
+
+export default eslintConfig({
+  typescript: {
+    tsconfigPath: 'tsconfig.json',
+  },
+})
+```
+
+### Lint Staged
+
+如果你想在每次提交之前应用 lint 和自动修复，你可以将以下内容添加到你的 `package.json` 中：
+
+```json
 {
-  "extends": "@lincy"
-  // Your overrides...
+  "simple-git-hooks": {
+    "pre-commit": "pnpm lint-staged"
+  },
+  "lint-staged": {
+    "*": "eslint --fix"
+  }
 }
 ```
 
-License
+然后
+
+```bash
+npm i -D lint-staged simple-git-hooks
+```
+
+## License
 
-MIT
+[MIT]

package/dist/index.d.ts

@@ -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 };