Skip to content

Commit d3eb9ca

Browse files
dcloud-wandldcloud-wandl
committed
Merge remote-tracking branch 'origin/dev'
2 parents 166cfc2 + d861359 commit d3eb9ca

File tree

17 files changed

+181
-205
lines changed

17 files changed

+181
-205
lines changed

‎en/ExtensionDocs/Api/README.md‎

Lines changed: 42 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,56 @@
1-
HBuilderX API根对象可以通过require('hbuilderx')引入。
1+
The HBuilderX API root object can be introduced through require('hbuilderx').
2+
23
```javascript
34
const hx = require('hbuilderx')
45
```
5-
以下列出目前可用的API列表
66

7-
|插件API |详情 |
7+
This page lists all HBuilderX APIs available to extension authors.
8+
9+
|API |Details |
810
|-- |-- |
9-
|commands |commands二级模块对象，用于处理和`命令`相关的逻辑[详情](/ExtensionDocs/Api/commands) |
10-
|hx.languages.createDiagnosticCollection() |创建一个问题列表，可用于文档校验时在文档出错区域显示波浪线标识问题[详情](/ExtensionDocs/Api/languages/createDiagnosticCollection) |
11+
|commands |Used to process logic related to `command`. [Details](/ExtensionDocs/Api/commands) |
12+
|hx.languages.createDiagnosticCollection() |Create a diagnostics collection. [Details](/ExtensionDocs/Api/languages/createDiagnosticCollection) |
1113

1214
#### api:windows
13-
|插件API |详情 |
15+
|API |Description |
1416
|-- |-- |
15-
|hx.window.showErrorMessage() |在窗口右下角显示错误消息通知框[详情](/ExtensionDocs/Api/windows/Message?id=showerrormessage) |
16-
|hx.window.showInformationMessage() |在窗口右下角显示消息通知框[详情](/ExtensionDocs/Api/windows/Message?id=showinformationmessage) |
17-
|hx.window.showWarningMessage() |在窗口右下角显示警告消息通知框[详情](/ExtensionDocs/Api/windows/Message?id=showwarningmessage) |
18-
|hx.window.showMessageBox() |在窗口显示可供选择的对话框[详情](/ExtensionDocs/Api/windows/showMessageBox) |
19-
|hx.window.setStatusBarMessage() |设置状态栏消息[详情](/ExtensionDocs/Api/windows/StatusBar?id=setstatusbarmessage) |
20-
|hx.window.clearStatusBarMessage() |清空状态栏消息[详情](/ExtensionDocs/Api/windows/StatusBar?id=clearstatusbarmessage) |
21-
|hx.window.showQuickPick() |在窗口中间弹出一个可搜索的建议选择列表[详情](/ExtensionDocs/Api/windows/showQuickPick) |
22-
|hx.window.getActiveTextEditor() |获取当前激活的编辑器[详情](/ExtensionDocs/Api/windows/getActiveTextEditor) |
23-
|hx.window.showInputBox() |在窗口中间居中弹出一个输入框，获取用户输入[详情](/ExtensionDocs/Api/windows/showInputBox) |
24-
|hx.window.createOutputChannel() |创建一个输出控制台通道，可用于在控制台输出文本内容[详情](/ExtensionDocs/Api/windows/createOutputChannel) |
25-
|hx.window.createTreeView() |[详情](/ExtensionDocs/Api/windows/createTreeView) |
26-
|hx.window.createWebView() |[详情](/ExtensionDocs/Api/windows/createWebView) |
27-
|hx.window.createWebViewDialog() |创建基于WebView页面的对话框[详情](/ExtensionDocs/Api/windows/createWebViewDialog) |
28-
|hx.window.showView() |切换指定viewId的WebView控件视图[详情](/ExtensionDocs/Api/windows/showView) |
29-
|hx.window.registerUriHandler() |注册一个依赖hbuilderx协议的自定义网络请求处理器(schema)[详情](/ExtensionDocs/Api/windows/registerUriHandler) |
30-
|hx.window.registerCustomEditorProvider() |注册自定义编辑器[详情](/ExtensionDocs/Api/windows/registerCustomEditorProvider) |
17+
|hx.window.showErrorMessage() |Show an error message. [Details](/ExtensionDocs/Api/windows/Message?id=showerrormessage) |
18+
|hx.window.showInformationMessage() |Show an information message. [Details](/ExtensionDocs/Api/windows/Message?id=showinformationmessage) |
19+
|hx.window.showWarningMessage() |Show a warning message. [Details](/ExtensionDocs/Api/windows/Message?id=showwarningmessage) |
20+
|hx.window.showMessageBox() |Show a dialog box for selection in the window. [Details](/ExtensionDocs/Api/windows/showMessageBox) |
21+
|hx.window.setStatusBarMessage() |Set a message to the status bar. [Details](/ExtensionDocs/Api/windows/StatusBar?id=setstatusbarmessage) |
22+
|hx.window.clearStatusBarMessage() |Clear the status bar message. [Details](/ExtensionDocs/Api/windows/StatusBar?id=clearstatusbarmessage) |
23+
|hx.window.showQuickPick() |Shows a selection list allowing multiple selections. [Details](/ExtensionDocs/Api/windows/showQuickPick) |
24+
|hx.window.getActiveTextEditor() |Get the currently active editor. [Details](/ExtensionDocs/Api/windows/getActiveTextEditor) |
25+
|hx.window.showInputBox() |Opens an input box to ask the user for input. [Details](/ExtensionDocs/Api/windows/showInputBox) |
26+
|hx.window.createOutputChannel() |Creates a new output channel with the given name. [Details](/ExtensionDocs/Api/windows/createOutputChannel) |
27+
|hx.window.createTreeView() |Create a TreeView for the view contributed using the extension point views. [Details](/ExtensionDocs/Api/windows/createTreeView) |
28+
|hx.window.createWebView() |Create and show a new webview panel. [Details](/ExtensionDocs/Api/windows/createWebView) |
29+
|hx.window.createWebViewDialog() |Create dialog based on WebView page. [Details](/ExtensionDocs/Api/windows/createWebViewDialog) |
30+
|hx.window.showView() |Switch the WebView control view of the specified viewId. [Details](/ExtensionDocs/Api/windows/showView) |
31+
|hx.window.registerUriHandler() |Registers a uri handler capable of handling system-wide uris. [Details](/ExtensionDocs/Api/windows/registerUriHandler) |
32+
|hx.window.registerCustomEditorProvider() |Register a provider for custom editors for the viewType contributed by the customEditors extension point. [Details](/ExtensionDocs/Api/windows/registerCustomEditorProvider) |
3133

