0.1.2 • Published 3 years ago

mrm-task-lintformat-bxs v0.1.2

Weekly downloads
3
License
MIT
Repository
-
Last release
3 years ago

mrm-task-lintformat-bxs

基于 mrm 的配置文件自动更新任务:

  • 使用统一规则更新目标工程的 .editorConfig.eslintrc.jspackage.json/prettier 配置。
  • 清理其他格式的配置文件如 .eslintrc*.prettier*
  • eslint 规则自动应用,@vue/cli-service 项目应用 plugin:weiyi/vue-recommended 规则集,其他项目应用 plugin:weiyi/recommended(具体规则见 eslint-plugin-weiyi - npm)。
  • 自动安装所需 devDependency 并清理冲突/无用的 eslint 相关依赖。

⚠️ 注意:对应文件中原内容会被无条件覆盖。

使用

# 全局安装 mrm
npm i -g mrm
# 应用配置到工程项目
cd <project-root-dir>
mrm lintformat-bxs -i

配置详情

editorConfig

# 缩进 2 空格
indent_style = space
indent_size = 2
# lf 换行符
end_of_line = lf
# 去除行尾空白
trim_trailing_whitespace = true
# 文件末尾空一行
insert_final_newline = true
# 100 个字符触发软换行
max_line_length = 100

prettier

{
  "singleQuote": true, // 使用单引号
  "semi": false, // 不使用尾分号
  "trailingComma": "all", // 数组、对象最后一个元素也跟随逗号(git diff 友好)
  "endOfLine": "lf" // lf 换行符
}

增加 npm script

lint: eslint 检查并自动修复
format: 自动格式化。注:使用者需自行安装 prettier