1. HBuilderX的格式化插件说明

插件名称对应插件配置中的名称是否内置可格式化的文件
js-beautifyformat内置插件vue、html、js、css、json
prettierformat-prettier非内置,需要下载less、sass、vue、stylus(vue内嵌)、ts、yaml
stylus-supremacyformat-stylus-supremacy非内置,需要下载格式化单独stylus文件

特别说明:

  • 当同时存在js-beautifyformat-prettier插件是,格式化vue文件,调用的是format-prettier插件
  • stylus-supremacy只支持格式化独立的stylus文件,如需格式化vue文件内的stylus代码,需要同时安装prettier插件

2 插件安装

点击菜单【工具】【插件安装】,在当前弹出的窗口中,找到相应格式化插件,然后安装。

本地插件目录:HBuilderX所有的插件,都存放于本地plugins目录下

3. 格式化插件配置

点击菜单【工具】【插件配置】,选择相应插件, 点击配置文件进行配置。

在格式化插件配置文件内,每项配置均有说明(或阅读插件中README.MD文件); 无说明文档的请参考插件官网配置说明。

格式化插件使用说明 - 图1

插件配置中格式化插件配置文件插件官网
formatformat/jsbeautifyrc.js官网
format-prettierformator-prettier/prettier.config.js官网
format-stylus-supremacyformator-stylus-supremacy/supremacy.config.js官网

4. 格式化快捷键

格式化菜单:【右键菜单】—>【重排代码格式】

格式化快捷键, win:ctrl + K; mac: command + K

自定义格式化快捷键: 点击菜单【工具】【自定义快捷键】,在【用户设置】中,拷贝如下代码, key为您要定义的快捷键

  1. {"key":"ctrl+k","command":"editor.action.format"}

5. 格式化风格

格式化时, 使用的缩进方式,是读取的菜单【工具 —> 设置】中的配置

格式化插件使用说明 - 图2

特别说明:editorconfig配置会覆盖HBuilderX编辑器配置;当项目下存在.editorconfig文件时,格式化时,读取的是此配置文件。.editorconfig使用说明文档

6. 保存文件时,自动格式化

部分小伙伴反馈, 如何实现保存文件时,自动格式化? 答: 不支持。

  • 普通web项目不支持保存文件的同时,自动格式化。
  • vue-cli项目,可通过配置eslint,通过eslint自动校验修复的功能,来实现相同的效果。例如:保存时,去除分号等。

eslint修复功能使用教程, 可直接看第三章