游戏网站建设与策划方案,做网站 收费,免费cms网站,可以打开的wap网站欲先善其事,必先利其器。一个好的项目是必须要有一个统一的规范,比如代码规范,样式规范以及代码提交规范等。统一的代码规范旨在增强团队开发协作、提高代码质量和打造开发基石,所以每个人必须严格遵守。 本篇文章将引入 ESLintPrettierStylelint 来对代码规范化。
ESlint
ES…欲先善其事,必先利其器。一个好的项目是必须要有一个统一的规范,比如代码规范,样式规范以及代码提交规范等。统一的代码规范旨在增强团队开发协作、提高代码质量和打造开发基石,所以每个人必须严格遵守。 本篇文章将引入 ESLintPrettierStylelint 来对代码规范化。
ESlint
ESLint 是在ECMAScript/JavaScript代码中识别和报告模式匹配的工具它的目标是保证代码的一致性和避免错误,我们来看一下如何在我们的项目中使用它 首先安装 ESLint
pnpm add eslint -D -w初始化 ESLint
pnpm create eslint/config此时会出现一些选项让我们选择,如下 因为我们使用的是 pnpm,所以选择安装那些插件的时候我们选择了 No,这里我们用 pnpm 手动安装一下
pnpm i eslint-plugin-vuelatest typescript-eslint/eslint-pluginlatest typescript-eslint/parserlatest -D -w此时我们会发现根目录出现了 ESlint 的配置文件.eslintrc.cjs,我们对这个文件进行了一些配置上的修改后如下
module.exports {env: {browser: true,es2021: true,node: true},extends: [eslint:recommended,plugin:vue/vue3-essential,plugin:typescript-eslint/recommended],globals: {defineOptions: true},parser: vue-eslint-parser,parserOptions: {ecmaVersion: latest,sourceType: module,parser: typescript-eslint/parser},plugins: [vue, typescript-eslint],rules: {typescript-eslint/ban-ts-comment: off,vue/multi-word-component-names: off}
};同时我们新建.eslintignore来忽略一些文件的校验
**.d.ts
/packages/easyest
dist
node_modules然后我们在 package.json 的 script 中添加命令 lint:script scripts: {lint:script: eslint --ext .js,.jsx,.vue,.ts,.tsx --fix --quiet ./},然后执行pnpm run lint:script就能看到一些不规范的地方,现在肯定会有小伙伴问为什么不能保存的时候自动格式化呢,别急,下面会提到如何保存自动格式化。
集成 Prettier
其实只有 ESlint 是完全不够的, ESLint 经常结合 Prettier 一起使用才能体现它们的能力,Prettier 主要是对代码做格式化,接下来我们看下如何将两者结合起来
同样的先安装Prettier
pnpm add prettier -D -w新建文件.prettierrc.cjs
module.exports {printWidth: 80, //一行的字符数如果超过会进行换行默认为80tabWidth: 2, // 一个 tab 代表几个空格数默认为 2 个useTabs: false, //是否使用 tab 进行缩进默认为false表示用空格进行缩减singleQuote: true, // 字符串是否使用单引号默认为 false使用双引号semi: true, // 行尾是否使用分号默认为truetrailingComma: none, // 是否使用尾逗号bracketSpacing: true // 对象大括号直接是否有空格默认为 true效果{ a: 1 }
};安装 eslint-config-prettier(覆盖 eslint 本身规则)和 eslint-plugin-prettier(Prettier 来接管 eslint --fix 即修复代码的能力)
pnpm add eslint-config-prettier eslint-plugin-prettier -D -w配置.eslintrc.cjs,新增的部分加了注释(注意配置完后将 VSCode 格式化文档默认选择 prettier)
module.exports {env: {browser: true,es2021: true,node: true},extends: [eslint:recommended,plugin:vue/vue3-essential,plugin:typescript-eslint/recommended,// 1. 接入 prettier 的规则prettier,plugin:prettier/recommended],globals: {defineOptions: true},parser: vue-eslint-parser,parserOptions: {ecmaVersion: latest,sourceType: module,parser: typescript-eslint/parser},plugins: [vue, typescript-eslint],rules: {// 2. 开启 prettier 自动修复的功能prettier/prettier: error,typescript-eslint/ban-ts-comment: off,vue/multi-word-component-names: off}
};最后执行 pnpm run lint:script即可完成 ESLint 规则校验检查以及 Prettier 的自动修复 我们通常希望在保存代码的时候编辑器就能给我们自动格式化修复,VSCode 就可以做到,只需要一个简单的配置即可,在设置里搜索如下图所示配置 这样设置完后按ctrls就能自动格式化代码了。
到这里 ESlintPrettier 已经配置完毕,接下来再给项目引入 Stylelint(样式规范工具)
Stylelint
首先安装一些插件链
pnpm add stylelint stylelint-prettier stylelint-config-standard stylelint-config-recommended-less postcss-html stylelint-config-recommended-vue stylelint-config-recess-order stylelint-config-prettier -D -w然后新建.stylelintrc.cjs
module.exports {// 注册 stylelint 的 prettier 插件plugins: [stylelint-prettier],// 继承一系列规则集合extends: [// standard 规则集合stylelint-config-standard,stylelint-config-recommended-less,// 样式属性顺序规则stylelint-config-recess-order,// 接入 Prettier 规则stylelint-config-prettier,stylelint-prettier/recommended],// 配置 rulesrules: {// 开启 Prettier 自动格式化功能prettier/prettier: true}
};在 package.json 中新增 script 命令
{scripts: {// stylelint 命令lint:style: stylelint --fix \*.{css,less}\}
}执行pnpm run lint:style即可完成样式的格式化,同样的如果你想要保存时自动格式化可以在 VSCode 安装 Stylelint 这样我们便完成了 Stylelint 的配置
