# plugin-config-lint

**Repository Path**: yangliying/plugin-config-lint

## Basic Information

- **Project Name**: plugin-config-lint
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-03-26
- **Last Updated**: 2024-04-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ss-config

## 介绍

公共配置包

- [eslint-react-js](#eslint-react-js)
- [eslint-react-ts](#eslint-react-ts)
- [eslint-vue-js](#eslint-vue-js)
- [eslint-vue-ts](#eslint-vue-ts)
- [prettier](#prettier)
- [stylelint-react](#stylelint-react)
- [stylelint-vue](#stylelint-vue)
- [commitlint](#commitlint)
- [typescript-react](#ts-react)
- [typescript-vue](#ts-vue)

## 安装教程

```sh
npm install -D ss-config
```

## 使用说明

### Eslint

#### eslint-react-js

```js
// .eslintrc.js
module.exports = {
  extends: [require.resolve("ss-config/lib/eslint/js/react-config")],
};
```

#### eslint-react-ts

```js
// .eslintrc.js
module.exports = {
  extends: [require.resolve("ss-config/lib/eslint/ts/react-config")],
};
```

可扩展rules规则

```json
{
  "rules": {
    "@typescript-eslint/no-explicit-any": "error"
    //...
  }
}
```

#### eslint-vue-js
```js
// .eslintrc.js
module.exports = {
  extends: [require.resolve("ss-config/lib/eslint/js/vue-config")],
};
```

#### eslint-vue-ts

```js
// .eslintrc.js
module.exports = {
  extends: [require.resolve("ss-config/lib/eslint/ts/vue-config")],
};
```

可扩展rules规则

```json
{
  "rules": {
    "@typescript-eslint/no-explicit-any": "error"
    //...
  }
}
```

### Prettier

```js
// .prettierrc.js
const prettier = require("ss-config/lib/stylelint");

module.exports = {
  ...prettier,
};
```

### Stylelint

#### stylelint-react

```js
//stylelint.config.js
module.exports = {
  extends: [require.resolve("ss-config/lib/stylelint/react-config")],
};
```

可扩展rules规则

```json
{
  "rules": {
    "color-no-invalid-hex": null
  }
}
```

#### stylelint-vue

```js
//stylelint.config.js
module.exports = {
  extends: [require.resolve("ss-config/lib/stylelint/vue-config")],
};
```

可扩展rules规则

```json
{
  "rules": {
    "color-no-invalid-hex": null
  }
}
```

## Commitlint

```js
// commitlint.config.js
module.exports = {
  extends: [require.resolve("ss-config/lib/commitlint")],
};
```

<!-- ## Typescript
### ts-react
```json
// tsconfig.json
{
  "extends": "ss-config/lib/tsconfig/react-config.json",
}
```

### ts-vue
```json
// tsconfig.json
{
  "extends": "ss-config/lib/tsconfig/vue-config.json",
}
``` -->

### scripts-参考

```json
{
  "scripts": {
    "lint": "eslint \"./src/**/*.{ts,tsx}\"",
    "fix": "eslint \"./src/**/*.{ts,tsx}\" --fix",
    "lint:prettier": "prettier -c --write \"**/**.{js,jsx,tsx,ts,less,md,json}\" --end-of-line auto",
    "lint:style": "stylelint \"./src/**/*.{css,scss,less}\""
  }
}
```

## 参考

- [eslint规则参考](https://eslint.nodejs.cn/docs/latest/rules/)
- [stylelint规则参考](https://stylelint.io/user-guide/rules/)
- [prettier规则参考](https://prettier.io/docs/en/options.html)
- [commitlint规则参考](https://commitlint.js.org/#/reference-rules)