一款命令行文本检查工具，把团队的写作规范转为检查规则，可在编辑器、CI 和代码中离线运行。
6276236GoMIT更新于 6天前
loeffel-io/ls-lint
一个快速的命令行工具，通过 .ls-lint.yml 配置文件检查项目中目录和文件的命名规范。
- Star
- 2,430
- Fork
- 46
- 未关闭 Issue
- 43
- 最近提交
- 昨天
这是什么？
ls-lint 根据你定义的规则检查项目中目录和文件的命名，支持 kebab-case、camelCase、PascalCase 等格式，也可以要求某些文件（例如测试文件）与源文件配套存在。规则写在一个或多个 .ls-lint.yml 文件中，通过路径模式为不同目录指定对应的命名约定。
它支持所有文件扩展名和 Unicode 文件名，可运行于 Windows、macOS 和 Linux。除了独立的二进制文件，还可以通过 npm、Homebrew 或 Docker 安装，并提供 GitHub Action 用于 CI 中执行检查。通过 ignore 配置可以跳过 node_modules 等目录。
该工具使用 Go 编写，仅依赖少量用于 YAML 解析和通配符匹配的库。
核心功能
- 01在 .ls-lint.yml 中按路径模式定义命名规则
- 02支持 kebab-case、camelCase、PascalCase 及正则表达式规则
- 03可要求测试等配套文件存在
- 04支持所有文件扩展名和完整 Unicode 文件名
- 05通过忽略规则跳过 node_modules 等目录
适用场景
- 在前端或 monorepo 项目中统一文件命名风格
- 在 CI 中合并 PR 前检查文件名规范
- 确认每个组件目录都包含必需的测试文件
快速上手
- 1
按 README 所列方式安装 npm 包 @ls-lint/ls-lint、Homebrew 公式或 Docker 镜像
- 2
创建 .ls-lint.yml 文件，定义目录和文件名的命名规则
标签
常见问题
- ls-lint 是什么？
- 一个快速的命令行工具，通过 .ls-lint.yml 配置文件检查项目中目录和文件的命名规范。 ls-lint 根据你定义的规则检查项目中目录和文件的命名，支持 kebab-case、camelCase、PascalCase 等格式，也可以要求某些文件（例如测试文件）与源文件配套存在。规则写在一个或多个 .ls-lint.yml 文件中，通过路径模式为不同目录指定对应的命名约定。
- ls-lint 可以免费使用吗？用的什么许可证？
- ls-lint 以 MIT 许可证开源。用于商业产品前，请先确认许可证条款。
- ls-lint 还在维护吗？
- 活跃维护中。ls-lint 最近一次提交是在 2026年10月21日。
- ls-lint 适合用来做什么？
- 在前端或 monorepo 项目中统一文件命名风格 在 CI 中合并 PR 前检查文件名规范 确认每个组件目录都包含必需的测试文件
- ls-lint 怎么安装和运行？
- 按 README 所列方式安装 npm 包 @ls-lint/ls-lint、Homebrew 公式或 Docker 镜像 创建 .ls-lint.yml 文件，定义目录和文件名的命名规则
- 在哪里获取 ls-lint？
- 源代码和安装说明在 GitHub 上：https://github.com/loeffel-io/ls-lint
概要由 AI 根据项目 README 生成；GitHub 数据每日更新。
相关项目
Black 是一款风格固定、结果确定的 Python 代码格式化工具，直接改写文件并尽量产生最小差异。
4.2万2940PythonMIT更新于 3天前
用 Go 编写的 Git hooks 管理工具，可并行执行提交、推送等钩子命令，适用于 Node.js、Ruby、Python 等多种项目。
8931325GoMIT更新于 昨天
开源静态分析工具，用接近源码的模式查找代码缺陷并执行编码规范，支持 30 多种语言。
1.7万1112CLGPL-2.1更新于 3天前
基于 Go 的轻量 Dockerfile 检查工具，提供 60 多条最佳实践规则、质量评分和安全检查。
2257GoApache-2.0更新于 9个月前
一款快速易用的命令行工具，用来按名称查找文件和目录，可替代 Unix 的 find 命令。
4.5万1180RustApache-2.0更新于 前天