nukengprodservice/eclint

NUK Engineering Productivity eclint 镜像文档

镜像概述和主要用途

本镜像为NUK工程团队开发的生产力工具，基于eclint（EditorConfig Linter）构建，旨在通过自动化代码风格检查，确保团队代码符合统一的EditorConfig规范。主要用途包括：检测代码格式偏离规则的问题、减少团队协作中的格式冲突、提升代码质量和开发效率。

核心功能和特性

• 多语言支持：兼容JavaScript、Python、Java、Go等主流编程语言的代码风格检查。
• EditorConfig规则集成：深度支持EditorConfig规范，可直接读取项目中的.editorconfig文件作为检查依据。
• 轻量级设计：镜像体积小，启动速度快，资源占用低。
• 灵活配置：支持通过命令行参数或自定义.editorconfig文件调整检查规则。
• CI/CD友好：可无缝集成到GitLab CI、Jenkins等持续集成/部署流程中。

使用场景和适用范围

适用场景

• 本地开发环境：开发人员在提交代码前进行本地格式检查，提前发现并修复格式问题。
• CI/CD流水线：作为代码提交或合并前的自动化检查环节，阻止不符合规范的代码进入仓库。
• 团队代码评审：辅助评审过程，减少因格式问题导致的无效沟通。

适用范围

• 多成员协作的软件开发项目。
• 需要统一代码格式规范的中大型项目。
• 使用EditorConfig进行代码风格管理的项目。

使用方法和配置说明

前提条件

• 已安装Docker环境。
• 项目根目录下存在有效的.editorconfig文件（若未提供，将使用默认规则）。

基本使用命令

本地检查代码

在项目根目录执行以下命令，检查当前目录下的代码格式：

bash
docker run --rm -v $(pwd):/app nuk-eclint:latest eclint check /app

• --rm：容器退出后自动删除。
• -v $(pwd):/app：将本地项目目录挂载到容器内的/app路径。
• eclint check /app：执行检查命令，目标路径为容器内的/app（即本地项目目录）。

自动修复格式问题

支持通过fix命令自动修复部分可修复的格式问题：

bash
docker run --rm -v $(pwd):/app nuk-eclint:latest eclint fix /app

配置说明

.editorconfig 文件

检查规则通过项目根目录的.editorconfig文件定义，示例配置：

ini
# .editorconfig 示例
root = true

[*]
indent_style = space
indent_size = 4
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.{js,ts}]
indent_size = 2

[*.py]
indent_size = 4

命令行参数

CI/CD集成示例（GitLab CI）

在.gitlab-ci.yml中添加以下配置，实现提交时自动检查：

yaml
code_style_check:
  image: nuk-eclint:latest
  stage: test
  script:
    - eclint check /app
  only:
    - merge_requests
    - main
  variables:
    GIT_STRATEGY: fetch

注意事项

• 确保挂载的项目目录权限正确，避免容器内无法读取文件。
• 对于复杂项目，建议在.editorconfig中细化规则（如按文件类型定义缩进大小）。
• fix命令仅能修复部分格式问题（如缩进、换行符），部分问题需手动调整。