用户登录

虽然 JavaScript 规定了一些写法,但是对代码的排版并没有太严格的要求,比如什么时候应该换行,括号里是不是要加空格等等。这就导致大家写的代码风格都会有一些差别,我们可以使用一些自动排版代码的工具,帮我们规范一下,这里要用的是 Prettier 这个工具。

Prettier 是个包,可以把它安装在项目里面,作为项目的开发依赖,执行这个包的命令行工具可以自动排版代码,另外 VSCode 编辑器里有个 Prettier 插件,可以把它安装在编辑器上。

先安装一下 Prettier 这个包,在终端,项目所在目录的下面,执行:

npm install prettier@1.19.1 --save-dev --save-exact

这个包里带了一个命令行工具,你可以在项目的 node_modules/.bin 目录里找到,名字是 prettier。在项目里可以再自定义一个命令,打开 package.json,在 scripts 里面,添加一个 format 命令,像这样:

"format": "prettier --write \"src/**/*.ts\""

上面定义的 format 命令,实际上用的就是 prettier 命令行工具,后面设置了一下要排版代码的文件,这里就是 src 目录里所有的 .ts 后缀的文件。使用 Prettier 的时候,它会读取一个配置文件,我们可以通过这个文件配置一下 Prettier 格式化代码时的行为。在项目根目录下面,创建一个文件,名字是 .prettierrc,内容如下:

{
"singleQuote": true,
"trailingComma": "all"
}

现在就可以用 Prettier 排版代码了,在终端,项目所在目录的下面,执行:

npm run format

现在想要排版编写的代码,就在终端执行 format 命令。另外我们也可以额外再给 VSCode 编辑器安装一个 Prettier 扩展,可以配置一下,保存文件的时候自动使用 Prettier 排版文件里的代码。

macOS 用户按下 command + shift + X ,Windows 用户按下 ctrl + shift + X,打开编辑器的 扩展 ,然后搜索 Prettier 关键词,找到相关的扩展,把它安装在编辑器上。完成以后还要做点配置,打开编辑器的 配置,搜索 Format On Save,勾选 “在保存时格式化文件” 选项,这样保存文件就会自动用 Prettier 排版文件里的代码。

自动排版代码《 Node.js 服务端应用开发:工作流程 》

统计

15260
分钟
0
你学会了
0%
完成

社会化网络

关于

微信订阅号

扫描微信二维码关注宁皓网,每天进步一点