jobilla/lint Docker 镜像 - 轩辕镜像

Jobilla Lint基础镜像文档

镜像概述和主要用途

Jobilla lint基础镜像是Jobilla团队开发的专用代码检查工具镜像，旨在统一其JavaScript应用生态中的代码质量标准。该镜像集成了针对TypeScript（TS）、JavaScript（JS）和Vue.js的代码检查工具链，提供开箱即用的静态代码分析能力，帮助开发团队在开发流程中自动检测代码风格问题、语法错误及潜在缺陷，确保项目代码的一致性和可维护性。

核心功能和特性

• 多技术栈支持：原生支持TypeScript、JavaScript及Vue.js代码的静态检查，覆盖Jobilla内部常见的前端及JavaScript服务端技术栈。
• 标准化规则集：内置统一的代码检查规则配置，避免不同项目间因规则差异导致的协作成本，简化团队代码规范落地。
• 轻量级集成：镜像体积优化，可快速集成到本地开发环境或CI/CD流水线，无需手动配置复杂的依赖和工具链。
• 配置灵活性：支持通过外部挂载配置文件（如ESLint规则、TypeScript配置等）自定义检查规则，适应特定项目需求。

使用场景和适用范围

• Jobilla内部JavaScript项目：适用于所有基于TypeScript、JavaScript或Vue.js开发的内部应用，包括前端单页应用（SPA）、Node.js服务等。
• 本地开发环境：开发人员可在本地开发阶段通过该镜像实时检查代码，提前发现并修复问题，减少代码提交后的返工。
• CI/CD自动化检查：集成到GitLab CI、Jenkins等CI/CD系统中，在代码提交、合并请求或构建阶段自动执行检查，确保合入代码符合质量标准。

使用方法和配置说明

基本使用（本地开发环境）

通过docker run命令挂载项目目录并执行代码检查：

bash
docker run --rm -v /本地项目路径:/app jobilla/lint-base-image lint

参数说明：

• --rm：容器运行结束后自动删除，避免残留临时容器。
• -v /本地项目路径:/app：将本地项目根目录挂载到容器内的/app工作目录（镜像默认工作路径）。
• jobilla/lint-base-image：镜像名称（实际使用时需替换为Jobilla内部镜像仓库地址）。
• lint：镜像内置的代码检查入口命令，触发对/app目录下代码的检查。

自定义检查规则

如需使用项目特定的代码检查规则（而非镜像内置规则），可通过挂载项目本地配置文件实现：

bash
docker run --rm \
  -v /本地项目路径:/app \
  -v /本地项目路径/.eslintrc.js:/app/.eslintrc.js \  # 挂载ESLint配置
  -v /本地项目路径/tsconfig.json:/app/tsconfig.json \  # 挂载TypeScript配置（如适用）
  jobilla/lint-base-image lint

集成到CI/CD流程（以GitLab CI为例）

在项目的.gitlab-ci.yml中添加代码检查阶段，实现提交/合并时的自动检查：

yaml
stages:
  - lint

code-linting:
  stage: lint
  image: jobilla/lint-base-image  # 需配置GitLab Runner可访问的镜像地址
  script:
    - lint  # 执行镜像内置检查命令
  only:
    - main  # 主分支
    - merge_requests  # 合并请求
  artifacts:
    reports:
      codequality: lint-report.json  # 如镜像支持生成报告，可配置报告输出

检查结果说明

镜像执行检查后，将在控制台输出检查结果，包括：

• 代码中发现的问题数量及严重级别（错误/警告）。
• 具体问题所在文件路径、行号及描述。
• 若配置了报告输出（如JSON格式），可集成到CI平台的代码质量面板中展示。