SuperAPI AI 工具集

ls-lint

通用与其它

查看项目

更新于 10-16 03:16

技能介绍

用途:ls-lint 是一个极快的目录与文件名检查器,用于在项目文件系统中强制执行命名规范。本技能针对 v2.3 版本;使用前应先用 ls-lint --version 或 npx @ls-lint/ls-lint --version 核对已安装版本,若版本不同需查阅对应官方文档 https://ls-lint.org 或 https://github.com/loeffel-io/ls-lint。

主要能力:可在毫秒内处理数千文件;通过 .ls-lint.yml 进行最小化配置;跨平台支持 Windows、macOS、Linux;支持完整 Unicode;依赖极少。内置六种命名规则:lowercase、camelCase、PascalCase、snake_case、SCREAMING_SNAKE_CASE、kebab-case,可用管道符 | 组合多条规则。

使用方式:安装可选用 npm install -D @ls-lint/ls-lint、npx @ls-lint/ls-lint、brew install ls-lint 或直接下载二进制。配置在项目根目录创建 .ls-lint.yml,包含 ls 与 ignore 两节。运行可用 npx @ls-lint/ls-lint,也可通过 --config 指定配置路径、--workdir 指定工作目录、--debug 诊断问题。

规则要点:支持 .dir 约束目录名、.* 通配所有扩展名、复合子扩展名(如 .d.ts、.test.ts)、目录特定规则覆盖全局规则、glob 与花括号可选路径模式、regex:^pattern$ 自定义正则、${0} 引用父目录名,以及 exists:1、exists:1-5、exists:0 等文件数量约束。还提供 GitHub Actions 集成与常见 JS/TS 项目、Monorepo 配置示例。

适用场景:在项目中统一文件与目录命名约定,并可在 CI 中自动检查。

限制:本资料仅记录 v2.3 版本内容,其他版本的配置语法与可用规则可能不同;资料未提供收费、价格及其他平台支持信息。