3234
#### api:workspace
33-
|插件API |详情 |
35+
|API |Description |
3436
|-- |-- |
35-
|hx.workspace.applyEdit() |根据指定的WorkspaceEdit对象编辑文档[详情](/ExtensionDocs/Api/workspace/applyEdit) |
36-
|hx.workspace.copyFileWithPrompt() |将指定文件或文件夹拷贝到目标文件夹下[详情](/ExtensionDocs/Api/workspace/copyFileWithPrompt) |
37-
|hx.workspace.getConfiguration() |根据指定的section获取对应的配置[详情](/ExtensionDocs/Api/workspace/getConfiguration) |
38-
|hx.workspace.getWorkspaceFolders() |获取项目管理器下所有的项目对象（不包含已关闭项目）[详情](/ExtensionDocs/Api/workspace/getWorkspaceFolders) |
39-
|hx.workspace.getWorkspaceFolder() |获取某个文件所在的项目[详情](/ExtensionDocs/Api/workspace/getWorkspaceFolder) |
40-
|hx.workspace.openTextDocument() |通过指定的uri打开一个文档文件[详情](/ExtensionDocs/Api/workspace/openTextDocument) |
41-
|hx.workspace.onDidChangeConfiguration() |[详情](/ExtensionDocs/Api/workspace/onDidChangeConfiguration) |
42-
|hx.workspace.onDidChangeWorkspaceFolders() |[详情](/ExtensionDocs/Api/workspace/onDidChangeWorkspaceFolders) |
43-
|hx.workspace.onDidChangeTextDocument() |[详情](/ExtensionDocs/Api/workspace/onDidChangeTextDocument) |
44-
|hx.workspace.onDidSaveTextDocument() |[详情](/ExtensionDocs/Api/workspace/onDidSaveTextDocument) |
45-
|hx.workspace.onDidOpenTextDocument() |[详情](/ExtensionDocs/Api/workspace/onDidOpenTextDocument) |
46-
|hx.workspace.onWillSaveTextDocument() | 文档即将要保存的事件 [详情](/ExtensionDocs/Api/workspace/onWillSaveTextDocument) |
37+
|hx.workspace.applyEdit() |create, delete, and rename resources as defined by the given workspace edit. [Details](/ExtensionDocs/Api/workspace/applyEdit) |
38+
|hx.workspace.copyFileWithPrompt() |Copy the specified file or folder to the target folder. [Details](/ExtensionDocs/Api/workspace/copyFileWithPrompt) |
39+
|hx.workspace.getConfiguration() |Get a workspace configuration object. [Details](/ExtensionDocs/Api/workspace/getConfiguration) |
40+
|hx.workspace.getWorkspaceFolders() |Get all project objects under the project explorer. [Details](/ExtensionDocs/Api/workspace/getWorkspaceFolders) |
41+
|hx.workspace.getWorkspaceFolder() |Returns the project info that contains a given uri. [Details](/ExtensionDocs/Api/workspace/getWorkspaceFolder) |
42+
|hx.workspace.openTextDocument() |Open a document file through the specified uri. [Details](/ExtensionDocs/Api/workspace/openTextDocument) |
43+
|hx.workspace.onDidChangeConfiguration() |An event that is emitted when the configuration changed. [Details](/ExtensionDocs/Api/workspace/onDidChangeConfiguration) |
44+
|hx.workspace.onDidChangeWorkspaceFolders() |An event that is emitted when a workspace folder is added or removed. [Details](/ExtensionDocs/Api/workspace/onDidChangeWorkspaceFolders) |
45+
|hx.workspace.onDidChangeTextDocument() |An event that is emitted when a text document is changed. [Details](/ExtensionDocs/Api/workspace/onDidChangeTextDocument) |
46+
|hx.workspace.onDidSaveTextDocument() |An event that is emitted when a text document is saved to disk. [Details](/ExtensionDocs/Api/workspace/onDidSaveTextDocument) |
47+
|hx.workspace.onDidOpenTextDocument() |An event that is emitted when a text document is opene. [Details](/ExtensionDocs/Api/workspace/onDidOpenTextDocument) |
48+
|hx.workspace.onWillSaveTextDocument() | An event that is emitted when a text document will be saved to disk. [Details](/ExtensionDocs/Api/workspace/onWillSaveTextDocument) |
4749

