# Web Lints Config

**Repository Path**: phoenix-tech/web-lint-config

## Basic Information

- **Project Name**: Web Lints Config
- **Description**: some practical lint configurations
- **Primary Language**: TypeScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-05-19
- **Last Updated**: 2023-02-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Web Lints Configurations

> some practical lint configurations

* eslint base configuration
* eslint typescript configuration
* stylelint base configuration

# Requirement

|  Type | File  | Deps  | Desc  |
|---|---|---|---|
|  JavaScript |  lib/eslint/base |  [eslint](https://www.npmjs.com/package/eslint)@^8.34.0 | javascript base configuration  |
|  TypeScript |  lib/eslint/typescript |  [eslint](https://www.npmjs.com/package/eslint)@^8.34.0 <br/> [@typescript-eslint/parser](https://www.npmjs.com/package/@typescript-eslint/parser)@^5.51.0 <br/> [@typescript-eslint/eslint-plugin](https://www.npmjs.com/package/@typescript-eslint/eslint-plugin)@^5.51.0 | typescript configuration  |
|  React |  lib/eslint/react |  [eslint](https://www.npmjs.com/package/eslint)@^8.34.0 <br/> [@babel/eslint-parser](https://www.npmjs.com/package/@babel/eslint-parser)@^7.19.1 <br/> [eslint-plugin-react](https://www.npmjs.com/package/eslint-plugin-react)@^7.32.2 <br/> [eslint-plugin-react-hooks](https://www.npmjs.com/package/eslint-plugin-react-hooks)@^4.6.0 | react & jsx & hooks configuration  |
|  Vue |  lib/eslint/vue |  [eslint](https://www.npmjs.com/package/eslint)@^6.8.0 <br/> [eslint-plugin-vue](https://www.npmjs.com/package/eslint-plugin-vue)@^6.1.2 <br/> [babel-eslint](https://www.npmjs.com/package/babel-eslint)@^10.0.3 | vue2 configuration  |
|  import |  lib/eslint/import |  [eslint-plugin-import](https://www.npmjs.com/package/eslint-plugin-import)@^2.27.5 | linting of ES6+ import/export syntax, and prevent issues with misspelling of file paths and import names  |
|  jsx-a11y |  lib/eslint/jsx-a11y |  [eslint-plugin-jsx-a11y](https://www.npmjs.com/package/eslint-plugin-jsx-a11y)@^6.7.1 | Static AST checker for accessibility rules on JSX elements  |
|  Stylelint |  lib/stylelint |  [stylelint](https://www.npmjs.com/package/stylelint)@^14.16.1 | stylelint configuration  |

# Use

新建本地`.eslintrc.js`或者`.stylelintrc.js`配置文件，extends lint配置。

## eslint javascript

```javascript
module.exports = {
  root: true,
  extends: [
    require.resolve("@web-io/lint-config/lib/eslint/base")
  ],
  rules: {
    // your rules
  }
};
```

## eslint typescript

```javascript
module.exports = {
  root: true,
  extends: [
    require.resolve("@web-io/lint-config/lib/eslint/typescript")
  ],
  rules: {
    // your rules
  }
};
```

## eslint react

```javascript
module.exports = {
  root: true,
  extends: [
    require.resolve("@web-io/lint-config/lib/eslint/react")
  ],
  rules: {
    // your rules
  }
};
```

## eslint vue

```javascript
module.exports = {
  root: true,
  extends: [
    require.resolve("@web-io/lint-config/lib/eslint/vue")
  ],
  rules: {
    // your rules
  }
};
```

## stylelint

```javascript
module.exports = {
  root: true,
  extends: [
    require.resolve("@web-io/lint-config/lib/stylelint")
  ],
  rules: {
    // your rules
  }
};
```

# Changelog

visit [Changelog](https://gitee.com/phoenix-tech/web-lint-config/wikis/Changelog) know more

# 参考

* [eslint-config-ali](https://www.npmjs.com/package/eslint-config-ali)
* [@umijs/fabric](https://www.npmjs.com/package/@umijs/fabric)