grafana/tns-lint

TNS应用Lint镜像技术文档

镜像概述

TNS应用Lint镜像是专为TNS应用设计的静态代码分析工具镜像，集成了针对TNS项目的代码检查规则与分析引擎。通过自动化检测代码质量问题、编码规范遵循情况及潜在逻辑错误，帮助开发团队提升TNS应用代码质量，确保代码一致性与可维护性。

核心功能与特性

• 代码规范检查：内置TNS项目编码规范规则集，检测代码缩进、命名规范、注释格式、语法风格等合规性问题
• 潜在错误检测：识别未使用变量、空指针风险、类型不匹配、逻辑矛盾等代码缺陷
• 代码质量评估：提供代码复杂度、重复率、注释覆盖率等关键质量指标分析
• 多文件类型支持：兼容TNS应用常用源代码类型（如JavaScript/TypeScript、Java、Python等，具体取决于TNS技术栈）
• 灵活配置扩展：支持自定义检查规则文件、忽略特定文件/目录，适配不同开发场景需求

使用场景与适用范围

• 开发阶段本地检查：开发人员在编写代码后，通过镜像对本地代码进行实时检查，提前发现并修复问题
• CI/CD流程集成：作为CI/CD流水线的质量门禁环节，在代码提交或构建前自动执行检查，阻止不合规代码进入后续流程
• 代码审查辅助：生成标准化检查报告，辅助代码审查过程，减少人工审查成本，聚焦关键逻辑问题
• 存量代码质量监控：定期对TNS应用存量代码进行扫描，持续跟踪代码质量变化趋势

使用方法与配置说明

基本使用（Docker Run）

通过以下命令启动容器，对本地TNS应用代码进行检查：

bash
docker run --rm -v /本地/tns应用代码路径:/app tns-lint:latest lint /app/src

参数说明：

• --rm：容器退出后自动清理容器文件系统
• -v /本地/tns应用代码路径:/app：将本地TNS应用代码目录挂载到容器内/app工作目录
• tns-lint:latest：TNS Lint镜像名称及标签（请替换为实际镜像标签）
• lint /app/src：执行代码检查命令，指定检查路径为容器内挂载的/app/src目录（根据实际代码结构调整路径）

自定义配置

环境变量配置

通过环境变量调整检查行为，支持以下参数：

示例（指定输出格式与自定义规则）：

bash
docker run --rm \
  -v /本地/tns代码:/app \
  -v /本地/custom-rules.json:/app/config/custom-rules.json \
  -e LINT_RULES=/app/config/custom-rules.json \
  -e OUTPUT_FORMAT=json \
  tns-lint:latest lint /app/src

规则文件配置

自定义规则文件（如custom-rules.json）示例结构：

json
{
  "rules": {
    "indentation": 2,  // 强制2空格缩进
    "max-line-length": 120,  // 最大行长度120字符
    "allow-unused-vars": false,  // 禁止未使用变量
    "required-comment-types": ["function", "class"]  // 函数/类必须有注释
  },
  "excluded-patterns": ["**/node_modules/**", "**/dist/**"]  // 排除检查路径
}

CI/CD集成示例（GitLab CI）

在.gitlab-ci.yml中配置Lint检查步骤：

yaml
stages:
  - quality-check

tns-lint-check:
  stage: quality-check
  image: tns-lint:latest
  script:
    - lint /builds/your-org/tns-app/src  # 检查CI工作目录下的代码
  variables:
    OUTPUT_FORMAT: "html"
    CHECK_LEVEL: "high"
  artifacts:
    paths:
      - lint-report.html  # 保存HTML报告作为制品
    expire_in: 1 week
  only:
    - merge_requests
    - main

注意事项

• 确保挂载的本地代码目录具有读取权限，容器内默认以非root用户运行
• 自定义规则文件需符合镜像内置Lint引擎的格式要求，具体规则字段可参考TNS项目《编码规范文档》
• 大规模代码检查建议分模块执行（如按功能目录），避免单次检查耗时过长
• 检查结果默认输出至标准输出（stdout），指定OUTPUT_FORMAT=html/json时需通过-v挂载目录保存报告文件（如-v /本地/output:/report -e OUTPUT_PATH=/report/lint-report.html）