eslint-config-tdym

背景

• 核心库：Vue
• 命令行工具: vue-cli
• 代码检查：eslint
• 格式化工具：prettier

我们的目标是：帮助团队在协作开发时保持代码规范与代码风格的一致性。通过配置化、工具化，更方便的共享经验，新加入的成员不用死背规范，更易于上手。经过多个项目的实践，我们结合社区方案与自身需求，针对 Vue 开发中的一些经验进行了归纳总结，并创建了此项目。

版本依赖

• eslint ^5.16.0 || ^6.1.0
• prettier >= 1.13.0

用法

安装依赖包以及上述版本依赖

yarn add eslint-config-tdym -D
# or
npm install eslint-config-tdym -D

添加 prettier 配置项

在项目根目录中，添加 .prettierrc 文件，配置如下：

{
  "singleQuote": true,
  "semi": false,
  "trailingComma": "all",
  "arrowParens": "always",
  "htmlWhitespaceSensitivity": "ignore"
}

• singleQuote: 在 js 中使用单引号风格、html 或 vue 模板中使用双引号；两者混用时不易产生混淆。
• semi: 做一个无分号党。
• trailingComma: 对 git diff 友好，编码体验友好。
• arrowParens: 总是带括号，方便增减参数、或解构。
• htmlWhitespaceSensitivity: 参考issue#6061。

添加 git 配置项

在项目中根目录中，添加 .gitattributes 文件，配置如下：

* text=auto eol=lf

配置说明

实现初衷是希望最大程度的使用社区稳定的方案，减少维护和沟通成本，如下：

• airbnb javascript 风格指南
• vue 风格指南
• prettier 风格指南

推荐配置

const isProduction = process.env.NODE_ENV === 'production'

module.exports = {
  root: true,
  extends: ['eslint-config-tdym'],
  rules: {
    'no-console': isProduction ? 'warn' : 'off',
    'no-debugger': isProduction ? 'warn' : 'off',
  },
}