DEVELOPER TOOLING · 编码约定台

.editorconfig 生成 一次约定,全队同频

选好技术栈与缩进、换行符、字符集、末尾空行等规则,立刻得到可直接保存的 .editorconfig 文本,并在右侧逐条说明每一行为什么这样写。

4 套技术栈预设 12 项可勾选规则 逐条中文解释 纯本地生成
STEP 01 / 选技术栈预设

四种主流技术栈,一键带入约定

STEP 02 / 勾选通用规则
STEP 03 / 针对文件类型的例外
实时预览 · .editorconfig 8 行

修改任意选项,左侧配置会即时更新;点「生成并复制」后弹窗显示逐条说明。

02 / 逐条解释

每一行为什么这样写

点击可展开细节
03 / 配置校验

校验已有的 .editorconfig

粘贴内容,逐行检查键名与取值
检查项:root 是否声明、段名是否成对、键名是否拼写正确、取值是否合法、是否缺少 charset / 末尾空行。
A / 口径

计算口径与常见误填

root 与 [*] 的关系root = true 告诉编辑器这是顶层配置,不要再向上查找;[*] 匹配所有文件,后面的 [*.php] 等段只对特定后缀生效,越靠后的段优先级越高。
indent_style 与 indent_sizeindent_style 取 space(空格)或 tab(制表符);indent_size 是缩进宽度,tab_width 是 Tab 显示的列数。前端与 Python 常用 2/4 空格,Go 官方用 Tab。
charset 与 end_of_linecharset = utf-8 统一文件编码,避免中文乱码;end_of_line 取 lf(Unix/macOS)或 crlf(Windows),跨平台协作统一为 lf 可减少无意义 diff。
insert_final_newline 与 trim_trailing_whitespace前者保证文件末尾有一个换行符,避免 No newline at end of file 提示;后者保存时自动删除行尾空格。Markdown 例外:结尾双空格是换行语义,需单独关掉。
B / 说明

这个工具解决什么问题

团队里有人用 2 空格、有人用 4 空格,有人保存时自动转 CRLF——.editorconfig 配置就是为消除这类分歧而生。它是一个放在项目根目录的小文件,VS Code、JetBrains、Sublime、Vim 等主流编辑器都能识别。

本页把常见规则做成勾选项:选技术栈套用预设,再按需微调缩进、换行符、字符集与末尾空行,右侧同步给出逐条解释。生成结果可直接复制保存,所有处理都在浏览器本地完成。

适用边界:.editorconfig 只约束编辑器行为,不格式化已有文件;要批量修复历史代码,还需配合 Prettier、php-cs-fixer、gofmt 等格式化工具。

C / 用法

按这几步用

  1. 01 · 选技术栈前端、PHP、Go、Python 四套预设,一键带入常用缩进与换行规则。
  2. 02 · 勾选项微调按需开关字符集、末尾空行、行尾空格等对勾选项。
  3. 03 · 看解释右侧逐条说明每条配置的含义与取值理由,便于团队评审。
  4. 04 · 复制保存点「复制配置」把文本保存到项目根目录的 .editorconfig 文件。
D / 答疑

常见问题

.editorconfig 和 Prettier 冲突吗?

不冲突。.editorconfig 决定编辑器的基础缩进与换行,Prettier 负责代码格式化;Prettier 会读取 .editorconfig 的 indent_style、indent_size、end_of_line 等值作为默认配置。

为什么 Go 项目常用 Tab 缩进?

gofmt 官方工具固定使用 Tab 缩进、宽度按 8 列显示,这是 Go 社区的统一风格,.editorconfig 只需沿用 indent_style = tab 即可。

Python 缩进应该填 2 还是 4?

PEP 8 推荐 4 个空格,绝大多数 Python 项目采用此约定;填写 4 空格可避免与官方风格指南冲突。

换行符 LF 和 CRLF 怎么选?

跨平台项目统一用 LF(end_of_line = lf),并在 Git 中配合 core.autocrlf 配置;仅 Windows 内部项目可用 CRLF。

Markdown 文件要注意什么?

Markdown 用行尾两个空格表示换行,因此要对 *.md 单独设置 trim_trailing_whitespace = false,避免保存时丢失语义。

E / 相关搜索

本页覆盖的长尾问题

editorconfig配置 统一编码格式 缩进规范 editorconfig生成器
F / 延伸

接着可以用的工具

本页结果均为基于公开常见口径的经验估算,仅供日常参考,不构成检测结论、安全承诺、税务意见或法律意见。所有输入仅在浏览器本地参与计算,不会上传或保存;涉及法律、税务、健康与安全的事项,请以官方规定与专业意见为准。

👣 做完这一步,顺便看看
🧰 乱码修复 / 文本编码转换 在线乱码修复工具:上传乱码文本文件或粘贴乱码字符串,用 UT… → 💻 假装工作模拟器 老板走近工位的一瞬间,点一下就能从摸鱼切回正经工作界面。代码… → 🧰 IP / 子网掩码计算器 在线子网计算器:输入 IP 地址与掩码(CIDR 前缀或点分… → ⏰ 下班倒计时 打工人专属下班计算器:实时倒计时距离下班还有多久、进度环显示… →
全部工具 →