项目搭建时的代码规范(editorconfig、Prettier、ESLint)

概要

在做项目时,如果是多人开发很容易由于代码风格的不同导致代码很影响观感,例如:有时候用双引号有时候用单引号等等,因此本文提供三个代码规范的做法,三个方法可同时使用

整体流程

1.创建完成项目后
2.配置editorconfig文件
3.使用Prettier工具
4.使用ESLint检测

使用方法

- 集成editorconfig配置

  • EditorConfig 有助于为不同 IDE 编辑器上处理同一项目的多个开发人员维护一致的编码风格。
  • 使用
    • 在使用时,VSCode需要安装一个插件:EditorConfig for VS Code
      在这里插入图片描述

    • 在工作目录下创建.editorconfig文件
      在这里插入图片描述

# http://editorconfig.org

root = true

[*] # 表示所有文件适用
charset = utf-8 # 设置文件字符集为 utf-8
indent_style = space # 缩进风格(tab | space)
indent_size = 2 # 缩进大小
end_of_line = lf # 控制换行类型(lf | cr | crlf)
trim_trailing_whitespace = true # 去除行尾的任意空白字符
insert_final_newline = true # 始终在文件末尾插入一个新行

[*.md] # 表示仅 md 文件适用以下规则
max_line_length = off
trim_trailing_whitespace = false

- 使用Prettier工具

  • Prettier用于代码格式化工具,前端能用到的文件格式它都可以搞定,是当下最流行的代码格式化工具。

使用:

1.安装prettier,如果创建vue项目时,已经选择Prettier则可以不用下载

npm install prettier -D

2.配置.prettierrc文件:

  • useTabs:使用tab缩进还是空格缩进,选择false;
  • tabWidth:tab是空格的情况下,是几个空格,选择2个;
  • printWidth:当行字符的长度,推荐80,也有人喜欢100或者120;
  • singleQuote:使用单引号还是双引号,选择true,使用单引号;
  • trailingComma:在多行输入的尾逗号是否添加,设置为 none,比如对象类型的最后一个属性后面是否加一个,;
  • semi:语句末尾是否要加分号,默认值true,选择false表示不加;
{
   
  "useTabs": false,
  "tabWidth": 2,
  "printWidth": 80,
  "singleQuote": true,
  "trailingComma": "none",
  "semi": false
}

3.VSCode需要安装prettier的插件
在这里插入图片描述
5.VSCod中的配置

  • 点击鼠标右键后,点击使用…格式化文档
    在这里插入图片描述

  • 将格式化默认值为Prettier即可,使用shit+alt+F就可以格式化代码
    在这里插入图片描述

- 使用ESLint检测

1.在前面创建项目时选择了ESLint,Vue会默认帮助我们配置需要的ESLint环境。
使用:
1.插件安装
在这里插入图片描述
2.npm下载所需插件

npm install eslint-plugin-prettier eslint-config-prettier -D

3.添加prettier插件

  extends: [
    "plugin:vue/vue3-essential",
    "eslint:recommended",
    "@vue/typescript/recommended",
    "@vue/prettier",
    "@vue/prettier/@typescript-eslint",
    'plugin:prettier/recommended'
  ],
  • 如果想要eslint忽略某项检测,则在rules对象设置
  • 例如:想要忽视声明但没取值的检测
    在这里插入图片描述

在这里插入图片描述

小结

本文主要提供在项目创建时,如何对代码进行代码规范的做法,三个方法用处各不相同,可以同时使用
由于作者水平有限
如果对本文有任何疑问可以私信或者评论区发表你的看法
本文如果对你有帮助,麻烦点个赞和收藏方便回看,求关注 谢谢

相关推荐

  1. vite+vue3项目遇到问题

    2024-02-19 03:10:01       44 阅读
  2. vue3组件库(二): 代码规范自动化

    2024-02-19 03:10:01       40 阅读
  3. 项目前后端两个注意事项

    2024-02-19 03:10:01       18 阅读
  4. 项目代码规范

    2024-02-19 03:10:01       42 阅读
  5. 项目代码规范

    2024-02-19 03:10:01       58 阅读

最近更新

  1. docker php8.1+nginx base 镜像 dockerfile 配置

    2024-02-19 03:10:01       94 阅读
  2. Could not load dynamic library ‘cudart64_100.dll‘

    2024-02-19 03:10:01       101 阅读
  3. 在Django里面运行非项目文件

    2024-02-19 03:10:01       82 阅读
  4. Python语言-面向对象

    2024-02-19 03:10:01       91 阅读

热门阅读

  1. python中怎么画对数坐标图

    2024-02-19 03:10:01       52 阅读
  2. openJudge | 中位数 C语言

    2024-02-19 03:10:01       58 阅读
  3. yolov8目标检测-onnx模型推理

    2024-02-19 03:10:01       42 阅读
  4. 什么是云渲染?云渲染的优势有哪些?

    2024-02-19 03:10:01       64 阅读
  5. C#面:简述装箱和拆箱

    2024-02-19 03:10:01       53 阅读
  6. 通用人工智能(Artificial General Intelligence,AGI)概述

    2024-02-19 03:10:01       47 阅读
  7. leetcode5_最长回文字串

    2024-02-19 03:10:01       56 阅读
  8. 【Webpack】处理图片资源

    2024-02-19 03:10:01       49 阅读