文档章节

统一代码风格工具 editorConfig

2688
 2688
发布于 2016/10/13 09:36
字数 486
阅读 25
收藏 0

editorConfig简介

按照名字解释就是编辑器配置,可以帮助开发者在不同的编辑器和IDE之间定义和维护一致的代码风格。比如文件缩进、换行等格式。
editorConfig官网

工作方式

一般在项目根目录创建一个名为 .editorconfig 的文件,该文件的内容定义该项目的编码规范.
当用IDE打开一个文件时,editorConfig插件会在打开文件的目录和其每一级父节点查找.editorconfig文件, 编辑器读取配置文件并依此格式化代码,如果没有的话就用编辑器默认配置.

editorConfig 例子

# http://editorconfig.org
root = true
# 对所有的文件生效
[*]
charset = utf-8
indent_style = space
indent_size = 4
tab_width =4
end_of_line = lf
trim_trailing_whitespace = true
insert_final_newline= true
max_line_length = 80

[*.{json,yml}]
indent_size = 2

[*.md]
trim_trailing_whitespace = false

editorConfig 配置说明

root           表示是最顶层的配置文件,发现设为true时,才会停止查找.editorconfig文件    
charset           设置编码 一般设置为utf8
indent_style    缩进类型(tab是硬缩进,space为软缩进)
indent_size     缩进的数量,如果indent_style为tab,则此属性默认为tab_width
tab_width        用一个整数来设置tab缩进的列数。默认是indent_size
end_of_line     换行符格式,值为lf、cr和crlf
trim_trailing_whitespace  设为true表示会去除换行行首的任意空白字符。
insert_final_newline      是否在文件的最后插入一个空行

以上是常用配置,更多的可以参考这里

编辑器插件

editorConfig官网 上面已经列出各个编辑器的插件,可以去官网下载 输入图片说明

参考文档

© 著作权归作者所有

上一篇: test
2688

2688

粉丝 11
博文 56
码字总数 33491
作品 0
深圳
高级程序员
私信 提问
EditorConfig使用介绍——解决markdown文件行尾空格自动删除的问题

前言 使用VSCode作为IDE开发工具已经有一段时间,期间一直有一个很困扰我的问题,就是关于行尾空格的自动删除。 一般情况下,都需要对源码中的行尾的多余空格进行删除,所以我有设置自动删除...

chenhao_ch
2017/11/29
0
0
不起眼的 .editorconfig

还是在看别人 github 上项目的时候,看到好多项目目录下都会有个 .editorconfig 文件,起初看里面内容有个 md 的字符,还以为就 markdown 文件的配置来,后来有一次在 Webstorm 里配置一个 ...

dkvirus
2017/10/22
0
0
在vscode使用editorconfig的正确姿势

editorconfig是什么鬼? editorconfig是用来帮助开发者定义和维护代码风格(行尾结束符、缩进风格等)的东东。 editorconfig支持哪些规则? 请自行参考 editorconfig.org/ 如何在vscode中使用...

程序员大白
2018/07/19
0
0
MinJieLiu/web-standard

前端规范指南 导航 html规范 css规范 es5规范 es6规范 react规范 eslint参考 editorconfig 概述 规范的制定是我们长期以来对工作的积累与沉淀的产物,帮助我们更快、更好、更高效的完成繁重、...

MinJieLiu
2016/11/14
0
0
WebStorm 9“神器”变“霸器”

WebStorm 9测试版新增:Live Edit增强、JS后缀模板、Gulp集成、Node.js的spy-js和改善Editorconfig等。 早在半年前,JetBrains就发布了WebStorm 9的发展路线,经过半年的不断努力与更替。Web...

kouxunli1
2014/10/21
0
1

没有更多内容

加载失败,请刷新页面

加载更多

android6.0源码分析之Camera API2.0简介

前面几篇主要分析的是android Camera API1.0的架构以及初始化流程,而google在android5.0(Lollipop)开始对Camera的架构进行了调整,为了适应HAL3,新添加实现了CameraDeviceClient,而Camer...

天王盖地虎626
33分钟前
2
0
Flutter for Web 开发环境搭建与验证

最新的Flutter 1.5.4已经支持Web开发,这个教程将介绍如何在Linux、windows和Mac下 安装Flutter web开发环境:安装Flutter SDK和Flutter Web构建工具,并利用Flutter Web 演示代码来验证开发...

汇智网教程
37分钟前
2
0
微信小程序

张小龙的定义 1、不需要下载安装即可使用 实际上也有下载和安装的流程,只不过安装包很小<2M,使得这两个过程很短,不易感知到 2、用户"用完即走"不用关心是否安装太多应用 适用于偶尔使用一...

星闪海洋
今天
2
0
JsonUtil工具类

使用的是fastJson package util; import java.io.IOException; import java.text.SimpleDateFormat; import java.util.Date; import java.util.HashMap; import java.util.Map; import com.f......

嘿嘿嘿IT
今天
2
0
Mementor模式

//个人感觉就想当于把某个类的某部分或全部复制一份保存在另一个类中,然后在有必要的时候用保存的复制的那部分来恢复之前的某种状态 https://blog.csdn.net/syc434432458/article/details/5...

南桥北木
今天
2
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部