guangie88/rustfmt-clippy

rustfmt-clippy

镜像概述和主要用途

rustfmt-clippy是一个Rust环境Docker镜像，旨在为CI/CD流程提供简单易用的代码格式化和静态分析（linting）设置。该镜像定期通过CI自动构建并推送到Docker仓库，支持stable、beta和nightly三种Rust工具链，底层基于Debian系统，可由任意用户执行操作。

核心功能和特性

包含的可执行文件

• cargo 和 rustc
• rustfmt（即 cargo fmt，用于代码格式化）
• clippy（即 cargo clippy，用于代码静态分析）

包含的开发库

• default-libmysqlclient-dev
• libpq-dev
• libsqlite3-dev
• libssl-dev
• libcurl4-openssl-dev
• zlib1g-dev

使用场景和适用范围

适用于Rust项目的CI/CD流程，可快速集成代码格式化检查（rustfmt）和静态分析（clippy）步骤，确保代码风格一致性和质量。也可用于本地开发环境，执行cargo相关命令（如构建）。

使用方法和配置说明

基本使用

Rust项目目录的指定挂载路径为 /volume。假设当前工作目录（pwd）为待处理的Rust项目目录，可通过以下命令运行：

bash
# 代码格式化
docker run --rm -it -v `pwd`:/volume -u `id -u`:`id -g` guangie88/rustfmt-clippy:stable cargo fmt

# 静态分析
docker run --rm -it -v `pwd`:/volume -u `id -u`:`id -g` guangie88/rustfmt-clippy:stable cargo clippy

# 项目构建
docker run --rm -it -v `pwd`:/volume -u `id -u`:`id -g` guangie88/rustfmt-clippy:stable cargo build

注意事项

• 上述命令以当前主机用户身份运行，Cargo缓存会保存在项目目录下的 .cargo 文件夹中。
• 若频繁使用该镜像进行开发，建议将 .cargo 添加到 .gitignore 中。

工具链选择

• 推荐使用 stable 标签（对应Rust的stable工具链）。
• latest 标签自2019年7月6日起已弃用。
• 若必须使用 nightly 工具链，建议固定版本标签（如 nightly-yyyy-mm-dd），因为不同日期的nightly构建可能存在不稳定性。

CI构建脚本示例

CI环境中构建镜像的脚本如下：

bash
docker build \
    --build-arg RUST_CHANNEL=${RUST_CHANNEL} \
    -t guangie88/rustfmt-clippy:${RUST_CHANNEL} \
    .

其中，RUST_CHANNEL 为工具链参数，可取值 stable、beta 或 nightly。

致谢

本仓库受 https://github.com/clux/muslrust 启发，感谢原作者。