统一代码风格工具 editorConfig

为什么80%的码农都做不了架构师？>>>

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官网上面已经列出各个编辑器的插件，可以去官网下载

参考文档

转载于:https://my.oschina.net/2688/blog/757795

统一代码风格工具 editorConfig相关推荐

前端通过eslint+prettier+husky统一代码风格
背景多人协作项目,会遇到每个人都有自己的代码风格.所以需要通过工具来统一代码风格. husky是什么? 当您提交或推送时,您可以使用 husky 来检查您的提交消息.运行测试.检查代码等Husky ...
idea findbugs使用_IDEA如何协同开发统一代码风格？编码不规范如何解决？
作为一个开发程序员最根本的是什么? 最基础的是代码编写如何编写高质量,可靠的,规范的代码,是作为一名合格程序员的基础和根本阿里被称为互联网界的黄埔军校, <阿里巴巴 java 开发手册> ...
eslint规范_规范统一前端代码风格
背景众所周知,前端项目的代码质量和代码格式的校验是不可或缺的.很早之前在一个人开发的时候,脚手架生成vue项目的时候都没有打开过eslint,后面有位大佬加入,给boss说,加了个插件(eslint ...
前端架构师神技，三招统一团队代码风格
本文从代码规范,代码检查,代码格式化,以及编辑器自动化实现的方向,介绍代码规范统一在我们团队的实践应用. 大纲预览本文介绍的内容包括以下方面: 认识代码规范制定和统一规范神技一:ESLint 神 ...
Visual Studio Code 使用 ESLint 增强代码风格检查 - gyzhao - 博客园
前言在团队协作开发中,为了统一代码风格,避免一些低级错误,应该设有团队成员统一遵守的编码规范.很多语言都提供了Lint工具来实现这样的功能,JavaScript也有类似的工具:ESLint.除了可以 ...
Visual Studio 代码风格约束
团队内部若能统一代码风格对于日后的项目维护大有裨益,但面对厚达十几甚至几十页的代码风格规范,开发人员难免产生抵触心理.Python和Go等在语言层面就对代码风格作了一定的约束,但C#并没有,为解决这个 ...
代码风格自动化（二）——husky + lint-staged
背景:由于每个人的代码风格不一致,在大型项目或者其他多人合作的项目中,如果无法统一代码风格,非常不利于代码的维护,甚至可能出现一些不必要的错误.因此,代码风格趋于一致很重要.在这个过程中会存在许多小细 ...
《码处高效：Java开发手册》之代码风格
流水淡,碧天长,鸿雁成行.编码风格,简捷清爽,反引无限风光. 在美剧<硅谷>中有这样一个经典镜头,主人公 Richard 与同为开发工程师的女友闹分手,理由是两人对缩进方式有着截然不同 ...
Gradle接入checkstyle代码风格检查插件
一.什么是checkstyle 在项目开发的过程中,代码规范是经常被提起的话题,特别是当项目需要多个开发协同完成的时候,良好统一的代码规范能够在一定程度上保证项目代码的质量和团队的开发效率.目前业界常 ...