简介
Prettier 是一种代码格式化工具，可通过插件机制扩展。prettier-plugin-sh 就是其中的一款插件，用于格式化 shell 脚本。
使用 prettier-plugin-sh 可以极大地减少代码 review 中因为格式不统一而产生的浪费时间，更加专注于代码本身。
安装
prettier-plugin-sh 需要 prettier 作为依赖，因此在安装 prettier-plugin-sh 时会一并安装 prettier。
在项目中安装 prettier-plugin-sh：
npm install prettier prettier-plugin-sh --save-dev
使用
安装后，在项目的 package.json 文件中添加以下配置：
{
"prettier": {
"plugins": ["prettier-plugin-sh"]
}
}然后在 package.json 所在目录下执行以下命令：
npx prettier --write .
这个命令会格式化所有的 shell 脚本文件，--write 参数会将修改直接写入文件。
示例
假设有如下的 shell 脚本文件 hello.sh：
-- -------------------- ---- ------- ----------- -------- ------- - ---- ------- ------ - ---- ----- -- ---- ------ ---- ---- -----
执行命令 npx prettier --write ./hello.sh 后，hello.sh 的内容会被改写为：
-- -------------------- ---- ------- ----------- -------- ------- - ---- ------- ------ - ---- ----- -- ---- ------ ---- ---- -----
可以看到，prettier-plugin-sh 会自动对缩进进行调整，使得代码的结构更加清晰。
深入
prettier-plugin-sh 支持的格式化配置项较为丰富，以下是一些常用选项的介绍：
indent: 用于配置缩进的字符或字符串，默认值为 2。paterns: 用于配置需要被格式化的文件名或文件路径，可以使用 glob 模式来匹配多个文件，例如{src,test}/**/*.sh表示匹配src和test目录下的所有 shell 脚本文件。singleQuote: 用于配置是否使用单引号包裹字符串，默认为false。
在 package.json 中添加配置项：
-- -------------------- ---- -------
-
----------- -
---------- -----------------------
------------- ---
----------- --
-------------- -----
----------- ---------------
-
-然后在命令行执行 npx prettier --write . 命令，即可格式化所有匹配到的 sh 文件。
总结
prettier-plugin-sh 是一个非常实用的工具，能够有效地提高代码的可读性和可维护性。在使用时，可以根据实际需求来配置不同的选项，以达到最佳的效果。希望此篇教程能对前端开发者有所启发和帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedabadb5cbfe1ea061081b