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