4850
#### api:env
49-
|插件API |详情 |
51+
|API |Description |
5052
|-- |-- |
51-
| env属性 | [详情](/ExtensionDocs/Api/env/readme) |
52-
| hx.authorize.login() |[详情](/ExtensionDocs/Api/env/authorize) |
53-
| hx.env.clipboard |读取剪切板内容和写入内容到剪切板 [详情](/ExtensionDocs/Api/env/Clipboard) |
54-
| hx.env.openExternal() | 打开一个外部链接[详情](/ExtensionDocs/Api/env/openExternal) |
53+
| env | [Details](/ExtensionDocs/Api/env/readme) |
54+
| hx.authorize.login() |[Details](/ExtensionDocs/Api/env/authorize) |
55+
| hx.env.clipboard |Read or write content to the System clipboard. [Details](/ExtensionDocs/Api/env/Clipboard) |
56+
| hx.env.openExternal() | Opens a link externallyv using the default application. [Details](/ExtensionDocs/Api/env/openExternal) |

‎en/ExtensionDocs/Api/commands.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# commands
22

3-
commands二级模块对象，用于处理和`命令`相关的逻辑。`命令`包含2部分：唯一ID和自定义的function，可以通过registerCommand或registerTextEditorCommand注册。
3+
commands, the second-level module object, used to process the logic related to `command`.
44

5-
`命令`可以通过以下方式触发：
5+
`命令`包含2部分：唯一ID和自定义的function，可以通过registerCommand或registerTextEditorCommand注册。
66

77

8-
## 声明command
8+
## Declare command
99

1010
#### 菜单：将命令通过`menus`扩展点关联到某个菜单。
1111

