Prettier 命令行工具详解
Prettier 提供了丰富的命令行工具,可以灵活地进行代码格式化、检查和配置管理。
基本命令
1. 格式化文件
bash# 格式化单个文件 prettier --write index.js # 格式化多个文件 prettier --write src/**/*.js # 格式化所有支持的文件 prettier --write .
2. 检查文件格式
bash# 检查文件格式是否正确 prettier --check index.js # 检查多个文件 prettier --check "src/**/*.{js,jsx,ts,tsx}" # 检查所有文件 prettier --check .
3. 查看格式化差异
bash# 显示格式化后的差异 prettier --diff index.js # 列出需要格式化的文件 prettier --list-different "src/**/*.js"
常用选项
1. 配置相关
bash# 指定配置文件 prettier --config .prettierrc.custom --write index.js # 指定忽略文件 prettier --ignore-path .prettierignore.custom --write . # 禁用默认忽略 prettier --write --ignore-unknown index.js
2. 输出控制
bash# 输出到标准输出(不修改文件) prettier index.js # 指定输出目录 prettier --out-dir formatted src/**/*.js # 使用缓存 prettier --write --cache "src/**/*.js" # 清除缓存 prettier --write --cache --cache-strategy content "src/**/*.js"
3. 调试相关
bash# 显示调试信息 prettier --debug-check index.js # 显示使用的配置 prettier --find-config-path index.js # 显示解析器信息 prettier --help
高级用法
1. 与其他工具结合
bash# 与 find 结合使用 find src -name "*.js" | xargs prettier --write # 与 git 结合使用 git diff --name-only --diff-filter=ACM | grep '\.js$' | xargs prettier --write
2. 格式化特定文件类型
bash# 只格式化 JavaScript 文件 prettier --write "**/*.js" # 格式化多种文件类型 prettier --write "**/*.{js,jsx,ts,tsx,json,css,md}"
3. 使用 npx 运行
bash# 使用 npx 运行(无需全局安装) npx prettier --write index.js # 指定版本运行 npx prettier@2.8.0 --write index.js
实用脚本
在 package.json 中添加常用脚本:
json{ "scripts": { "format": "prettier --write \"src/**/*.{js,jsx,ts,tsx,json,css,md}\"", "format:check": "prettier --check \"src/**/*.{js,jsx,ts,tsx,json,css,md}\"", "format:staged": "lint-staged", "format:all": "prettier --write ." } }
常见问题解决
1. 文件编码问题
bash# 指定文件编码 prettier --write --encoding utf-8 index.js
2. 权限问题
bash# 使用 sudo 运行(不推荐) sudo prettier --write index.js
3. 性能问题
bash# 使用缓存提高性能 prettier --write --cache "**/*.js"
掌握 Prettier 命令行工具可以更高效地进行代码格式化管理。