介绍
prettier-standard 是一个 npm 包,它将 Prettier 和 Standard 省略号 混合在一起,以便你可以让你的代码符合 Standard 的规范,同时又能够自动格式化代码,使得代码风格更加优雅。
安装
可以通过 npm 安装 prettier-standard。
npm install prettier-standard --save-dev
使用
命令行使用
使用 prettier-standard 可以将你的代码自动格式化并执行标准化检查。你只需要执行以下命令:
prettier-standard --write "src/**/*.{js,jsx}"
其中 "src/**/*.{js,jsx}"
是指需要格式化代码的路径。在这个例子中,将会格式化 src
目录下所有的 .js
和 .jsx
文件。
如果你想在执行完格式化之后也执行标准化检查,你只需要在命令后面添加 --lint
即可。
prettier-standard --write "src/**/*.{js,jsx}" --lint
除此之外,你还可以在 package.json
文件中添加以下脚本:
{ "scripts": { "prettier-standard": "prettier-standard --write \"src/**/*.{js,jsx}\" --lint" } }
这样你就可以通过执行 npm run prettier-standard
命令来自动格式化代码并执行标准化检查了。
编辑器插件使用
prettier-standard 提供了以下编辑器插件:
- VS Code 插件:prettier-standard-vscode
- Atom 插件:prettier-standard
在安装插件之后,你可以将你的代码格式化自动化,使得你每次保存文件之后都可以获得优美的代码风格。
示例代码
无格式化代码
-- -------------------- ---- ------- --- ------------- - ------------- ---- - --- -- - -------------- --- ---------- - -------------------- --- ------ - ----------- ------------------------------------------------ - ------------------ - ----------- -------------- - ------- ------------------------------ - ------------------------------ --- --- --展开代码
经过格式化的代码
-- -------------------- ---- ------- --- ------------- - ------------- ---- - --- -- - -------------- --- ---------- - -------------------- --- ------ - ----------- ------------------------- ----------------------- - ------------------ - ----------- -------------- - ------- ------ --------------- -- ---------------- - ------------------------------ --- --展开代码
经过标准化检查的代码
-- -------------------- ---- ------- ---- -------- --- ------------- - ------------- ---- - --- -- - -------------- --- ---------- - -------------------- --- ------ - ----------- ------------------------- ----------------------- - ------------------ - ----------- -------------- - ------- ------ --------------- -- ---------------- - ------------------------------ --- -- -------------- - --------------展开代码
总结
prettier-standard 是一个非常有用的npm 包,它可以自动格式化你的代码并使其符合标准化规范。通过使用它,你可以避免为了修改代码风格而浪费时间的问题,而可以专注于更加重要的任务。它不仅可以在命令行中使用,而且还可以通过编辑器插件实现自动格式化代码。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/40278