Skip to content

Commit

Permalink
README: Updated troubleshooting
Browse files Browse the repository at this point in the history
  • Loading branch information
kaisalmen committed Nov 21, 2023
1 parent e870a3a commit d3cdabf
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ Click [here](https://www.typefox.io/blog/teaching-the-language-server-protocol-t
- [VSCode integration](#vscode-integration)
- [Troubleshooting](#troubleshooting)
- [General](#general)
- [Dependency issues: monaco-editor / @codingame/monaco-editor-treemended](#dependency-issues-monaco-editor--codingamemonaco-editor-treemended)
- [Volta](#volta)
- [Vite dev server troubleshooting](#vite-dev-server-troubleshooting)
- [Bad Polyfills](#bad-polyfills)
Expand Down Expand Up @@ -99,7 +100,7 @@ With v7 we decided to use readily treemended version of monaco-editor called [@c
}
```

In the following table you can see the effect ([Angular clinet example](https://github.com/TypeFox/monaco-languageclient-ng-example.git) was used to demonstrate it):
In the following table you can see the effect when using `npm list monaco-editor` (here the [angular client example](https://github.com/TypeFox/monaco-languageclient-ng-example.git) was used to demonstrate it):

| No overrides | With overrides |
| :---- | :---- |
Expand Down Expand Up @@ -210,6 +211,11 @@ Again, if you use **monaco-languageclient** make sure you define matching [Overr

Ensure **monaco-editor**, **vscode** and **monaco-languageclient** are imported before you do any **monaco-editor** or vscode-api intialization or start using it. Please check the [our python language client example](./packages/examples/src/python/client/main.ts) to see how it should be done.

### Dependency issues: monaco-editor / @codingame/monaco-editor-treemended

It is recommended to study this chapter first: [NEW with v7: Treemended monaco-editor](#new-with-v7-treemended-monaco-editor).
If you have mutiple, possibly hundreds of compile errors resulting from missing functions deep in `monaco-editor` or `vscode` then it is very likely your `package-lock.json` or `node_modules` are dirty. Remove both and do a fresh `npm install`. Always `npm list monaco-editor` is very useful. If you see different or errornous versions, then this is an indicator something is wrong.

### Volta

There are [Volta](https://volta.sh/) instructions in the `package.json` files. When you have Volta available it will ensure the exactly specified `node` and `npm` versions are used.
Expand Down
4 changes: 4 additions & 0 deletions packages/examples/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

All notable changes to this npm module are documented in this file.

## [7.0.2] - 2023-11-15

- Updated to `[email protected]`.

## [7.0.1] - 2023-11-10

- Updated to `[email protected]`. Statemachine example uses init multiple times.
Expand Down

0 comments on commit d3cdabf

Please sign in to comment.