网站设计公司皆选奇点网络,秦皇岛高端网站设计,2022网站快速收录技术,网站设计报价单Prettier 和 ESLint 是两个在现代 JavaScript 开发中广泛使用的工具#xff0c;它们结合起来可以提供以下作用和优势#xff1a; 代码格式化和风格统一#xff1a; Prettier 是一个代码格式化工具#xff0c;能够自动化地处理代码的缩进、空格、换行等格式问题#xff0c;…Prettier 和 ESLint 是两个在现代 JavaScript 开发中广泛使用的工具它们结合起来可以提供以下作用和优势 代码格式化和风格统一 Prettier 是一个代码格式化工具能够自动化地处理代码的缩进、空格、换行等格式问题确保整个项目的代码风格一致。在团队开发中Prettier 可以消除因个人习惯或编辑器设置不同而导致的代码格式差异提高代码的可读性和维护性。 代码质量和规范检查 ESLint 是一个 JavaScript 和 TypeScript 代码的静态分析工具用于发现和修复代码中的问题例如语法错误、不符合规范的代码等。通过配置规则ESLint 可以强制执行团队约定的代码风格、最佳实践和安全性规则帮助团队编写更高质量、更一致的代码。 结合使用的优势 格式化和规范检查的一体化Prettier 负责格式化ESLint 负责规范检查。结合使用可以确保代码不仅格式良好还符合团队的代码规范和最佳实践。自动化和持续集成可以将 Prettier 和 ESLint 集成到 CI/CD 流水线中在每次提交或部署前自动运行提早发现和修复潜在问题。 可定制性和配置 Prettier 和 ESLint 都支持广泛的配置选项和插件系统可以根据团队的需求和偏好进行定制和扩展。通过共享和维护一个统一的配置文件如 .prettierrc.cjs 和 .eslintrc.cjs可以确保整个团队在开发过程中遵循相同的代码风格和规范。 目录 代码格式化配置Prettier1、安装插件2、下载 prettier 相关依赖3、配置 Prettier(.prettierrc.cjs)4、Prettier忽略文件.prettierignore)5、package.json 配置命令脚本 代码规范工具ESLint1、安装插件 ESLint2、项目下载依赖3、配置 ESLint.eslintrc.cjs4、ESlint忽略文件(.eslintignore)5、package.json配置命令脚本 代码格式化配置Prettier
1、安装插件 2、下载 prettier 相关依赖
pnpm i prettier -D3、配置 Prettier(.prettierrc.cjs)
Prettier 默认优先读取项目中的配置文件以确定代码格式化的规则。具体来说Prettier 会按照以下优先级查找配置
package.json文件中的 prettier 关键字.prettierrc 文件以 JSON 或 YAML 编写的.prettierrc.json 、 .prettierrc.yml 、 .prettierrc.yaml 或 .prettierrc.json5 文件.prettierrc.js 或 prettier.config.js 文件使用 export default 或 module.exports 导出对象 取决于 package.json 中的 type 值 。.prettierrc.mjs 或 prettier.config.mjs 文件使用 export default 导出对象。.prettierrc.cjs 或 prettier.config.cjs 文件使用 module.exports 导出对象。.prettierrc.toml 文件。
// see: https://www.prettier.cn
module.exports {// 指定最大换行长度printWidth: 120,// 缩进制表符宽度 | 空格数tabWidth: 2,// 使用制表符而不是空格缩进行 (true制表符false空格)useTabs: false,// 结尾不用分号 (true有false没有)semi: true,// 使用单引号 (true单引号false双引号)singleQuote: false,// 在对象字面量中决定是否将属性名用引号括起来 可选值 as-needed|consistent|preservequoteProps: as-needed,// 在JSX中使用单引号而不是双引号 (true单引号false双引号)jsxSingleQuote: false,// 多行时尽可能打印尾随逗号 可选值none|es5|alltrailingComma: none,// 在对象数组括号与文字之间加空格 { foo: bar } (true有false没有)bracketSpacing: true,// 将 多行元素放在最后一行的末尾而不是单独放在下一行 (true放末尾false单独一行)bracketSameLine: false,// (x) {} 箭头函数参数只有一个时是否要有小括号 (avoid省略括号always不省略括号)arrowParens: avoid,// 指定要使用的解析器不需要写文件开头的 prettierrequirePragma: false,// 可以在文件顶部插入一个特殊标记指定该文件已使用 Prettier 格式化insertPragma: false,// 用于控制文本是否应该被换行以及如何进行换行proseWrap: preserve,// 在html中空格是否是敏感的 css - 遵守 CSS 显示属性的默认值 strict - 空格被认为是敏感的 ignore - 空格被认为是不敏感的htmlWhitespaceSensitivity: css,// 控制在 Vue 单文件组件中 script 和 style 标签内的代码缩进方式vueIndentScriptAndStyle: false,// 换行符使用 lf 结尾是 可选值 auto|lf|crlf|crendOfLine: auto,// 这两个选项可用于格式化以给定字符偏移量分别包括和不包括开始和结束的代码 (rangeStart开始rangeEnd结束)rangeStart: 0,rangeEnd: Infinity,
};4、Prettier忽略文件.prettierignore)
/dist/*
.local
/node_modules/****/*.svg
**/*.sh/public/*5、package.json 配置命令脚本
scripts:{//......其他省略lint:prettier: prettier --write \src/**/*.{js,ts,json,tsx,css,less,scss,vue,html,md}\,
}运行命令 pnpm run lint:prettier比如有如下的js代码 执行命令之后 代码规范工具ESLint
1、安装插件 ESLint 2、项目下载依赖
pnpm i eslint eslint-config-prettier eslint-plugin-prettier eslint-plugin-vue typescript-eslint/eslint-plugin typescript-eslint/parser -D依赖作用描述eslintESLint 核心库eslint-config-prettier关掉所有和 Prettier 冲突的 ESLint 的配置eslint-plugin-prettier将 Prettier 的 rules 以插件的形式加入到 ESLint 里面eslint-plugin-vue为 Vue 使用 ESlint 的插件typescript-eslint/eslint-pluginESLint 插件包含了各类定义好的检测 TypeScript 代码的规范typescript-eslint/parserESLint 的解析器用于解析 TypeScript从而检查和规范 TypeScript 代码
3、配置 ESLint.eslintrc.cjs
// see: http://eslint.cn
module.exports {root: true,env: {browser: true,node: true,es6: true,},// 指定如何解析语法parser: vue-eslint-parser,// 优先级低于 parse 的语法解析配置parserOptions: {parser: typescript-eslint/parser,ecmaVersion: 2020,sourceType: module,jsxPragma: React,ecmaFeatures: {jsx: true,},},// 继承某些已有的规则extends: [plugin:vue/vue3-recommended,plugin:typescript-eslint/recommended,plugin:prettier/recommended,],/*** off 或 0 关闭规则* warn 或 1 打开的规则作为警告不影响代码执行* error 或 2 规则作为一个错误代码不能执行界面报错*/rules: {// eslint (http://eslint.cn/docs/rules)no-var: error, // 要求使用 let 或 const 而不是 varno-multiple-empty-lines: [error, { max: 1 }], // 不允许多个空行prefer-const: off, // 使用 let 关键字声明但在初始分配后从未重新分配的变量要求使用 constno-use-before-define: off, // 禁止在 函数/类/变量 定义之前使用它们no-irregular-whitespace: off, // 禁止不规则的空白// typeScript (https://typescript-eslint.io/rules)typescript-eslint/no-unused-vars: error, // 禁止定义未使用的变量typescript-eslint/prefer-ts-expect-error: error, // 禁止使用 ts-ignoretypescript-eslint/no-inferrable-types: off, // 可以轻松推断的显式类型可能会增加不必要的冗长typescript-eslint/no-namespace: off, // 禁止使用自定义 TypeScript 模块和命名空间。typescript-eslint/no-explicit-any: off, // 禁止使用 any 类型typescript-eslint/ban-types: off, // 禁止使用特定类型typescript-eslint/explicit-function-return-type: off, // 不允许对初始化为数字、字符串或布尔值的变量或参数进行显式类型声明typescript-eslint/no-var-requires: off, // 不允许在 import 语句中使用 require 语句typescript-eslint/no-empty-function: off, // 禁止空函数typescript-eslint/no-use-before-define: off, // 禁止在变量定义之前使用它们typescript-eslint/ban-ts-comment: off, // 禁止 ts-directive 使用注释或要求在指令后进行描述typescript-eslint/no-non-null-assertion: off, // 不允许使用后缀运算符的非空断言(!)typescript-eslint/explicit-module-boundary-types: off, // 要求导出函数和类的公共类方法的显式返回和参数类型// vue (https://eslint.vuejs.org/rules)vue/script-setup-uses-vars: error, // 防止script setup使用的变量template被标记为未使用此规则仅在启用该no-unused-vars规则时有效。vue/v-slot-style: error, // 强制执行 v-slot 指令样式vue/no-mutating-props: off, // 不允许组件 prop的改变vue/no-v-html: off, // 禁止使用 v-htmlvue/custom-event-name-casing: off, // 为自定义事件名称强制使用特定大小写vue/attributes-order: off, // vue api使用顺序强制执行属性顺序vue/one-component-per-file: off, // 强制每个组件都应该在自己的文件中vue/html-closing-bracket-newline: off, // 在标签的右括号之前要求或禁止换行vue/max-attributes-per-line: off, // 强制每行的最大属性数vue/multiline-html-element-content-newline: off, // 在多行元素的内容之前和之后需要换行符vue/singleline-html-element-content-newline: off, // 在单行元素的内容之前和之后需要换行符vue/attribute-hyphenation: off, // 对模板中的自定义组件强制执行属性命名样式vue/require-default-prop: off, // 此规则要求为每个 prop 为必填时必须提供默认值vue/multi-word-component-names: off, // 要求组件名称始终为 “-” 链接的单词},
};注意 上面ESLint并不是要全部使用只是罗列了常见的配置具体使用的时候请根据自己项目的情况进行配置 4、ESlint忽略文件(.eslintignore)
*.sh
node_modules
*.md
*.woff
*.ttf
.vscode
.idea
dist
/public
/docs
.husky
.local
/bin
/src/mock/*5、package.json配置命令脚本
scripts:{//......其他省略lint:eslint: eslint --fix --ext .js,.ts,.vue ./src,
}对以下代码进行处理 命令 npm run lint:eslint运行之后 提示您有2处有赋值但从未使用的变量您需要手动删除或注释。
