@hootool/editor-config
v0.1.1
Published
编辑器配置(.editorconfig 等)
Readme
@hootool/editor-config
统一编辑器配置(EditorConfig),确保不同编辑器/IDE 的基础格式一致。
使用
将本包的 .editorconfig 复制到项目根目录:
cp node_modules/@hootool/editor-config/.editorconfig .editorconfigVS Code
建议安装推荐插件,并启用保存时 Prettier 格式化、ESLint / Stylelint 自动修复:
mkdir -p .vscode
cp node_modules/@hootool/editor-config/vscode/extensions.json .vscode/extensions.json
cp node_modules/@hootool/editor-config/vscode/settings.json .vscode/settings.json保存时行为:
- Prettier 负责格式化(
editor.formatOnSave) - ESLint / Stylelint 通过
source.fixAll自动修复(含自动保存) - 关闭 ESLint / Volar 自带 formatter(
eslint.format.enable、vue.format.enable),避免和 Prettier 抢格式 - 语法错误(无法解析的代码)不会被自动修复,需先改成合法语法
配置内容
- 字符集:UTF-8
- 换行符:LF
- 缩进:2 空格(
*默认,覆盖js/ts/vue/html/css/scss/less/json等) - 文件末尾插入空行
- 去除行尾多余空格(Markdown 除外,避免破坏换行)
- 例外:
Makefile使用 Tab;*.go缩进 4 空格
编辑器支持
- VS Code:安装推荐插件(EditorConfig、Prettier、ESLint、Stylelint),保存时自动格式化并 fix
- WebStorm / IntelliJ:原生支持 EditorConfig;Prettier / ESLint 需在 IDE 中分别开启 On Save
- Vim:原生支持 EditorConfig(需
+editorconfig)
