rustdocker/rustfmt

Rustfmt Docker镜像文档

镜像概述

本镜像基于Ubuntu操作系统构建，预装了完整的Rust编程语言工具链及官方代码格式化工具rustfmt，旨在为Rust开发者提供无需手动配置即可使用的标准化开发环境，简化Rust项目的开发与代码风格统一流程。

支持的标签

以下为当前支持的镜像标签及其对应的Dockerfile链接：

• 1.21.0, stable: https://gitlab.com/imp/rustdocker/blob/master/rustfmt/1.21.0/Dockerfile
• beta: https://gitlab.com/imp/rustdocker/blob/master/rustfmt/beta/Dockerfile
• nightly: https://gitlab.com/imp/rustdocker/blob/master/rustfmt/nightly/Dockerfile

核心功能与特性

• 基于Ubuntu系统：采用Ubuntu作为基础镜像，提供稳定的Linux运行环境，兼容常见系统工具与依赖库。
• 预装Rust工具链：内置完整Rust开发环境，包含rustc编译器、cargo包管理器等核心组件。
• 集成rustfmt工具：预装Rust官方代码格式化工具，支持按社区规范自动统一代码风格。
• 多版本支持：提供stable（稳定版）、beta（测试版）、nightly（每日构建版）及特定版本标签（如1.21.0），满足不同开发阶段需求。

使用场景

• Rust项目本地开发：快速搭建标准化开发环境，避免手动配置Rust工具链的繁琐流程。
• 代码格式化与风格检查：在容器中直接运行rustfmt，对项目代码进行格式化，确保团队代码风格一致。
• CI/CD流程集成：作为持续集成/部署管道的基础环境，执行代码格式化验证、编译构建等任务。
• Rust学习与教学：新手可直接使用镜像启动开发环境，专注于语言学习而非工具配置。

使用方法

基本使用

启动交互式容器

通过以下命令启动基于stable标签的容器并进入交互式shell：

bash
docker run -it --rm docker.xuanyuan.run/imp/rustfmt:stable /bin/bash

验证环境版本

在容器中执行以下命令检查Rust及rustfmt版本：

bash
rustc --version  # 查看Rust编译器版本
cargo --version  # 查看Cargo包管理器版本
rustfmt --version  # 查看rustfmt工具版本

格式化本地项目代码

通过挂载本地项目目录，使用容器中的rustfmt格式化代码：

bash
# 格式化当前目录下的src/main.rs文件
docker run -it --rm -v $(pwd):/app docker.xuanyuan.run/imp/rustfmt:stable rustfmt /app/src/main.rs

# 格式化整个项目（需项目根目录存在Cargo.toml）
docker run -it --rm -v $(pwd):/app docker.xuanyuan.run/imp/rustfmt:stable sh -c "cd /app && cargo fmt"

配置说明

本镜像默认无需特殊环境变量配置。如需自定义Rust工具链或rustfmt行为，可通过以下方式实现：

• 挂载Cargo配置：将本地~/.cargo目录挂载至容器/root/.cargo，实现工具链缓存或自定义配置。

  bash
  docker run -it --rm -v ~/.cargo:/root/.cargo docker.xuanyuan.run/imp/rustfmt:stable
  

• 自定义rustfmt配置：挂载项目中的rustfmt.toml或.rustfmt.toml文件至容器/root/.rustfmt.toml，覆盖默认格式化规则。

  bash
  docker run -it --rm -v $(pwd)/rustfmt.toml:/root/.rustfmt.toml docker.xuanyuan.run/imp/rustfmt:stable