@theia/core 1.22.0 → 1.22.1

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.
Files changed (3) hide show
  1. package/README.md +3 -3
  2. package/package.json +6 -6
  3. package/README.in.md +0 -138
package/README.md CHANGED
@@ -86,9 +86,9 @@ export class SomeClass {
86
86
  - `@phosphor/signaling` (from [`@phosphor/signaling@1`](https://www.npmjs.com/package/@phosphor/signaling))
87
87
  - `@phosphor/virtualdom` (from [`@phosphor/virtualdom@1`](https://www.npmjs.com/package/@phosphor/virtualdom))
88
88
  - `@phosphor/widgets` (from [`@phosphor/widgets@1`](https://www.npmjs.com/package/@phosphor/widgets))
89
- - `@theia/application-package` (from [`@theia/application-package@1.22.0`](https://www.npmjs.com/package/@theia/application-package/v/1.22.0))
90
- - `@theia/application-package/lib/api` (from [`@theia/application-package@1.22.0`](https://www.npmjs.com/package/@theia/application-package/v/1.22.0))
91
- - `@theia/application-package/lib/environment` (from [`@theia/application-package@1.22.0`](https://www.npmjs.com/package/@theia/application-package/v/1.22.0))
89
+ - `@theia/application-package` (from [`@theia/application-package@1.22.1`](https://www.npmjs.com/package/@theia/application-package/v/1.22.1))
90
+ - `@theia/application-package/lib/api` (from [`@theia/application-package@1.22.1`](https://www.npmjs.com/package/@theia/application-package/v/1.22.1))
91
+ - `@theia/application-package/lib/environment` (from [`@theia/application-package@1.22.1`](https://www.npmjs.com/package/@theia/application-package/v/1.22.1))
92
92
  - `fs-extra` (from [`fs-extra@^4.0.2`](https://www.npmjs.com/package/fs-extra))
93
93
  - `fuzzy` (from [`fuzzy@^0.1.3`](https://www.npmjs.com/package/fuzzy))
94
94
  - `inversify` (from [`inversify@^5.1.1`](https://www.npmjs.com/package/inversify))
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@theia/core",
3
- "version": "1.22.0",
3
+ "version": "1.22.1",
4
4
  "description": "Theia is a cloud & desktop IDE framework implemented in TypeScript.",
5
5
  "main": "lib/common/index.js",
6
6
  "typings": "lib/common/index.d.ts",
@@ -17,7 +17,7 @@
17
17
  "@phosphor/virtualdom": "1",
18
18
  "@phosphor/widgets": "1",
19
19
  "@primer/octicons-react": "^9.0.0",
20
- "@theia/application-package": "1.22.0",
20
+ "@theia/application-package": "1.22.1",
21
21
  "@types/body-parser": "^1.16.4",
22
22
  "@types/cookie": "^0.3.3",
23
23
  "@types/dompurify": "^2.2.2",
@@ -172,7 +172,7 @@
172
172
  "clean": "theiaext clean",
173
173
  "compile": "theiaext compile",
174
174
  "generate-layout": "electron ./scripts/generate-layout",
175
- "generate-theia-re-exports": "theia-re-exports generate && theia-re-exports template README.in.md > README.md",
175
+ "generate-theia-re-exports": "theia-re-exports generate && theia-re-exports template README_TEMPLATE.md > README.md",
176
176
  "lint": "theiaext lint",
177
177
  "prepare": "yarn -s generate-theia-re-exports",
178
178
  "test": "theiaext test",
@@ -180,12 +180,12 @@
180
180
  "watch": "theiaext watch"
181
181
  },
182
182
  "devDependencies": {
183
- "@theia/ext-scripts": "1.22.0",
184
- "@theia/re-exports": "1.22.0",
183
+ "@theia/ext-scripts": "1.22.1",
184
+ "@theia/re-exports": "1.22.1",
185
185
  "minimist": "^1.2.0"
186
186
  },
187
187
  "nyc": {
188
188
  "extends": "../../configs/nyc.json"
189
189
  },
190
- "gitHead": "84cfe06b4b10720cc9915bc6e2f091a2b09b1087"
190
+ "gitHead": "49910aeaecf520a54b253db0215b28c2268bb2f3"
191
191
  }
package/README.in.md DELETED
@@ -1,138 +0,0 @@
1
- <div align='center'>
2
-
3
- <br />
4
-
5
- <img src='https://raw.githubusercontent.com/eclipse-theia/theia/master/logo/theia.svg?sanitize=true' alt='theia-ext-logo' width='100px' />
6
-
7
- <h2>ECLIPSE THEIA - CORE EXTENSION</h2>
8
-
9
- <hr />
10
-
11
- </div>
12
-
13
- ## Description
14
-
15
- The `@theia/core` extension is the main extension for all Theia-based applications, and provides the main framework for all dependent extensions.
16
- The extension provides the base APIs for all Theia-based applications, including:
17
- - Application APIs
18
- - Shell APIs
19
- - Base Widgets
20
- - Contribution Points (ex: commands, menu items, keybindings)
21
-
22
- ## Theia Extension
23
-
24
- A Theia extension is a node package declaring `theiaExtensions` property in `package.json`:
25
-
26
- ```json
27
- {
28
- "theiaExtensions": [{
29
- "frontend": "lib/myExtension/browser/myextension-frontend-module",
30
- "backend": "lib/myExtension/node/myextension-backend-module",
31
- }, {
32
- "frontend": "lib/myExtension2/browser/myextension2-browser-module",
33
- "frontendElectron": "lib/myExtension2/electron-browser/myextension2-electron-browser-module",
34
- "backend": "lib/myExtension2/node/myextension2-node-module",
35
- "backendElectron": "lib/myExtension2/electron-main/myextension2-electron-main-module"
36
- }]
37
- }
38
- ```
39
-
40
- Each extension can consist of the following modules:
41
- - `frontend` is used in the browser env and as well in the electron if `frontendElectron` is not provided
42
- - `frontendElectron` is used in the electron env
43
- - `backend` is used in the node env and as well in the electron env if `backendElectron` is not provided
44
- - `backendElectron` is used in the electron env
45
-
46
- An extension module should have a default export of `ContainerModule | Promise<ContainerModule>` type.
47
-
48
- ## Theia Application
49
-
50
- A Theia application is a node package listing [Theia extensions](#theia-extension) as dependencies and managed with [Theia CLI](../../dev-packages/cli/README.md).
51
-
52
- ## Re-Exports Mechanism
53
-
54
- In order to make application builds more stable `@theia/core` re-exports some common dependencies for Theia extensions to re-use. This is especially useful when having to re-use the same dependencies as `@theia/core` does: Since those dependencies will be pulled by Theia, instead of trying to match the same version in your own packages, you can use re-exports to consume it from the framework directly.
55
-
56
- ### Usage Example
57
-
58
- Let's take inversify as an example since you will most likely use this package, you can import it by prefixing with `@theia/core/shared/`:
59
-
60
- ```ts
61
- import { injectable } from '@theia/core/shared/inversify';
62
-
63
- @injectable()
64
- export class SomeClass {
65
- // ...
66
- }
67
- ```
68
-
69
- ## Re-Exports
70
-
71
- {{#reExportsDirectories}}
72
- - `@theia/core/{{&directory}}/...`
73
- {{#packages}}
74
- {{#modules}}
75
- - `{{&moduleName}}` (from [`{{&packageName}}@{{&versionRange}}`]({{&npmUrl}}))
76
- {{/modules}}
77
- {{/packages}}
78
- {{/reExportsDirectories}}
79
-
80
- ## Logging Configuration
81
-
82
- It's possible to change the log level for the entire Theia application by
83
- passing it the `--log-level={fatal,error,warn,info,debug,trace}` option. For
84
- more fine-grained adjustment, it's also possible to set the log level per
85
- logger (i.e. per topic). The `root` logger is a special catch-all logger
86
- through which go all messages not sent through a particular logger. To change
87
- the log level of particular loggers, create a config file such as
88
-
89
- ```json
90
- {
91
- "defaultLevel": "info",
92
- "levels": {
93
- "terminal": "debug",
94
- "task": "error"
95
- }
96
- }
97
- ```
98
-
99
- where `levels` contains the logger-to-log-level mapping. `defaultLevel`
100
- contains the log level to use for loggers not specified in `levels`. This file
101
- can then be specified using the `--log-config` option. Theia will watch that
102
- file for changes, so it's possible to change log levels at runtime by
103
- modifying this file.
104
-
105
- It's unfortunately currently not possible to query Theia for the list of
106
- existing loggers. However, each log message specifies from which logger it
107
- comes from, which can give an idea, without having to read the code:
108
-
109
- ```
110
- root INFO [nsfw-watcher: 10734] Started watching: /Users/captain.future/git/theia/CONTRIBUTING.md
111
- ^^^^ ^^^^ ^^^^^^^^^^^^^^^^^^^
112
- ```
113
- Where `root` is the name of the logger and `INFO` is the log level. These are optionally followed by the name of a child process and the process ID.
114
-
115
- ## Environment Variables
116
-
117
- - `THEIA_HOSTS`
118
- - A comma-separated list of hosts expected to resolve to the current application.
119
- - e.g: `theia.app.com,some.other.domain:3000`
120
- - The port number is important if your application is not hosted on either `80` or `443`.
121
- - If possible, you should set this environment variable:
122
- - When not set, Theia will allow any origin to access the WebSocket services.
123
- - When set, Theia will only allow the origins defined in this environment variable.
124
-
125
- ## Additional Information
126
-
127
- - [API documentation for `@theia/core`](https://eclipse-theia.github.io/theia/docs/next/modules/core.html)
128
- - [Theia - GitHub](https://github.com/eclipse-theia/theia)
129
- - [Theia - Website](https://theia-ide.org/)
130
-
131
- ## License
132
-
133
- - [Eclipse Public License 2.0](http://www.eclipse.org/legal/epl-2.0/)
134
- - [一 (Secondary) GNU General Public License, version 2 with the GNU Classpath Exception](https://projects.eclipse.org/license/secondary-gpl-2.0-cp)
135
-
136
- ## Trademark
137
- "Theia" is a trademark of the Eclipse Foundation
138
- https://www.eclipse.org/theia