@theia/plugin 1.55.1 → 1.57.0-next.112

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -192,6 +192,7 @@ Simple example that show a status bar message with statusBarItem:
192
192
  item.text = 'test status bar item';
193
193
  item.show();
194
194
  ```
195
+
195
196
  #### Output channel API
196
197
 
197
198
  It is possible to show a container for readonly textual information:
@@ -241,9 +242,10 @@ const terminal = theia.window.createTerminal("Bash terminal", "/bin/bash", ["-l"
241
242
  ```
242
243
 
243
244
  Where are:
244
- - first argument - terminal's name.
245
- - second argument - path to the executable shell.
246
- - third argument - arguments to configure executable shell.
245
+
246
+ - first argument - terminal's name.
247
+ - second argument - path to the executable shell.
248
+ - third argument - arguments to configure executable shell.
247
249
 
248
250
  You can create terminal with specific options:
249
251
 
@@ -258,10 +260,11 @@ const options: theia.TerminalOptions {
258
260
  ```
259
261
 
260
262
  Where are:
261
- - "shellPath" - path to the executable shell, for example "/bin/bash", "bash", "sh" or so on.
262
- - "shellArgs" - shell command arguments, for example without login: "-l". If you defined shell command "/bin/bash" and set up shell arguments "-l" than will be created terminal process with command "/bin/bash -l". And client side will connect to stdin/stdout of this process to interaction with user.
263
- - "cwd" - current working directory;
264
- - "env"- environment variables for terminal process, for example TERM - identifier terminal window capabilities.
263
+
264
+ - "shellPath" - path to the executable shell, for example "/bin/bash", "bash", "sh" or so on.
265
+ - "shellArgs" - shell command arguments, for example without login: "-l". If you defined shell command "/bin/bash" and set up shell arguments "-l" than will be created terminal process with command "/bin/bash -l". And client side will connect to stdin/stdout of this process to interaction with user.
266
+ - "cwd" - current working directory;
267
+ - "env"- environment variables for terminal process, for example TERM - identifier terminal window capabilities.
265
268
 
266
269
  Function to create new terminal with defined theia.TerminalOptions described above:
267
270
 
@@ -288,6 +291,7 @@ terminal.sendText("Hello, Theia!", false);
288
291
  ```
289
292
 
290
293
  Where are:
294
+
291
295
  - first argument - text content.
292
296
  - second argument - in case true, terminal will apply new line after the text, otherwise will send only the text.
293
297
 
@@ -323,6 +327,7 @@ terminal.processId.then(id => {
323
327
  Preference API allows one to read or update User's and Workspace's preferences.
324
328
 
325
329
  To get preferences:
330
+
326
331
  ```typescript
327
332
  // editor preferences
328
333
  const preferences = theia.workspace.getConfiguration('editor');
@@ -332,6 +337,7 @@ const fontSize = preferences.get('tabSize');
332
337
  ```
333
338
 
334
339
  To change preference:
340
+
335
341
  ```typescript
336
342
  preferences.onDidChangeConfiguration(e => {
337
343
  if (e.affectsConfiguration('editor.tabSize')) {
@@ -353,6 +359,7 @@ const diagnostics = theia.languages.getDiagnostics(uriToResource)
353
359
  ```
354
360
 
355
361
  To get all diagnostics use:
362
+
356
363
  ```typescript
357
364
  const diagnostics = theia.languages.getDiagnostics()
358
365
  ```
@@ -424,6 +431,7 @@ diagnosticsCollection.forEach((uri, diagnostics) => {
424
431
  #### Signature help
425
432
 
426
433
  To provide signature help form plugin it is required to register provider. For registration 3 items are needed:
434
+
427
435
  - Documents selector to describe for which files it should be applied
428
436
  - Handler which will do the work
429
437
  - Trigger characters after typing of which the handler should be invoked. Often symbols `(` and `,` are used.
@@ -474,6 +482,7 @@ Example of signature information:
474
482
  ```
475
483
 
476
484
  Note, that:
485
+
477
486
  - `activeSignature` and `activeParameter` are zero based.
478
487
  - label is usually full method signature.
479
488
  - for documentation fields markdown partially supported (Tags aren't supported).
@@ -762,5 +771,6 @@ function provideRanges(document: theia.TextDocument): theia.ProviderResult<theia
762
771
  - [一 (Secondary) GNU General Public License, version 2 with the GNU Classpath Exception](https://projects.eclipse.org/license/secondary-gpl-2.0-cp)
763
772
 
764
773
  ## Trademark
774
+
765
775
  "Theia" is a trademark of the Eclipse Foundation
766
- https://www.eclipse.org/theia
776
+ <https://www.eclipse.org/theia>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@theia/plugin",
3
- "version": "1.55.1",
3
+ "version": "1.57.0-next.112+f4778c273",
4
4
  "description": "Theia - Plugin API",
5
5
  "types": "./src/theia.d.ts",
6
6
  "publishConfig": {
@@ -27,10 +27,10 @@
27
27
  "watch": "theiaext watch"
28
28
  },
29
29
  "devDependencies": {
30
- "@theia/ext-scripts": "1.55.1"
30
+ "@theia/ext-scripts": "1.58.0"
31
31
  },
32
32
  "nyc": {
33
33
  "extends": "../../configs/nyc.json"
34
34
  },
35
- "gitHead": "be4713a778be16ba831af63a6fbd43b2301e882d"
35
+ "gitHead": "f4778c2737bb75613f0e1f99da8996bad91f6e17"
36
36
  }