megabytelabs/eslint

ESLint v8.x.x CodeClimate引擎

由Megabyte Labs维护的轻量级Docker镜像和CodeClimate引擎。

概述

本项目是ESLint 8的CodeClimate引擎，旨在将ESLint检查结果集成到GitLab合并请求的Web UI中。它基于https://github.com/codeclimate/codeclimate-eslint%E6%9E%84%E5%BB%BA%EF%BC%8C%E4%BD%86%E8%BF%9B%E8%A1%8C%E4%BA%86%E6%9B%B4%E6%96%B0%E4%BB%A5%E9%80%82%E5%BA%94%E6%9C%80%E6%96%B0%E9%9C%80%E6%B1%82%E3%80%82%E8%AF%A5%E5%BC%95%E6%93%8E%E5%9C%A8%E8%BF%90%E8%A1%8C%E6%97%B6%E4%BC%9A%E8%87%AA%E5%8A%A8%E4%BB%8ENPM%E6%9B%B4%E6%96%B0%E6%89%80%E4%BD%BF%E7%94%A8%E7%9A%84ESLint%E9%85%8D%E7%BD%AE%EF%BC%8C%E9%BB%98%E8%AE%A4%E9%85%8D%E7%BD%AE%E4%B8%BAhttps://github.com/ProfessorManhattan/eslint-config-strict-mode%EF%BC%8C%E9%80%82%E7%94%A8%E4%BA%8ETypeScript%E3%80%81JavaScript%E3%80%81YML%E5%92%8CJSON%E6%96%87%E4%BB%B6%E3%80%82

独立使用

若无需CodeClimate集成，可使用不带CodeClimate相关代码的镜像，只需从镜像名称中移除codeclimate-字符串。例如，megabytelabs/codeclimate-eslint对应的独立镜像为megabytelabs/eslint。完整镜像列表可查看https://hub.docker.com/r/megabytelabs/eslint%E3%80%82

轻量级构建

所有CodeClimate引擎项目均提供两种变体：常规构建（基于根目录Dockerfile构建）和slim构建（通过DockerSlim生成）。若追求稳定性并希望使用slim构建，建议指定确切版本（如megabytelabs/codeclimate-package:5.4.0-slim而非megabytelabs/codeclimate-package:slim）。

版本控制

尽可能使用对应软件版本标记Docker镜像。例如，megabytelabs/codeclimate-eslint:5.4.0通常包含ESLint 5.4.0版本（可能存在例外）。

测试

通过多种方式确保latest和slim构建正常工作：使用Dockerfile-test.yml进行容器结构测试，对比test/compare/目录下样本项目的输出结果，以及对CodeClimate引擎自定义代码进行单元测试。

要求

• Docker

开发要求

• DockerSlim - 用于生成紧凑、安全的镜像
• jq - 用于JSON交互
• Node.js (>=14.18) - 用于添加预提交钩子和维护任务等开发功能
• 其他动态安装的需求（通过Taskfile.yml和自定义https://github.com/go-task/task%E5%88%86%E6%94%AF**https://github.com/ProfessorManhattan/Bodega** 管理）

若使用项目提供的开发工具，需运行bash start.sh（或npm i，后者会在完成后调用bash start.sh）。start.sh脚本会自动安装构建系统中缺失的依赖（无需sudo）至用户~/.local/bin目录，并生成文档等。开发就绪后，可运行task --menu打开交互式对话框了解可用构建命令。

示例

本地测试

通过以下命令在本地测试工具，无需本地安装ESLint，使用后自动清理镜像：

shell
docker run -it -v ${PWD}:/work -w /work --rm megabytelabs/eslint:latest --help

Bash别名设置

将以下代码添加到~/.profile（或等效文件），以便随时运行ESLint命令：

shell
eslint() {
    docker run -it -v ${PWD}:/work -w /work --rm megabytelabs/eslint:latest "$@"
}

注意：部分CLI工具无参数时默认运行（如ansible-lint），本Docker镜像默认命令为显示版本，因此需运行ansible-lint .等带参数命令。

GitLab CI集成

CodeClimate GitLab CI配置示例

若需增强GitLab合并请求Web UI，可参考CodeClimate GitLab CI配置。由于GitLab CI仅接受一个CodeClimate报告工件，需在单个CI阶段运行所有检查器。

CodeClimate CLI使用步骤

1. 在项目根目录创建.codeclimate.yml，至少包含：

yml
---
engines:
  eslint:
    enabled: true
exclude_paths:
  - 'node_modules/**'

