pipelinecomponents/eslint

镜像概述

该镜像用于在GitLab CI/CD流水线中运行ESLint代码检查工具。ESLint安装在/app/目录下，便于使用前进行自定义配置。

Docker状态

• 镜像大小：https://hub.docker.com/r/pipelinecomponents/eslint
• 拉取次数：https://hub.docker.com/r/pipelinecomponents/eslint

使用方法

基础集成

作为流水线作业运行，若发现未被配置静音的问题，作业（及流水线）将失败。

yaml
eslint:
  needs: []  # 不依赖其他作业
  image: registry.gitlab.com/pipeline-components/eslint:latest
  before_script:
    - touch dummy.js  # 防止ESLint因无文件可检查而报错
  script:
    - eslint --color .  # 检查当前目录下所有文件，启用彩色输出

注意：

• 执行touch dummy.js是为避免ESLint抱怨没有文件可检查。
• 若无需自定义规则，可在命令中添加--no-config-lookup禁用配置查找。

GitLab代码质量集成

同样作为流水线作业运行，但发现问题时不会失败作业，而是通过GitLab的代码质量功能在合并请求视图中展示问题变化，辅助代码审查。

yaml
eslint:
  artifacts:
    reports:
      codequality: gl-codequality.json  # 生成代码质量报告文件
  image: registry.gitlab.com/pipeline-components/eslint:latest
  needs: []
  script:
    # ESLint发现问题时退出码为1（非错误），内部错误时退出码为2（需处理）
    - eslint --format gitlab . || [ $? == 1 ]

注意：

• 首次集成时，目标分支问题列表为空，可能显示大量问题；后续合并请求仅展示与当前更改相关的问题差异。
• 典型场景下无需配置ESLint忽略问题，可依赖第二位开发者结合GitLab提供的信息进行审查。

版本控制

项目采用语义化版本控制（Semantic Versioning）。

支持

• 查看***频道
• 提交issue

贡献指南

本项目为活跃开源项目，欢迎使用或贡献代码。详见贡献指南。

作者与贡献者

• 仓库初始设置：Robbert Müller
• 构建流水线基于https://github.com/hassio-addons（作者：https://github.com/frenck）
• 完整贡献者列表：查看贡献者页面

许可协议

本项目采用MIT许可（作者：Robbert Müller）。