configuration

扩展点是通过在插件package.json文件中contributes节点下定义的一些JSON格式的配置项。以下是目前HBuilderX支持的扩展点列表：

configuration

configuration扩展点，会将扩展的配置项注册到HBuilderX的全局可视化配置里设置-插件配置。

configuration属性列表

title

每个插件扩展的配置是分配到同一组下的，title指的是该组的名称，一般写的是插件名称。

properties

properties内配置的是一个jsonobject对象，该对象的key代表着要扩展的配置项id，value是一个符合JSON Schema规范的jsonobject，目前支持的字段包括：

• type 类型。支持的类型包括：string、boolean、number。
• description 描述
• default 默认值
• enum 可选值，目前只有type为string或number时可用

configuration示例

    "contributes": {
        "configuration":{
            "title":"eslint-js",
            "properties":{
                "eslint-js.autoFixOnSave":{
                    "type":"boolean",
                    "default":true,
                    "description":"保存时自动修复"
                },
                "eslint-js.validateOnDocumentChanged":{
                    "type":"boolean",
                    "default":false,
                    "description":"启用实时校验"
                }
            }
        }
    }

效果图如下：

commands

commands扩展点用于声明一个命令，命令可以通过menus扩展点和菜单关联到一起

注意：当一个命令将要执行时，将会触发一个onCommand:${commandId}的activationEvent用于激活监听该命令的插件

示例

    "contributes": {
        "commands": [
          {
            "command": "extension.firstExtension",
            "title": "Hello World"
          }
        ]
    }

keybindings

keybindings扩展点, 仅对HBuilderX 3.1.22+版本生效。

keybindings扩展点用于声明快捷键绑定.

示例

"keybindings":[
    {
        "command":"extension.firstExtension",    // command为您开发的插件中的command
        "key":"Ctrl+Shift+C",                    // key为要绑定的快捷键
        "when":"",                               // when表达式用来动态的判断某个条件是否满足，强烈建议设置此项。
        "macosx":"command+Shift+C"               // MacOSX系统的快捷键；如不设置此项，MacOSX系统，会将key中的ctrl转为command
    }
]

snippets

snippets扩展点可以扩展指定编程语言的代码块，可扩展的编程语言Id列表见这里。扩展示例代码如下：

    "contributes": {
        "snippets": [
          {
            "language": "css",
            "path": "./snippets/css.json"
          },
          {
            "project":"uni-app",
            "language": "css",
            "path": "./snippets/condition_comment.json"
          }
        ]
    }

属性列表

代码块格式

每个配置项的说明如下表：

代码块示例

// ./snippets/javascript.json
{
    "console.log": {
        "prefix": "logtwo",
        "body": [
            "console.log('$1');",
            "\tconsole.log('${2:foo/bar}');"
        ],
        "triggerAssist": false,
        "description": "Log output to console twice"
    }
}

viewsContainers

在窗体左侧区域扩展一个和项目管理器同级的tab项，完整的扩展视图流程参考如何注册一个新的视图？

属性列表

示例

   "contributes": {
       "viewsContainers": {
           "activitybar": [{
               "id": "demoview",
               "title": "DemoView"
           }],
           "rightside":[{
                   "id":"rightsideContainerId",
                   "title":"rightside Container Title"
          }]
       },
       "views": {
           "demoview": [{
               "id": "extensions.treedemo",
               "name": "DemoView"
           }]
       },
       ...
    }

ViewsContainerDef

views

扩展新的视图，扩展的view必须和viewsContainers内定义的视图容器绑定以后才能生效。

目前支持TreeView和WebView，并且一个视图容器（viewsContainers）仅支持绑定一个视图（view）。

在该扩展点声明后，需要通过API：window.createTreeView或者window.createWebView实现。完整的扩展视图流程参考如何注册一个新的视图？

TreeView 示例

    //NOTE：package.json不支持注释，以下代码使用时需要将注释删掉
   "contributes": {
       "views": {
           //绑定的视图容器（viewContainers）的Id，目前一个视图容器仅支持绑定一个视图（view）
           "demoview": [{
               //该id需要和window.createTreeView中的viewId参数一致
               "id": "extensions.treedemo",
               "name": "DemoView"
           }]
       }
    }

WebView 示例

从HBuilderX 2.8.1及以上版本开始支持

 "contributes": {
        "viewsContainers": {
            "rightside":[
                {
                    "id":"containerId",
                    "title":"Container Title"
                }
            ]
        },
        "views": {
            "containerId":[
                {
                    //该id需要和window.createWebView中的viewId参数一致
                    "id":"viewId",
                    "title":"Custom View Title"
                }
            ]
        },
        ...
     }

