@dxsixpc/configs

简介

通用配置库

安装

1npm install --save-dev @dxsixpc/configs

使用

eslint

.eslintrc.js

基础配置

1module.exports = {
2  extends: [require.resolve('@dxsixpc/configs/eslint-config')],
3};

react的eslint配置

1module.exports = {
2  extends: [require.resolve('@dxsixpc/configs/eslint-config/react')],
3};

vue的eslint配置

1module.exports = {
2  extends: [require.resolve('@dxsixpc/configs/eslint-config/vue')],
3};

node的eslint配置

1module.exports = {
2  extends: [require.resolve('@dxsixpc/configs/eslint-config/node')],
3};

补充配置

1module.exports = {
2  // 由于使用了eslint-config-standard-with-typescript插件对ts的支持
3  // 部分规则需要tsconfig.json配置,需要在这里引入tsconfig.json文件
4  parserOptions: {
5    project: ['./tsconfig.json'],
6  },
7};

tsconfig.json

tsconfig.json 文件中，也需要在 include 中引入.eslintrc.js 文件

1{
2  "include": [".eslintrc.js"]
3}

prettier

.prettierrc

1'@dxsixpc/configs/prettier-config';

.prettierrc.js

1module.exports = {
2  ...require('@dxsixpc/configs/prettier-config'),
3};

stylelint

.stylelintrc

1{
2  "extends": "@dxsixpc/configs/stylelint-config"
3}

stylelint.config.js

1module.exports = { 
2  extends: ['@dxsixpc/configs/stylelint-config'],
3}

tsconfig

tsconfig.json

基础配置

1{
2  "extends": "@dxsixpc/configs/tsconfig/tsconfig.base.json",
3}

react的tsconfig配置

1{
2  "extends": "@dxsixpc/configs/tsconfig/tsconfig.react.json",
3}

vue的tsconfig配置

1{
2  "extends": "@dxsixpc/configs/tsconfig/tsconfig.vue.json",
3}

commitlint

package.json

1"scripts": {
2  "commit": "git add . && git-cz",
3},

.czrc

1{
2  "path": "@commitlint/cz-commitlint"
3}

commitlint.config.js

1module.exports = {
2  extends: ['@dxsixpc/configs/commitlint-config'],
3};

上述文件设置好后，提交代码时使用下列命令

1npm run commit

若要默认使用git cz则需全局安装相关依赖

1npm i -g commitizen  inquirer@8 @commitlint/cz-commitlint

types

types.d.ts

1// 基础配置
2/// <reference types="@dxsixpc/configs/types" />
3// react配置
4/// <reference types="@dxsixpc/configs/types/react" />
5// vue配置
6/// <reference types="@dxsixpc/configs/types/vue" />

License

MIT © dxsixpc