declint:用 YAML 轻松编写自定义 Lint 规则,让代码检查更灵活(2026-10-05)
为什么你需要自定义 Lint 规则?
每个团队都有自己的编码规范:禁止使用 console.log、要求 API 调用必须加超时、强制组件文件命名与目录一致……但通用 Lint 工具(ESLint、Pylint)往往无法覆盖这些“内部约定”。
declint 的出现,让这件事变得前所未有的简单。你只需要写几行 YAML,就能创建一条专属的 Lint 规则。
declint 核心优势:YAML 即规则
传统 Lint 插件开发需要学习 AST 解析、编写 JavaScript 或 Python 逻辑。而 declint 采用声明式 YAML:
rule: no-console-in-production
description: 生产代码中禁止 console.log
severity: error
match:
pattern: "console\\.log\\("
file_pattern: "src/**/*.ts"
运行 declint check,所有匹配文件会立刻报错。无需编程,改规则就像改配置。
真实案例:某前端团队效率提升 40%
某 20 人前端团队将 15 条内部规范全部迁移到 declint,包括:
- API 请求必须包含
timeout字段 - 组件文件必须以
PascalCase命名 - 禁止在
utils/目录外使用lodash
迁移后,代码评审中关于格式的讨论减少 67%,新人上手时间从 3 天缩短到 1 天。
实用建议:如何开始
1. 从一条高频违规规则开始
不要一次性迁移所有规则。先选最常出现在评审中的那条,比如“禁止提交调试代码”。
2. 利用 fix 字段自动修复
fix: "// TODO: 移除 console.log"
declint 可自动插入注释,降低手动修改成本。
3. 结合 CI 管道
在 GitHub Actions 中加入:
- run: declint check --config .declint.yaml
违规即阻断合并,确保规范落地。
行动号召
现在就打开你的项目,创建 .declint.yaml,写下第一条规则。5 分钟后,你会拥有一个完全贴合团队习惯的 Lint 检查器。 访问 declint 官方文档获取完整示例库。
免责声明:本文内容基于 declint 公开文档及模拟案例,实际效果可能因项目环境而异。请根据团队情况调整规则配置。