@@ -41,7 +41,7 @@ commands二级模块对象，用于处理和`命令`相关的逻辑。`命令`
4141
});
4242
```
4343

44-
#### 用户自定义快捷键
44+
#### Custom shortcuts
4545

4646
用户自定义快捷键：使用插件的用户可以通过得知`命令`的ID（一般在package.json中有声明），然后通过`自定义快捷键`配置一个快捷键。
4747

@@ -61,14 +61,14 @@ commands二级模块对象，用于处理和`命令`相关的逻辑。`命令`
6161

6262
<img src="/static/snapshots/commands@2x.png" style="zoom:50%" />
6363

64-
##### 参数说明
64+
##### Parameter
6565

66-
|参数名称 |参数类型 |描述 |
66+
|Parameter |Type |Description |
6767
|-- |-- |-- |
6868
|command |String |要执行的`命令`id |
6969

70-
##### 返回值
71-
|返回类型 |描述 |
70+
##### Returns
71+
|Type |Description |
7272
|-- |-- |
7373
|Promise |Promise对象|
7474

@@ -85,15 +85,15 @@ hx.commands.executeCommand('workbench.action.closeAllEditors')
8585

8686
注册一个指定id的`命令`，并关联一个自定义的函数
8787

88-
##### 参数说明
88+
##### Parameter
8989

90-
|参数名称 |参数类型 |描述 |
90+
|Parameter |Type |Description |
9191
|-- |-- |-- |
9292
|commandId |String |`命令`id |
9393
|handler |Function |`命令`触发时执行的函数 |
9494

95-
##### 返回值
96-
|返回类型 |描述 |
95+
##### Returns
96+
|Type |Description |
9797
|-- |-- |
9898
|[Disposable](/ExtensionDocs/Api/other/Disposable) |该`命令`的销毁器,可将该对象放置到插件的context.subscriptions数组内，插件卸载时，将会自动注销该`命令` |
9999

‎en/ExtensionDocs/Api/languages/createDiagnosticCollection.md‎

Lines changed: 30 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,30 @@
11
# createDiagnosticCollection
22

3-
创建一个问题列表，可用于文档校验时在文档出错区域显示波浪线标识问题。
3+
Create a diagnostics collection.
44

5-
## 参数和返回值
5+
For document verification, wavy lines are displayed in the error area of the document to identify problems.
66

7-
##### 参数说明
7+
## Parameter and Returns
88

9-
|参数名称 |参数类型 |描述 |
9+
##### Parameter
10+
11+
|Name |Type |Description |
1012
|-- |-- |-- |
11-
|name |String |问题列表名称，当鼠标移至波浪线上时会显示在tooltips中|
13+
|name |String |The name of the problem list, which will be displayed in tooltips when the mouse is moved over the wavy line|
1214

13-
##### 返回值
15+
##### Returns
1416

15-
|返回类型 |描述 |
17+
|Type |Description |
1618
|-- |-- |
17-
|[DiagnosticCollection](#DiagnosticCollection) |创建的问题列表 |
19+
|[DiagnosticCollection](#DiagnosticCollection) |List of questions created |
1820

1921

20-
##### 示例
22+
##### Example
2123

2224
``` javascript
2325
let activeEditor = hx.window.getActiveTextEditor();
2426
activeEditor.then(function(editor) {
25-
// 获取文件路径
27+
// Get file path
2628
let file_url = editor.document.uri.fsPath;
2729
// 通过editor.document可以获取文档对象进行校验
2830
// 创建一个测试问题集合
@@ -40,30 +42,30 @@
4042

4143
## DiagnosticCollection
4244

43-
问题集合
45+
> Diagnostic Collection
4446
45-
#### 属性列表
47+
#### Attributes List
4648

47-
|属性名 |属性类型 |描述 |
49+
|Name |Type |Description |
4850
|-- |-- |-- |
49-
|name |String |问题集合名称 |
51+
|name |String |The name of the collection. |
5052

5153
#### set
5254

53-
##### 参数说明
55+
##### Parameter
5456

55-
|参数名称 |参数类型 |描述 |
57+
|Name |Type |Description |
5658
|-- |-- |-- |
57-
|uri |String或Uri |文档地址 |
58-
|diagnostics|Array&lt;[DiagnosticItem](#DiagnosticItem)&gt; |问题集合 |
59+
|uri |String or Uri |Document path |
60+
|diagnostics|Array&lt;[DiagnosticItem](#DiagnosticItem)&gt; |Diagnostic Item |
5961

60-
##### 返回值
62+
##### Returns
6163

62-
|返回类型 |描述 |
64+
|Type |Description |
6365
|-- |-- |
6466
|Promise&lt;void&gt; |Promise |
6567

66-
##### 示例
68+
##### Example
6769

6870
``` javascript
6971
let diagnositics = hx.languages.createDiagnosticCollection('eslint');
@@ -78,13 +80,13 @@
7880

7981
## DiagnosticItem
8082

81-
问题项
83+
> Diagnostic Item
8284
83-
##### 属性列表
85+
##### Attributes List
8486

85-
|属性名 |属性类型 |描述 |
87+
|Name |Type |Description |
8688
|-- |-- |-- |
87-
|line |String |在文档第几行 |
88-
|column |String |在文档第几列 |
89-
|message |String |问题详细信息 |
90-
|severity |String |问题级别，取值范围:'error'，'warn'. 默认值是'error'|
89+
|line |String |lines of the document |
90+
|column |String |column of the document |
91+
|message |String |The human-readable message. |
92+
|severity |String |The severity, default is error. Scope:'error'，'warn'. |

‎en/ExtensionDocs/_sidebar.md‎

Lines changed: 10 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
* [简介](/ExtensionDocs/Api/README.md)
1+
* [Overview](/ExtensionDocs/Api/README.md)
22
* [commands](/ExtensionDocs/Api/commands.md)
33
* Language
4-
* [创建问题列表](/ExtensionDocs/Api/languages/createDiagnosticCollection.md)
4+
* [createDiagnosticCollection](/ExtensionDocs/Api/languages/createDiagnosticCollection.md)
55
* Window
6-
* [窗口右下角通知框](/ExtensionDocs/Api/windows/Message.md)
7-
* [状态栏消息](/ExtensionDocs/Api/windows/StatusBar.md)
6+
* [Message](/ExtensionDocs/Api/windows/Message.md)
7+
* [StatusBarMessage](/ExtensionDocs/Api/windows/StatusBar.md)
88
* [showMessageBox](/ExtensionDocs/Api/windows/showMessageBox.md)
99
* [showQuickPick](/ExtensionDocs/Api/windows/showQuickPick.md)
1010
* [getactivetexteditor](/ExtensionDocs/Api/windows/getActiveTextEditor.md)
@@ -31,44 +31,29 @@
3131
* [onDidOpenTextDocument](/ExtensionDocs/Api/workspace/onDidOpenTextDocument.md)
3232
* [onWillSaveTextDocument](/ExtensionDocs/Api/workspace/onWillSaveTextDocument.md)
3333
* env
34-
* [env属性列表](/ExtensionDocs/Api/env/readme.md)
34+
* [env Attribute List](/ExtensionDocs/Api/env/readme.md)
3535
* [authorize](/ExtensionDocs/Api/env/authorize.md)
3636
* [Clipboard](/ExtensionDocs/Api/env/Clipboard.md)
3737
* [openExternal](/ExtensionDocs/Api/env/openExternal.md)
3838
* other
3939
* [Disposable](/ExtensionDocs/Api/other/Disposable.md)
4040
* [Uri](/ExtensionDocs/Api/other/Uri.md)
4141
* [WorkspaceFolder](/ExtensionDocs/Api/other/WorkspaceFolder.md)
42-
* [扩展点](/ExtensionDocs/ContributionPoints/README.md)
43-
* [插件激活机制](/ExtensionDocs/activation_event.md)
44-
* [插件规范](/ExtensionDocs/manifest.md)
42+
* [ContributionPoints](/ExtensionDocs/ContributionPoints/README.md)
43+
* [ActivationEvent](/ExtensionDocs/activation_event.md)
44+
* [Manifest](/ExtensionDocs/manifest.md)
4545
<div class="contact-box">
4646
<a href="https://www.dcloud.io/hbuilderx.html" target="_blank" class="contact-item">
4747
<img src="/static/favicon/favicon.png" width="20" height="21">
4848
<div class="contact-smg">
49-
<div>HBuilderX官网</div>
49+
<div>HBuilderX</div>
5050
</div>
5151
</a>
5252
<a href="https://ask.dcloud.net.cn/explore/" target="_blank" class="contact-item">
5353
<img src="/static/icon/ask.png" width="20" height="21">
5454
<div class="contact-smg">
55-
<div>DCloud论坛</div>
55+
<div>DCloud Forum</div>
5656
</div>
5757
</a>
58-
<div class="contact-item">
59-
<img src="/static/icon/qq.png" width="20" height="20" />
60-
<div class="contact-smg">
61-
<div>官方插件开发QQ交流群</div>
62-
<div>群1：1090431141 &nbsp;<a target="_blank" href="https://qm.qq.com/cgi-bin/qm/qr?k=RrAC77FPpgT213CVSRw-hXOUEzNLR53Q&jump_from=webapi">点此加入</a>
63-
</div>
64-
</div>
65-
</div>
66-
<div class="contact-item">
67-
<img src="/static/icon/weixin@2x.png" width="20" height="20" />
68-
<div class="contact-smg">
69-
<div>关注微信公众号</div>
70-
<img src="/static/icon/weixin.jpeg" width="90" height="90" />
71-
</div>
72-
</div>
7358
</div>
7459

‎en/ExtensionTutorial/Others.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
更多示例代码请参考[hbuilderx-extension-samples](https://github.com/dcloudio/hbuilderx-extension-samples)
1+
For more sample codes, please refer to [hbuilderx-extension-samples](https://github.com/dcloudio/hbuilderx-extension-samples)

0 commit comments

Comments
 (0)