开发规范开发规范
规范
教程
源代码
规范
教程
源代码
  • 基础

    • why
    • 介绍
    • 安装
    • 配置
  • 项目

    • 项目结构
    • 版本管理
    • 归档管理
    • 项目模板

配置

当你阅读到本章时,相信你已经安装好了 @sxwy/standard 相关的依赖,下面会再进行一些项目配置

配置脚本

在 package.json 文件中配置以下脚本

{
  "script": {
    "prepare": "husky install",
    "preinstall": "npx only-allow npm",
    "pre-commit": "lint-staged -p false"
  }
}

执行以下命令生成 Git 钩子

npx husky install
npx husky add .husky/pre-commit "npm run pre-commit"

配置项目

新建以下文件,并在对应文件中配置对应的内容

  • .eslintrc.js

    module.exports = {
      root: true,
      extends: ['@sxwy/eslint-config-vue/typescript'] // js or ts
    }
    
  • .stylelintrc.js

    module.exports = {
      extends: ['@sxwy/stylelint-config']
    }
    
  • .prettierrc.js

    module.exports = require('@sxwy/prettier-config')
    
  • .lintstagedrc.js

    module.exports = {
      '*': 'prettier --write --cache --ignore-unknown',
      '*.{vue,js,jsx,ts,tsx}': 'eslint --fix',
      '*.{vue,css,less,sass,scss}': 'stylelint --fix --allow-empty-input'
    }
    

至此,就完成了对应的项目配置,可以愉快的进行开发啦

Last Updated:
Contributors: chenjie