前端项目中统一代码格式

.editorconfig & EditorConfig for VS Code

EditorConfig有助于保持代码风格的一致性,尤其在多人协作项目中非常有用。它通过一个名为.editorconfig的配置文件来为不同的编辑器和IDE(包括VS Code)定义代码样式规则。

  • 添加EditorConfig for VS Code插件
  • 文件根路径添加.editorconfig,设置格式
    # http://editorconfig.org
    
    # 表示是最顶层的配置文件,发现值为true时,才会停止查找.editorconfig文件
    root = true
    
    [*] # 表示所有文件适用
    charset = utf-8 # 设置文件字符集为 utf-8
    indent_style = tab # 缩进风格(tab | space)
    indent_size = 2 # 缩进大小
    end_of_line = lf # 控制换行类型(lf | cr | crlf)
    trim_trailing_whitespace = true # 去除行首的任意空白字符
    insert_final_newline = false # 始终在文件末尾插入一个新行
    
    [*.md] # 表示仅 md 文件适用以下规则
    max_line_length = off
    trim_trailing_whitespace = false
prettierrc & Prettier - Code formatter
Prettier是一个流行的代码格式化工具,旨在通过自动应用一致的代码风格来提高代码可读性和开发效率。它支持多种语言和框架,并且可以与编辑器、IDE 以及构建工具集成,使得代码风格保持一致变得非常简单。
 
husky

Husky 是一个用于 Git Hooks 的工具,它使得在 Git 事件(如 commit push等)触发时自动运行脚本变得非常简单。通过 Husky,你可以在代码提交或推送之前执行诸如代码格式化、测试、Lint 检查等操作,确保代码质量和一致性。

项目中提交代码有的时候就是一段话,或者数字,例如 git commit -m;对于后人无法理解,于是在代码提交前通过工具迫使规范提交是必要的

 
参考链接
https://mp.weixin.qq.com/s/FjwhcLHghm0xEjE09j3vpg?scene=1
 
 
posted @ 2025-06-23 17:47  玉文  阅读(36)  评论(0)    收藏  举报