【VSCode】【EditorConfig】EditorConfig 简单介绍

 

目录

一. 啥是 EditorConfig ?

二. 示例文件

三.  参考

---

 

 

一. 啥是 EditorConfig ?

最近看好多github 上，下载下来的源码根目录中包含一个`.editorconfig` 文件，可这是干啥的呢？

官网解释如下:

EditorConfig有助于维护跨多个编辑器和IDE从事同一项目的多个开发人员的一致编码风格。

EditorConfig项目包含一个用于定义编码样式的文件格式和一个文本编辑器插件集合，这些文本编辑器插件使编辑器可以读取文件格式并遵循定义的样式。

EditorConfig文件易于阅读，并且可以与版本控制系统很好地协同工作。

 

二. 示例文件

 

更多属性配置，请参考: https://github.com/editorconfig/editorconfig/wiki/EditorConfig-Properties

 

# EditorConfig is awesome: https://EditorConfig.org

# top-most EditorConfig file
root = true

# Unix-style newlines with a newline ending every file
[*]
end_of_line = lf
insert_final_newline = true

# Matches multiple files with brace expansion notation
# Set default charset
[*.{js,py}]
charset = utf-8

# 4 space indentation
[*.py]
indent_style = space
indent_size = 4

# Tab indentation (no size specified)
[Makefile]
indent_style = tab

# Indentation override for all JS under lib directory
[lib/**.js]
indent_style = space
indent_size = 2

# Matches the exact files either package.json or .travis.yml
[{package.json,.travis.yml}]
indent_style = space
indent_size = 2

 

三.  参考

1. https://editorconfig.org/
2. https://editorconfig-specification.readthedocs.io/en/latest/
3. https://github.com/editorconfig/editorconfig
4. https://github.com/editorconfig/editorconfig/wiki/EditorConfig-Properties
5. https://github.com/editorconfig/editorconfig/wiki/FAQ
6. https://github.com/editorconfig/editorconfig/wiki/Projects-Using-EditorConfig

 

 

(完)