前端工具 Prettier 详细使用流程(兼容ESLint)

简介: 前端工具 Prettier 详细使用流程(兼容ESLint)

一、简介

  • 中文文档英文官网
  • Prettier 是一个开箱即用的代码格式化程序。用来批量处理旧代码的统一,涉及引号、分号、换行、缩进等。支持目前大部分语言处理,包括 JavaScriptFlowTypeScriptCSSSCSSLessJSXVueGraphQLJSONMarkdown ,它通过解析代码并使用自己的规则。

二、安装使用

  • vscode 需开启保存配置

  • 安装方式:
  • 方式一vscode 安装插件 Prettier,正常在项目文件根目录添加配置文件即可,会自动检测。
  • 方式二npm
$ npm install --save-dev --save-exact prettier
  • 方式三yarn
$ yarn add --dev --exact prettier
  • 配置文件有很多种写法,选一种就行,不用纠结,没必要给自己挖坑!
  • 有安装 ESLint 的情况下,可以尝试将 Prettier 的配置偏向 ESLint 的校验结果。列一下常见的冲突点:
1、prettier 会默认把单引号变成双引号,然后 eslint 校验报错
2、js 每行代码后面会加一个分号,然后 eslint 校验报错
3、函数结束之后会加一个逗号,然后 eslint 校验报错
......
  • 在项目根目录创建 .prettierrc.js,添加自己需要的配置,这里列了一下常用配置,包含上面冲突点的兼容,其他配置自动可额外添加(附:官方文档支持的配置属性
module.exports = {
  printWidth: 100,
  tabWidth: 2, // 超过最大值换行
  semi: false, // 结尾不用分号
  singleQuote: true, // 使用单引号
  disableLanguages: ['vue'], // 不格式化 vue 文件,vue 文件的格式化单独设置
  htmlWhitespaceSensitivity: 'ignore', // 标签换行不完整问题
  trailingComma: 'none', // 函数后面不加逗号,如果不写这一个,在methods 最后一个函数也会加逗号,eslint会报错,多了一个逗号
}
  • 项目中配置好之后,Ctrl + SCommand + S 保存
    如果保存无效,并没有进行格式化,在代码中右键菜单中,找到 使用...格式化文档 修改格式化文档方式为 Prettier,然后再次尝试保存,或者在右键菜单中直接点击 格式化文档
  • 可以忽略指定文件夹或文件中代码不进行格式化,以免提交出现冲突,创建 .prettierignore 文件,它使用的是 gitignore 语法
# Ignore artifacts:
build
coverage
# Ignore all HTML files:
*.html

三、补充

  • 基本配置效果对比
{
    // tab 缩进大小,默认为 2
    "tabWidth": 4,
    // 使用 tab 缩进,默认 false
    "useTabs": false,
    // 使用分号, 默认 true
    "semi": false,
    // 使用单引号, 默认 false (在 jsx 中配置无效, 默认都是双引号)
    "singleQuote": false,
    // 行尾逗号,默认 none ,可选 none|es5|all
    // es5 包括 es5 中的数组、对象
    // all 包括函数对象等所有可选
    "TrailingCooma": "all",
    // 对象中的空格 默认true
    // true: { foo: bar }
    // false: {foo: bar}
    "bracketSpacing": true,
    // JSX 标签闭合位置 默认 false
    // false: <div
    //          className=""
    //          style={{}}
    //       >
    // true: <div
    //          className=""
    //          style={{}} >
    "jsxBracketSameLine": false,
    // 箭头函数参数括号 默认 avoid 可选 avoid| always
    // avoid 能省略括号的时候就省略 例如x => x
    // always 总是有括号
    "arrowParens": "avoid"
}
  • vscode 安装插件之后,除了在项目中添加配置文件之外,也可以直接配置到 vscode 的配置文件( settings.json )中,这样就不需要每个项目添加配置文件了
// prettier配置,,修改了配置文件,必须重启 vscode 才会生效
  "prettier.configPath": "/Users/xxx/Desktop/Project/npm/dts-gen/.prettierrc.js", // 配置文件路径,配置了这个路径,就不需要单个配置了,要不然会覆盖
  "eslint.alwaysShowStatus": true, // 总是显示 eslint 状态
  "prettier.printWidth": 120, // 超过最大值换行
  "prettier.tabWidth": 2, // 缩进字节数
  "prettier.useTabs": false, // 缩进不使用 tab,使用空格
  "prettier.semi": true, // 句尾添加分号
  "prettier.singleQuote": true, // 使用单引号代替双引号
  "prettier.proseWrap": "preserve", // 默认值。因为使用了一些折行敏感型的渲染器(如 GitHub comment)而按照 markdown 文本样式进行折行
  "prettier.arrowParens": "avoid", //  (x) => {} 箭头函数参数只有一个时是否要有小括号。avoid:省略括号
  "prettier.bracketSpacing": true, // 在对象,数组括号与文字之间加空格 "{ foo: bar }"
  "prettier.endOfLine": "auto", // 结尾是 \n \r \n\r auto
  "prettier.eslintIntegration": false, // 不让 prettier 使用 eslint 的代码格式进行校验
  "prettier.htmlWhitespaceSensitivity": "ignore", // 标签换行不完整问题
  "prettier.ignorePath": ".prettierignore", // 不使用 prettier 格式化的文件填写在项目的.prettierignore文件中
  "prettier.BracketSameLine": false, // 在 jsx中 把 '>' 是否单独放一行
  "prettier.jsxSingleQuote": false, // 在 jsx 中使用单引号代替双引号
  // "prettier.parser": "babylon", // 格式化的解析器,默认是 babylon
  "prettier.requireConfig": false, // Require a 'prettierconfig' to format prettier
  "prettier.stylelintIntegration": false, // 不让 prettier 使用 stylelint 的代码格式进行校验
  "prettier.trailingComma": "none", // 属性值 es5 表示在对象或数组最后一个元素后面是否加逗号(在ES5中加尾逗号)
  "prettier.tslintIntegration": false, // 不让 prettier 使用 tslint 的代码格式进行校验

相关文章
|
5月前
|
资源调度 前端开发 测试技术
前端工程化实践:从零搭建现代化项目构建流程
【4月更文挑战第6天】本文介绍了前端工程化的概念和重要性,包括模块化、自动化、规范化和CI/CD。接着,讨论了选择合适的工具链,如包管理器、构建工具和测试框架。然后,详细阐述了如何从零开始搭建一个基于React的现代化项目构建流程,涉及初始化、代码规范、测试、CSS处理、代码分割和CI/CD配置。最后,提到了持续优化与迭代的方向,如性能优化、类型检查和微前端。通过这样的实践,开发者可以提升开发效率和代码质量,为项目长远发展奠定基础。
223 0
|
5月前
|
前端开发 JavaScript
前端常用的ESlint配置
前端常用的ESlint配置
101 1
|
2月前
|
缓存 前端开发 中间件
[go 面试] 前端请求到后端API的中间件流程解析
[go 面试] 前端请求到后端API的中间件流程解析
|
14天前
|
前端开发 JavaScript 开发工具
前端项目增加eslint全过程
如何在前端项目中安装并配置ESLint和Prettier,包括VSCode插件的安装、npm包的全局安装、.eslintrc.js配置文件的生成以及编辑器设置的调整。
22 6
|
16天前
|
存储 JSON 前端开发
node使用token来实现前端验证码和登录功能详细流程[供参考]=‘很值得‘
本文介绍了在Node.js中使用token实现前端验证码和登录功能的详细流程,包括生成验证码、账号密码验证以及token验证和过期处理。
25 0
node使用token来实现前端验证码和登录功能详细流程[供参考]=‘很值得‘
|
2月前
|
运维 前端开发 Serverless
中后台前端开发问题之流程编排如何解决
中后台前端开发问题之流程编排如何解决
22 0
|
2月前
|
JavaScript 前端开发 开发者
【颠覆你的前端世界!】VSCode + ESLint + Prettier:一键拯救Vue代码于水深火热之中,打造极致编程体验之旅!
【8月更文挑战第9天】随着前端技术的发展,保持代码规范一致至关重要。本文介绍如何在VSCode中利用ESLint和Prettier检查并格式化Vue.js代码。ESLint检测代码错误,Prettier保证风格统一。首先需安装VSCode插件及Node.js包,然后配置ESLint和Prettier选项。在VSCode设置中启用保存时自动修复与格式化功能。配置完成后,VSCode将自动应用规则,提升编码效率和代码质量。
259 1
|
2月前
|
JavaScript 前端开发 API
解锁前端开发新境界:Vue.js携手Webpack,打造高效构建流程,你的项目值得拥有!
【8月更文挑战第30天】随着前端技术的发展,模块化与组件化趋势愈发显著。Vue.js 以其简洁的 API 和灵活的组件系统,深受开发者喜爱;Webpack 则凭借强大的模块打包能力成为前端工程化的基石。两者结合,不仅简化了组件编写与引用,还通过模块热替换、代码分割等功能大幅提升开发效率。本文将通过具体示例,展示如何利用 Vue.js 和 Webpack 构建高效、有序的前端开发环境。从安装配置到实际应用,逐步解析这一组合的优势所在。
38 0
|
3月前
|
前端开发 NoSQL 数据库
部署常用的流程,可以用后端,连接宝塔,将IP地址修改好,本地只要连接好了,在本地上前后端跑起来,前端能够跑起来,改好了config.js资料,后端修改好数据库和连接redis,本地上跑成功了,再改
部署常用的流程,可以用后端,连接宝塔,将IP地址修改好,本地只要连接好了,在本地上前后端跑起来,前端能够跑起来,改好了config.js资料,后端修改好数据库和连接redis,本地上跑成功了,再改
|
4月前
|
缓存 前端开发 JavaScript
Webpack作为模块打包器,为前端项目提供了高度灵活和可配置的构建流程
【6月更文挑战第12天】本文探讨了优化TypeScript与Webpack构建性能的策略。理解Webpack的解析、构建和生成阶段是关键。优化包括:调整tsconfig.json(如关闭不必要的类型检查)和webpack.config.js选项,启用Webpack缓存,实现增量构建,代码拆分和懒加载。这些方法能提升构建速度,提高开发效率。
56 3