menus

menus扩展点会关联一个命令到相应的菜单项里面，当菜单触发时将会执行对应的`命令。

menus节点下配置的对象内的key指的是要注册到哪个弹出菜单里面，目前支持的key值列表如下：

• editor/context ：编辑器右键菜单
• explorer/context ：项目管理器右键菜单
• view/item/context ：通过views扩展点扩展的视图的右键菜单（从HBuilderX 2.7.12及以上版本开始支持）
• menubar/file : 顶部菜单的文件菜单
• menubar/edit : 顶部菜单的编辑菜单
• menubar/select : 顶部菜单的选择菜单
• menubar/find : 顶部菜单的查找菜单
• menubar/goto : 顶部菜单的跳转菜单
• menubar/run : 顶部菜单的运行菜单
• menubar/publish : 顶部菜单的发行菜单
• menubar/view : 顶部菜单的视图菜单
• menubar/tool : 顶部菜单的工具菜单
• menubar/help : 顶部菜单的帮助菜单

menus属性列表

当属性title和command都为空时，将被识别为分割线。

示例

   "contributes": {
       "menus": {
         "editor/context": [
           {
             "id":"sep",
             "group": "z_commands"
           },
           {
             "command": "extension.firstExtension",
             "group": "z_commands",
             "when":"editorTextFocus"
           }
         ]
       }
    }

注册二级菜单

二级菜单通过将group设置为%menuId%@1、%menuId%@2的方式来实现，其中menuId指的是菜单扩展中的id字段。代码示例如下:

   "contributes": {
       "menus": {
         "editor/context": [
           {
             "id":"foo",
             "title": "带子菜单的菜单",
             "group": "z_commands",
           },
           {
             "command": "extension.firstExtension",
             "group": "foo@1",
             "when":"editorTextFocus"
           }
         ]
       }
    }

group

每个弹出菜单内的group都不一样，下面列出所有的弹出菜单下可用的group。

注意：想要将扩展菜单放到弹出菜单的最后，可以将group设置成0_foot

• editor/context
  • copy
  • goto
  • copyPath
  • assist
  • z_commands

对应的位置如下图所示：

• explorer/context ：项目管理器右键菜单
  • new
  • openInExplorer
  • nature
  • cutcopy
  • rename
  • z_commands

对应的位置如下图所示：

• menubar/file : 顶部菜单的文件菜单
  • new
  • tab
  • save
  • openInExplorer

对应的位置如下图所示：

• menubar/edit : 顶部菜单的编辑菜单
  • undo
  • copy
  • format
  • line
  • delete

对应的位置如下图所示：

• menubar/select : 顶部菜单的选择菜单
  • selectAll
  • area
  • word
  • line
  • colum
  • 0_cursor
  • 1_cursor

对应的位置如下图所示：

• menubar/find : 顶部菜单的查找菜单
  • findFile
  • findWord
  • findSymbol

对应的位置如下图所示：

• menubar/goto : 顶部菜单的跳转菜单
  • system_goto
  • line_goto
  • define_goto

对应的位置如下图所示：

• menubar/run : 顶部菜单的运行菜单
  • 0_foot

对应的位置在菜单的末尾。

• menubar/publish : 顶部菜单的发行菜单
  • 0_foot

对应的位置在菜单的末尾。

• menubar/view : 顶部菜单的视图菜单
  • min_window
  • focus_editor
  • show_lineno
  • view_split
  • scroll
  • plus_font

对应的位置如下图所示：

• menubar/tool : 顶部菜单的工具菜单
  • shortcuts
  • snippets
  • ext_settings

对应的位置如下图所示：

• menubar/help : 顶部菜单的帮助菜单
  • documents
  • checkupdate
  • license

对应的位置如下图所示：

when

when表达式用来动态的判断某个条件是否满足(即表达式的运算结果是true或者false)，目前用于控制一个菜单是否显示。目前支持的表达式运算符如下：

目前HBuilderX内置变量列表如下：

customEditors

插件可以通过该扩展点扩展多个不同类型的自定义编辑器，自定义编辑器可以设置文件匹配模式，用户通过项目管理器打开的文件匹配到某一类型时，在编辑器区域创建webview视图，关联打开的文件。

完整的扩展自定义编辑器流程参考如何扩展一个自定义编辑器？

扩展点示例如下：

 "contributes": {
        "customEditors": [{
            "viewType": "catEdit.catScratch",
            "displayName": "Cat Scratch",
            "selector": [{
                "fileNamePattern": "*.cscratch"
            }],
            "priority": "default"
        },
        ...]
    }

属性列表

EditorSelctor