tmknom/prettier

Prettier

镜像概述与主要用途

本镜像为Prettier的Docker包装实现。Prettier是一款"有主见的代码格式化工具"，其核心用途是通过解析代码并应用内置规则重新格式化，强制保持项目代码风格的一致性。本镜像基于Alpine Linux构建，提供轻量级容器化方案，弥补了官方未提供Docker镜像的空白。

核心功能与特性

• 强制一致代码风格：通过解析代码结构，使用Prettier内置规则重印代码，消除团队代码风格差异
• 智能行长度处理：自动考虑最大行长度限制，必要时自动换行，平衡代码可读性与规范
• 轻量级实现：基于Alpine Linux构建，镜像体积小，资源占用低，部署效率高
• 原生命令支持：完全兼容Prettier所有命令行参数，可灵活配置格式化行为

使用场景与适用范围

• 多语言项目格式化：支持JavaScript、TypeScript、CSS、HTML、Markdown等多种文件类型的格式化
• 团队协作规范：统一团队代码风格，减少因格式问题产生的代码评审争议
• CI/CD流程集成：作为代码提交前的自动化检查步骤，确保提交代码符合格式规范
• 文档格式化：适用于Markdown等文档的自动化格式整理，保持文档结构清晰

使用方法与配置说明

前置要求

• 本地已安装Docker环境
• 待格式化文件所在目录需通过卷挂载供容器访问

基础使用语法

容器默认工作目录为/work，需通过-v参数将本地目录挂载至该路径，使工具能访问目标文件。基本命令结构：

shell
docker run --rm -v [本地目录]:/work tmknom/prettier [Prettier参数] [目标文件]

常用操作示例

格式化Markdown文件

将指定Markdown文件格式化并写入修改结果：

shell
docker run --rm -v $(pwd):/work tmknom/prettier --write --parser=markdown README.md

参数说明：

• --rm：容器运行结束后自动删除
• -v $(pwd):/work：挂载当前目录至容器工作目录
• --write：将格式化后的内容写回原文件
• --parser=markdown：指定使用Markdown解析器（根据文件类型选择，如babel、typescript等）
• README.md：目标格式化文件（相对于挂载目录的路径）

检查文件格式合规性

仅检查文件格式是否符合规范，不修改文件内容：

shell
docker run --rm -v $(pwd):/work tmknom/prettier --check --parser=markdown README.md

说明：--check参数会返回格式检查结果，若存在未格式化内容，命令退出码为非零，可用于CI流程中的格式校验。

查看命令帮助

获取Prettier完整参数说明：

shell
docker run --rm tmknom/prettier --help

Docker镜像获取

Docker Hub

shell
docker pull tmknom/prettier

详细信息参见https://hub.docker.com/repository/docker/tmknom/prettier

GitHub Packages

shell
docker pull ghcr.io/tmknom/dockerfiles/prettier

详细信息参见https://github.com/tmknom/dockerfiles/pkgs/container/dockerfiles%2Fprettier

支持平台

• linux/amd64
• linux/arm64

源码仓库

• https://github.com/tmknom/dockerfiles/

许可证

采用Apache 2.0许可证。完整许可协议参见https://github.com/tmknom/dockerfiles/blob/master/LICENSE%E3%80%82