lslintorg/ls-lint

极速文件目录命名检查工具镜像

镜像概述

本镜像是一个轻量级、高性能的文件和目录名称检查工具（linter），专为快速验证文件系统命名规范设计。通过优化的文件遍历算法和规则引擎，可在毫秒级完成对大型目录结构的命名合规性检查，帮助团队和项目维护统一的文件命名标准。

核心功能与特性

• 极速扫描性能：采用高效文件系统遍历逻辑，比传统命名检查工具快10-50倍，支持TB级文件系统快速检查
• 灵活规则验证：内置常见命名规范（如蛇形命名、驼峰命名、长度限制等），同时支持自定义正则表达式规则
• 轻量级设计：镜像体积小于10MB，启动时间<100ms，资源占用极低，适合嵌入式环境
• 多场景输出：支持文本、JSON、XML等多种报告格式，便于集成到日志系统或CI/CD仪表盘
• 跨平台兼容：支持Linux/Windows/macOS文件系统，正确处理不同系统的路径分隔符和权限

使用场景与适用范围

开发流程集成

• 代码提交前检查：作为git pre-commit钩子，在代码提交前自动验证新增文件命名
• CI/CD流水线：集成到GitHub Actions、GitLab CI、Jenkins等流程，阻断不符合命名规范的构建
• IDE插件后端：作为VS Code、JetBrains等IDE插件的后端服务，实时提供命名建议

项目管理场景

• 大型代码库维护：对历史遗留项目进行批量命名审计，生成整改报告
• 多团队协作：统一跨团队项目的文件命名标准，减少沟通成本
• 开源项目治理：作为贡献者指南的自动化检查工具，确保PR符合项目命名规范

使用方法与配置说明

基本使用示例

检查当前目录

bash
docker run --rm -v $(pwd):/target fast-name-linter /target

指定输出格式为JSON

bash
docker run --rm -v $(pwd):/target fast-name-linter /target --format json > naming-report.json

排除特定目录

bash
docker run --rm -v $(pwd):/target fast-name-linter /target --exclude node_modules,dist

高级配置

通过配置文件自定义规则

1. 创建配置文件 naming-rules.yaml：

yaml
rules:
  - name: "snake_case"
    pattern: "^[a-z0-9_]+$"
    apply_to: "files"  # 可选：files, directories, both
  - name: "max_length"
    max_length: 50
    apply_to: "both"
exclude:
  - ".git"
  - "vendor"

2. 挂载配置文件并使用：

bash
docker run --rm -v $(pwd):/target -v $(pwd)/naming-rules.yaml:/config/rules.yaml fast-name-linter /target --config /config/rules.yaml

环境变量说明

CI/CD集成示例（GitHub Actions）

yaml
name: Naming Lint
on: [pull_request]

jobs:
  name-lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Run name linter
        run: |
          docker run --rm -v $(pwd):/target fast-name-linter /target --strict

注意事项

• 挂载目录时需确保容器对目标目录有读取权限
• 对于符号链接，默认跟随解析，可通过--no-follow-symlinks禁用
• Windows系统下路径需使用PowerShell格式：docker run --rm -v ${PWD}:/target fast-name-linter /target