在开发过程中,我们常常需要写好的代码进行格式化以保证代码的可读性和一致性。而 pretty-quick
是一个非常方便的工具,可以帮助我们快速将代码格式化成规范的样式。
安装
使用 npm 进行安装:
npm install --save-dev pretty-quick
使用
1. 命令行方式
通过命令行运行 pretty-quick
可以对指定文件进行格式化,示例命令如下:
npx pretty-quick --staged // 对暂存区的文件进行格式化 npx pretty-quick app/**/*.js // 对 app 目录下所有 js 文件进行格式化
在 package.json 中配置 scripts,例如:
{ "scripts": { "precommit": "pretty-quick --staged" } }
这样在每次 git commit 前会自动执行 pretty-quick
进行代码格式化。
2. 集成到编辑器
将 pretty-quick
集成到编辑器可以让我们在保存文件时自动进行代码格式化,提高开发效率。
VS Code
在 VS Code 中安装 ESLint 和 Prettier - Code formatter 插件后,在项目根目录下添加 .prettierrc.js
文件,配置如下:
module.exports = { semi: true, trailingComma: 'es5', singleQuote: true, printWidth: 120, tabWidth: 2, }
在 VS Code 的 settings.json
中添加如下配置:
-- -------------------- ---- ------- - ---------------------- ----- --------------- - -------------------------- ------------------------ -- --------------- - -------------------------- ------------------------ - -展开代码
这样在保存 JS 或 TS 文件时会自动使用 pretty-quick
进行代码格式化。
总结
通过 pretty-quick
我们可以方便地对代码进行格式化,提高开发效率和代码质量。将其集成到编辑器中可以更加方便地使用,推荐大家尝试使用。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/39757