greut/eclint

eclint - EditorConfig代码检查工具 ★

镜像概述

eclint是一个用Go语言编写的EditorConfig代码检查工具（linter），作为https://github.com/jedmao/eclint%E7%9A%84%E6%9B%BF%E4%BB%A3%E6%96%B9%E6%A1%88%EF%BC%8C%E6%8F%90%E4%BE%9B%E9%AB%98%E6%95%88%E7%9A%84%E4%BB%A3%E7%A0%81%E9%A3%8E%E6%A0%BC%E9%AA%8C%E8%AF%81%E5%8A%9F%E8%83%BD%E3%80%82

核心功能与特性

• EditorConfig规范验证：检查文件是否符合EditorConfig配置中定义的代码风格规则（如缩进方式、换行符、文件结尾、字符集等）
• 跨平台支持：基于Go语言开发，可在多种操作系统环境下运行
• 轻量级设计：相比JavaScript版本，具有更快的执行速度和更低的资源占用

使用场景与适用范围

• 开发团队代码风格一致性保障
• 集成到CI/CD流程中进行自动化代码风格检查
• 本地开发环境的代码风格实时验证
• 项目迁移或重构时的代码风格统一处理

使用方法与配置说明

基本使用方式

通过Docker运行eclint容器，挂载目标项目目录并执行检查命令：

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

命令说明

• check：eclint的核心命令，用于检查指定目录或文件是否符合EditorConfig规范
• /app：容器内的挂载路径，对应宿主机的当前目录（通过-v $(pwd):/app实现挂载）

典型应用示例

检查单个文件

bash
docker run --rm -v $(pwd):/app greut/eclint check /app/src/main.go

检查多个目录

bash
docker run --rm -v $(pwd):/app greut/eclint check /app/src /app/tests

与EditorConfig配置文件配合使用

确保项目根目录存在.editorconfig文件，eclint将自动读取并应用其中的规则。例如：

ini
# .editorconfig示例
root = true

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

运行检查命令时，eclint会根据上述配置验证文件格式。