前端统一编码规范/风格

444 阅读2分钟

前端的编码规范和风格,首先我们想到的就是eslint和prettier

开发工具的话就.editorconfig的配置

3、editorconfig用起来

editorconfig顾名思义,是开发工具的一个配置,这个配置只针对我们单独的项目,作用是为了什么呢? 让使用不同编辑器的开发者在共同开发一个项目时“无痛”地遵循编码规范(编码风格),就可以使用EditorConfig插件,会在项目根目录寻找.editorconfig文件并使用其中定义的编码风格。
EditorConfig 支持的常用的编码规范,如下

root
#EditorConfig文件使用INI格式。斜杠(/)作为路径分隔符,#或者;作为注释。路径支持通配符:
#表明是最顶层的配置文件,发现设为true时,才会停止查找.editorconfig文件
charset:文件编码。
可选值: latin1、utf-8、utf-16be、utf-16le
indent_style: 缩进类型。
可选值:space、tab
indent_size: 缩进数量。
可选值:整数。一般设置 24
insert_final_newline:是否在文件的最后插入一个空行。
可选值:truefalse
end_of_line:换行符格式。说明见Wiki:换行。
可选值:lf、crlf、cr
trim_trailing_whitespace:是否删除行尾的空格。
可选值:truefalse
# 编辑器配置
root = true

[*]
charset = utf-8
end_of_line = lf
indent_size = 4
indent_style = space
insert_final_newline = true
trim_trailing_whitespace = true

[*.md]
trim_trailing_whitespace = false

webstorm使用.editorconfig

1、打开webStrome > File > settings; 2、找到Editor > Code Style 并点击它,在下面会有一个Enable EditorConfig support(启动EditorConfig的支持),点它前面的复选框选中它; 3、在复选框的后面有一Export按钮,它是导出editorConfig配置文件;我们点一下它,然后点确定;这时在你的项目中已经有了一个.editorConfig配置文件了;(如果团队里有已经配置好的这个文件,直接复制过来就行了)

vscode使用.editorconfig

1、VSCode使用editorconfig非常简单,直接在插件市场搜索EditorConfig for vs code 安装就行了。
2、使用在当前项目根目录下添加.editorconfig文件 安装EditorConfig扩展 全局安装或局部安装editorconfig依赖包(npm install -g editorconfig | npm install -D editorconfig) 打开需要格式化的文件并手动格式化代码(Mac OS :shift+option+f Windows :shift+alt+f)
3、可以通过资源管理器侧栏的上下文菜单右键选择Generate .editorconfig,然后这个目录下面就会创建出一个.editorconfig文件了;(如果团队里有已经配置好的这个文件,直接复制过来就行了)

4、附:关于vscode保存会自动格式化代码的问题

1、JS-CS-HTML Formatter 关闭插件 2、auto format vue
文件——首选项——设置 找到auto format vue
把这个勾选的去掉就可以了