@theia/monaco 1.56.0 → 1.57.0-next.37

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 (2) hide show
  1. package/README.md +23 -10
  2. package/package.json +9 -9
package/README.md CHANGED
@@ -14,6 +14,7 @@
14
14
 
15
15
  The `@theia/monaco` extension contributes the integration of the [monaco-editor](https://microsoft.github.io/monaco-editor/index.html).\
16
16
  This includes:
17
+
17
18
  - full-feature code editor
18
19
  - diff-editor
19
20
  - code snippets
@@ -28,22 +29,28 @@ process, the steps for undertaking a Monaco uplift are outlined here.
28
29
  ### Setting up the VSCode side
29
30
 
30
31
  1. Clone the VSCode repo and make sure you have the following remotes:
31
- - https://github.com/microsoft/vscode.git - the official VSCode repo.
32
- - https://github.com/theia-ide/vscode.git - Theia's fork.
32
+
33
+ - <https://github.com/microsoft/vscode.git> - the official VSCode repo.
34
+ - <https://github.com/theia-ide/vscode.git> - Theia's fork.
35
+
33
36
  2. Find the latest release tag in the official VSCode repo, and the most recent uplift branch in the Theia fork.
37
+
34
38
  > At the time of this writing the latest release tag is `1.67.2`, and the uplift branch is `monaco-uplift-2022-6`
39
+
35
40
  3. Check out the release tag, cherry pick the tip of the uplift branch, and resolve any conflicts.
41
+
36
42
  > As you resolve conflicts and make changes to the VSCode repo, make sure you end up with a single commit on the uplift branch to make it easier for the next person to rebase.
43
+
37
44
  4. Try to build. At the moment, this means running `yarn` and `yarn run gulp editor-distro`.
38
45
  5. Fix any build errors that arise.
39
46
  6. Change the version in `build/monaco/package.json`
40
47
 
41
48
  #### Current State
42
49
 
43
- - build/gulpfile.editor.js: various changes to modify the treeshaking and output destinations.
44
- - build/lib/standalone.js/ts: changes to output sourcemaps etc. One small change to fix a build error due to having a directory named `model` and a file named `model.ts` in the same folder.
45
- - src/vs/base/browser/dompurify/dompurify.js changes for CommonJS rather than ESM
46
- - src/vs/base/common/marked/marked.js changes for CommonJS rather than ESM
50
+ - build/gulpfile.editor.js: various changes to modify the treeshaking and output destinations.
51
+ - build/lib/standalone.js/ts: changes to output sourcemaps etc. One small change to fix a build error due to having a directory named `model` and a file named `model.ts` in the same folder.
52
+ - src/vs/base/browser/dompurify/dompurify.js changes for CommonJS rather than ESM
53
+ - src/vs/base/common/marked/marked.js changes for CommonJS rather than ESM
47
54
 
48
55
  ### Setting up the Theia side
49
56
 
@@ -51,15 +58,21 @@ For initial testing, it's easier to point dependencies to your local VSCode.
51
58
 
52
59
  1. Having built `monaco-editor-core` using the steps [above](#setting-up-the-vscode-side).
53
60
  2. Find all references to `@theia/monaco-editor-core` in `package.json`s and replace their version with `"link:<path to your local build of monaco-editor-core>"`.
54
- > Using `link:` means that if you subsequently make changes on the VSCode side, you only need to rebuild VSCode and then rebuild Theia to see the effects.
61
+
62
+ > Using `link:` means that if you subsequently make changes on the VSCode side, you only need to rebuild VSCode and then rebuild Theia to see the effects.
63
+
55
64
  3. Delete your `node_modules` and `yarn` and build Theia.
56
65
  4. Fix any build errors.
57
66
  5. Uncomment the `bindMonacoPreferenceExtractor` function in `examples/api-samples/src/browser/monaco-editor-preferences/monaco-editor-preference-extractor.ts` and run the commands there. Fix the `EditorGeneratedPreferenceSchema` as necessary, and add or remove validations from the `MonacoFrontendApplicationContribution` as appropriate.
58
67
  6. Look for comments that indicate forced types or other code smells that would prevent a build error from being thrown where it should be thrown and check that the assertion still applies.
68
+
59
69
  > If you add these, mark them with @monaco-uplift - that'll make them easier to find in the future. Better: if you can remove them, do! Typically, the cause is mixing imports from
60
70
  private API and public API. Often public API fails to satisfy private declarations.
71
+
61
72
  7. Test the application thoroughly - make sure everything's still working.
73
+
62
74
  > It may also be necessary to update our various `vscode` dependencies to match the current state of VSCode. It may not be necessary to upgrade all (or any) of these to successfully adopt a new Monaco version, but if something is misbehaving inexplicably, checking dependencies is a reasonable place to start. Check on:
75
+ >
63
76
  > - `vscode-debugprotocol`
64
77
  > - `vscode-languageserver-protocol`
65
78
  > - `vscode-oniguruma`
@@ -74,7 +87,6 @@ Once you believe that everything is in working order, you'll need to publish the
74
87
  [here](https://github.com/theia-ide/vscode/wiki/Publish-%60@theia-monaco-editor-core%60). Once the package is published, point your `package.json`s at the testing version and make
75
88
  sure everything still works, then make a PR.
76
89
 
77
-
78
90
  ## Additional Information
79
91
 
80
92
  - [API documentation for `@theia/monaco`](https://eclipse-theia.github.io/theia/docs/next/modules/monaco.html)
@@ -87,14 +99,15 @@ sure everything still works, then make a PR.
87
99
  - [一 (Secondary) GNU General Public License, version 2 with the GNU Classpath Exception](https://projects.eclipse.org/license/secondary-gpl-2.0-cp)
88
100
 
89
101
  ## Trademark
90
- "Theia" is a trademark of the Eclipse Foundation
91
- https://www.eclipse.org/theia
92
102
 
103
+ "Theia" is a trademark of the Eclipse Foundation
104
+ <https://www.eclipse.org/theia>
93
105
 
94
106
  # Theia - Monaco Extension
95
107
 
96
108
  See [here](https://www.theia-ide.org/doc/index.html) for a detailed documentation.
97
109
 
98
110
  ## License
111
+
99
112
  - [Eclipse Public License 2.0](http://www.eclipse.org/legal/epl-2.0/)
100
113
  - [一 (Secondary) GNU General Public License, version 2 with the GNU Classpath Exception](https://projects.eclipse.org/license/secondary-gpl-2.0-cp)
package/package.json CHANGED
@@ -1,15 +1,15 @@
1
1
  {
2
2
  "name": "@theia/monaco",
3
- "version": "1.56.0",
3
+ "version": "1.57.0-next.37+4e3b183da",
4
4
  "description": "Theia - Monaco Extension",
5
5
  "dependencies": {
6
- "@theia/core": "1.56.0",
7
- "@theia/editor": "1.56.0",
8
- "@theia/filesystem": "1.56.0",
9
- "@theia/markers": "1.56.0",
6
+ "@theia/core": "1.57.0-next.37+4e3b183da",
7
+ "@theia/editor": "1.57.0-next.37+4e3b183da",
8
+ "@theia/filesystem": "1.57.0-next.37+4e3b183da",
9
+ "@theia/markers": "1.57.0-next.37+4e3b183da",
10
10
  "@theia/monaco-editor-core": "1.83.101",
11
- "@theia/outline-view": "1.56.0",
12
- "@theia/workspace": "1.56.0",
11
+ "@theia/outline-view": "1.57.0-next.37+4e3b183da",
12
+ "@theia/workspace": "1.57.0-next.37+4e3b183da",
13
13
  "fast-plist": "^0.1.2",
14
14
  "idb": "^4.0.5",
15
15
  "jsonc-parser": "^2.2.0",
@@ -52,10 +52,10 @@
52
52
  "watch": "theiaext watch"
53
53
  },
54
54
  "devDependencies": {
55
- "@theia/ext-scripts": "1.56.0"
55
+ "@theia/ext-scripts": "1.57.0"
56
56
  },
57
57
  "nyc": {
58
58
  "extends": "../../configs/nyc.json"
59
59
  },
60
- "gitHead": "3b4498f8f1c66be688847418fcc35595282671dc"
60
+ "gitHead": "4e3b183daab034ae86eaa610421d4d9791ffdaa5"
61
61
  }