2. 拉取并标记镜像：

shell
docker pull megabytelabs/codeclimate-eslint:latest
docker tag megabytelabs/codeclimate-eslint:latest codeclimate/codeclimate-eslint:latest

3. 安装并运行CodeClimate CLI：

shell
brew install codeclimate/formulae/codeclimate
codeclimate analyze --dev

生成HTML报告：

shell
codeclimate analyze --dev -f html > codeclimate-report.html

独立集成

在GitLab CI中集成而不使用CodeClimate，需在项目根目录创建.gitlab-ci.yml：

yaml
---
stages:
  - lint

include:
  - remote: https://gitlab.com/megabyte-labs/gitlab-ci/-/raw/master/lint/eslint.gitlab-ci.yml

建议将远程配置复制到本地，避免依赖外部变更。

关于ESLint的更多信息

ESLint是一款CLI工具，用于发现和修复JavaScript/TypeScript代码问题，也支持JSON和YAML文件。其特色是自动修复错误（如按字母顺序排序对象、JSON和YML）。使用本CodeClimate引擎/独立检查器需在项目中配置ESLint。

可共享配置

我们维护的https://github.com/ProfessorManhattan/eslint-config-strict-mode 集成了多数优秀ESLint插件，避免重复报告，启用尽可能多的规则（同时兼顾合理性），并根据项目类型（在package.json的blueprint.group和blueprint.subgroup中定义）启用/禁用规则。配置方法见该项目页面。

构建Docker容器

修改Dockerfile后，可通过以下命令上传自定义容器至Docker Hub：

shell
export DOCKERHUB_USERNAME=你的DockerHub用户名
export DOCKERHUB_PASSWORD=你的DockerHub密码
docker login -u "$DOCKERHUB_USERNAME" -p "$DOCKERHUB_PASSWORD" docker.io
docker build --pull -t "$DOCKERHUB_USERNAME/eslint:latest" .
docker push "$DOCKERHUB_USERNAME/eslint:latest"

构建轻量级容器

部分仓库支持通过DockerSlim创建slim构建，可减小镜像大小并提升安全性（减少***面）。运行npm i（或无Node.js时运行bash start.sh）后，执行task docker:build可同时构建latest和slim版本。

手动构建并发布slim镜像：

shell
export DOCKERHUB_USERNAME=你的DockerHub用户名
export DOCKERHUB_PASSWORD=你的DockerHub密码
docker login -u "$DOCKERHUB_USERNAME" -p "$DOCKERHUB_PASSWORD" docker.io
docker build -t "$DOCKERHUB_USERNAME/eslint:latest" .
docker-slim build --tag $DOCKERHUB_USERNAME/eslint:slim $DOCKERHUB_USERNAME/eslint:latest
docker push "$DOCKERHUB_USERNAME/eslint:slim"

可修改package.json中的blueprint.dockerSlimCommand调整构建命令。

构建工具

仓库中的额外文件用于简化团队开发，确保可预测性和效率。安装Node.js后运行npm i（或无Node.js时运行bash start.sh），可使用构建工具。运行task --list查看可用命令，或task --menu打开交互式菜单。

注意：我们使用自定义版本的https://github.com/go-task/task%EF%BC%8C%E8%8B%A5%E5%B7%B2%E5%AE%89%E8%A3%85%E9%9C%80%E6%9B%BF%E6%8D%A2%E6%88%96%E4%BD%BF%E7%94%A8%E4%B8%8D%E5%90%8C%E5%91%BD%E4%BB%A4%E5%90%8D%E3%80%82

理念

持续集成（CI）工具可显著提升开发效率，如扫描代码错误、自动部署软件。本仓库的Docker容器是CI拼图的一部分，几乎所有CI流水线Docker项目均单一用途。

内部构建容器可确保代码透明性，同时最小化镜像大小以加速CI环境下载和运行。基于本仓库，你也可轻松创建内部CI流水线容器镜像。

仓库中的点文件（如.config）是开发配置，用于简化开发、提高效率，并通过严格标准确保团队开发的一致性。

贡献

欢迎贡献、报告问题和提出功能请求！可查看https://github.com/ProfessorManhattan/codeclimate-eslint/issues%E3%80%82%E8%B4%A1%E7%8C%AE%E5%89%8D%E8%AF%B7%E5%8F%82%E8%80%83https://github.com/ProfessorManhattan/codeclimate-eslint/blob/master/docs/CONTRIBUTING.md%E3%80%82

许可

© 2020-2021 Megabyte LLC。本项目采用MIT许可。