meiqia-configs 🛠📦

meiqia 前端通用规范设置

目录

• 安装
• 使用方法
  • 配置 prettier
  • 配置 eslint
  • 配置 commitlint
  • 配置 lintstaged
  • 配置 stylelint
  • 配置 postcss
  • 配置 babel

安装

$ npm install meiqia-configs -D
或
$ pnpm install meiqia-configs -D
或
$ yarn install meiqia-configs

使用方法

配置 prettier

创建一个 .prettierrc.js 文件，其内容如下：

module.exports = require('meiqia-configs/prettier');

配置 eslint

为 TypeScript React 项目配置 eslint，创建一个 .eslintrc.js 文件，其内容如下：

module.exports = require('meiqia-configs/eslint-ts');

同时创建 tsconfig.json 文件，各项目可自行配置，整体格式如下：

{
    "extends": "meiqia-configs/shared-tsconfig",
    "compilerOptions": {},
    "exclude": [],
    "include": []
}

配置 commitlint

创建一个 .commitlintrc.js 文件，内容如下：

module.exports = require('meiqia-configs/commitlint');

配置 lintstaged

创建一个 .lintstagedrc.js 文件，内容如下：

module.exports = require('meiqia-configs/lintstaged');

配置 stylelint

创建一个 .stylelintrc.js 文件，内容如下：

module.exports = require('meiqia-configs/stylelint');

配置 postcss

创建一个 postcss.config.js 文件，内容如下：

module.exports = require('meiqia-configs/postcss');

配置 babel

原有项目的 babel 可保持不变，新项目如果要在 webpack 的配置中使用 babel-loader 配置 react，创建一个 .babelrc.js 文件，内容如下：

module.exports = {
    presets: [['meiqia-configs/babel']],
};

如按上述操作后不生效，需要将项目中原本的 package.json 中有关格式化规范的依赖删除（如 eslint 等），再将 node_modules 删除，重新安装依赖再重启编辑器即可。