pipelinecomponents/haskell-hlint

Haskell-Hlint Docker镜像文档

镜像概述

本镜像是Haskell代码检查工具Hlint的容器化实现，基于Alpine 3.15构建，专为GitLab CI等CI/CD环境设计，用于自动化执行Haskell项目的代码linting任务，帮助开发者发现代码中的潜在问题、风格不一致等问题。

核心功能与特性

• 轻量级基础：基于Alpine 3.15，镜像体积小，启动速度快
• 完整Hlint工具链：内置Hlint工具，支持Haskell代码的静态分析、语法检查和风格优化建议
• 配置灵活性：支持自定义.hlint.yaml配置文件，可通过命令生成默认配置
• 并行处理支持：通过-j参数启用并行检查，提升大型项目的linting效率

使用场景与适用范围

• CI/CD流水线集成：主要用于GitLab CI的linting阶段，自动化检查Haskell代码质量
• 本地开发辅助：可通过Docker命令在本地环境快速运行Hlint，无需手动安装Haskell环境
• Haskell项目质量管控：适用于各类Haskell项目，包括应用程序、库和框架的代码规范性检查

使用方法与配置说明

前提条件

使用前需确保项目中存在.hlint.yaml配置文件。若未创建，可通过以下命令生成默认配置：

bash
docker run --rm -ti pipelinecomponents/haskell-hlint:latest hlint -d > .hlint.yaml

GitLab CI配置示例

基础 linting 配置

在GitLab CI配置文件（.gitlab-ci.yml）中添加如下阶段配置：

yaml
haskell-hlint:
  stage: linting
  image: registry.gitlab.com/pipeline-components/haskell-hlint:latest
  script:
    - hlint .  # 检查当前目录下所有Haskell文件

并行处理配置

对于大型项目，可通过-j参数启用并行处理以提高效率：

yaml
haskell-hlint:
  stage: linting
  image: registry.gitlab.com/pipeline-components/haskell-hlint:latest
  script:
    - hlint -j .  # 并行检查当前目录下所有Haskell文件

命令参数说明

Hlint支持丰富的命令行参数，常用参数包括：

• -j：启用并行处理（默认使用所有可用CPU核心）
• -d：生成默认配置文件
• --color：启用彩色输出
• --json：输出JSON格式报告

更多参数详情可参考https://github.com/ndmitchell/hlint#installing-and-running-hlint%E3%80%82

版本控制

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

支持与反馈

• 问题咨询：通过***频道获取帮助
• 问题提交：在GitLab Issues提交问题