@activescott/eslint-config 中文文档教程

Question

@activescott/eslint-config

这是 @activescott 的 ESLint 的可共享配置。 默认值针对 TypeScript 进行了优化。 它确实也美化了其他文件，包括 JavaScript、Markdown 等。

将来可能会向此包中添加多个配置，如 https://eslint.org/docs/developer-guide/shareable-configs#sharing-multiple-configs 中所述

Usage

第 1 步：将以下依赖项添加到您的项目中：

npm install --save-dev @activescott/eslint-config @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint eslint-config-prettier prettier

第 2 步：输入以下内容以在根目录中创建一个 .eslintrc.yaml 文件正确的内容：

printf "extends:\n  - \"@activescott/eslint-config\"\n" > .eslintrc.yaml
printf "semi: false\n" > .prettierrc
printf "node_modules/\n/dist/\n/.next/\n.nyc_output/\ncoverage/\n" | tee .eslintignore .prettierignore

第 3 步（可选）：将以下脚本添加到 package.json：

{
  "scripts": {
    "eslint": "./node_modules/.bin/eslint . --ext ts,tsx,js,jsx",
    "lint": "./node_modules/.bin/prettier -l \"{,!(node_modules)/**/}*.{ts,tsx,md,yml,json,html}\" && npm run eslint",
    "lint-fix": "./node_modules/.bin/prettier --write \"{,!(node_modules)/**/}*.{ts,tsx,md,yml,json,html}\" && npm run eslint --fix"
  }
}

请参阅 https://eslint.org/docs/user-guide/configuring更多信息。

Notes

React

使用 React 时，从 eslint-plugin-react 包中添加 plugin:react/recommended：

extends:
  - ...
  - "plugin:react/recommended"

Local Testing

您还可以在发布之前通过全局链接您的模块在您的计算机上测试您的可共享配置。 输入：

npm link

然后，在您想要使用可共享配置的项目中，输入：

npm link @activescott/eslint-config

Release Process (Deploying to NPM) ????

We use semantic-release发布 semver 兼容版本。 该项目部署到多个 npm 分发标签。 以下每个分支都对应于以下 npm 分发标签：

branch	npm distribution tag
master	latest
beta	beta

要触发发布，请使用 Angular Commit Message Conventions 在上述分支之一上。