# sherry-standard

**Repository Path**: RememberHeart/sherry-standard

## Basic Information

- **Project Name**: sherry-standard
- **Description**: 这是一个 Web 前端项目开发规范的代码仓库，里面包含 ESLint, Prettier 和 stylelint 的配置。
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-03-13
- **Last Updated**: 2024-04-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Sherry Standard

这是一个 Web 前端项目开发规范的代码仓库，里面包含 Commitlint, ESLint, Prettier 和 Stylelint 的配置。

目前开发规范包含了：

- Commitlint 配置：`@sherry-standard/commitlint`
- ESLint 配置：`@sherry-standard/eslint-plugin`
- Prettier 的配置: `@sherry-standard/prettier`
- Vue 项目的 stylelint 配置: `@sherry-standard/stylelint`

安装配置：

- commitlint: `pnpm i eslint @sherry-standard/commitlint -D`
- eslint: `pnpm i eslint @sherry-standard/eslint-plugin -D`
- prettier: `pnpm i prettier @sherry-standard/prettier -D`
- stylelint: `pnpm i stylelint @sherry-standard/stylelint -D`

_package.json_ 里配置开发规范：

```json5
{
  /* package.json 里其它的配置 */
  "commitlint": {
    "extends": ["@sherry-standard/commitlint"]
  },
  "eslintConfig": {
    "root": true,
    "env": {
      "node": true
    },
    "plugins": [
      "@sherry-standard"
    ],
    "extends": [
      "plugin:@sherry-standard/js"
    ]
  },
  "prettier": {
    "extends": ["@sherry-standard/prettier"]
  },
  "stylelint": {
    "extends": ["@sherry-standard/stylelint"]
  }
  /* package.json 里其它的配置 */
}
```

> 注意：如果使用的是 [vscode](https://code.visualstudio.com/) 开发项目，建议在项目里单独配置 ESLint 的配置位置

ESLint 位置配置

_.vscode/settings.json_

```json5
{
  "eslint.options": {
    // ESLint 检查的文件的扩展名
    "extensions": [".js", ".jsx", ".ts", ".tsx", ".vue"],
    // ESLint 的配置所在位置
    "overrideConfigFile": "package.json"
  },
  "editor.codeActionsOnSave": {
    // 加上这个配置，将会在保存代码的时候自动根据 ESLint 规则来修复可修复的代码
    "source.fixAll.eslint": true
  }
}
```