Prepare: Make examples pacakge externally available

TypeFox · Aug 30, 2023 · e6ed7c0 · e6ed7c0
1 parent 8379dfe
commit e6ed7c0
Show file tree

Hide file tree

Showing 20 changed files with 314 additions and 194 deletions.
diff --git a/README.md b/README.md
@@ -83,6 +83,7 @@ The following table describes which version of **monaco-languageclient** and **m
 
 | monaco-languageclient | monaco-vscode-api | monaco-editor | comment |
 | :----         | :----   | :---   | :--- |
+| 6.4.5         | 1.81.5  | 0.41.0 | Released 2023-08-30 |
 | 6.4.4         | 1.81.5  | 0.41.0 | Released 2023-08-24 |
 | 6.4.3         | 1.81.3  | 0.41.0 | Released 2023-08-22 |
 | 6.4.2         | 1.81.2  | 0.41.0 | Released 2023-08-19 |

diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/client/CHANGELOG.md b/packages/client/CHANGELOG.md
@@ -2,6 +2,11 @@
 
 All notable changes to this npm module are documented in this file.
 
+## [6.4.5] - 2023-08-30
+
+- Use direct `monaco-editor` imports
+- Make examples publicly available
+
 ## [6.4.4] - 2023-08-24
 
 - Update to `monaco-vscode-api` `1.81.5`

diff --git a/packages/client/package.json b/packages/client/package.json
@@ -1,6 +1,6 @@
 {
   "name": "monaco-languageclient",
-  "version": "6.4.4",
+  "version": "6.4.5",
   "description": "Monaco Language client implementation",
   "author": {
     "name": "TypeFox GmbH",

diff --git a/packages/examples/main/CHANGELOG.md b/packages/examples/main/CHANGELOG.md
@@ -0,0 +1,7 @@
+# Changelog
+
+All notable changes to this npm module are documented in this file.
+
+## [6.4.5] - 2023-08-30
+
+- First release of the `monaco-languageclient-examples` package
diff --git a/packages/examples/main/License.txt b/packages/examples/main/License.txt
@@ -0,0 +1,11 @@
+Copyright (c) 2018-2023 TypeFox GmbH (http://www.typefox.io)
+
+All rights reserved.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/packages/examples/main/README.md b/packages/examples/main/README.md
@@ -0,0 +1,19 @@
+# Monaco Language Client Examples
+
+[![Gitpod - Code Now](https://img.shields.io/badge/Gitpod-code%20now-blue.svg?longCache=true)](https://gitpod.io#https://github.com/TypeFox/monaco-languageclient)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?longCache=true)](https://github.com/TypeFox/monaco-languageclient/labels/help%20wanted)
+[![monaco-languageclient](https://github.com/TypeFox/monaco-languageclient/actions/workflows/actions.yml/badge.svg)](https://github.com/TypeFox/monaco-languageclient/actions/workflows/actions.yml)
+[![NPM Version](https://img.shields.io/npm/v/monaco-languageclient-examples.svg)](https://www.npmjs.com/package/monaco-languageclient-examples)
+[![NPM Download](https://img.shields.io/npm/dt/monaco-languageclient-examples.svg)](https://www.npmjs.com/package/monaco-languageclient-examples)
+
+Module to connect [Monaco editor](https://microsoft.github.io/monaco-editor/) with [language servers](https://microsoft.github.io/language-server-protocol/).
+
+See [here](https://github.com/TypeFox/monaco-languageclient/blob/main/README.md) for a detailed documentation.
+
+## History
+
+For the history please see the [README](https://github.com/TypeFox/monaco-languageclient/blob/main/packages/examples/main/README.md#latest-important-project-changes) and [CHANGELOG](https://github.com/TypeFox/monaco-languageclient/blob/main/packages/examples/main/CHANGELOG.md).
+
+## License
+
+[MIT](https://github.com/TypeFox/monaco-languageclient/blob/main/packages/examples/main/License.txt)
diff --git a/packages/examples/main/package.json b/packages/examples/main/package.json
@@ -1,34 +1,62 @@
 {
-  "name": "examples-main",
-  "version": "1.0.0",
-  "private": true,
+  "name": "monaco-languageclient-examples",
+  "version": "6.4.5",
+  "description": "Monaco Language client examples",
+  "author": {
+    "name": "TypeFox GmbH",
+    "url": "http://www.typefox.io"
+  },
+  "homepage": "https://github.com/TypeFox/monaco-languageclient/blob/main/packages/examples/main/README.md",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/TypeFox/monaco-languageclient",
+    "directory": "packages/examples/main"
+  },
+  "bugs": {
+    "url": "https://github.com/TypeFox/monaco-languageclient/issues"
+  },
   "type": "module",
-  "main": "./dist/common.js",
-  "module": "./dist/common.js",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
   "exports": {
     ".": {
-      "types": "./dist/common.d.ts",
-      "default": "./dist/common.js"
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./node": {
+      "types": "./dist/node.d.ts",
+      "default": "./dist/node.js"
+    },
+    "./langiumWorker": {
+      "types": "./dist/langium/langiumServerWorker.d.ts",
+      "default": "./dist/worker/langiumServerWorker.js"
     }
   },
   "typesVersions": {
     "*": {
       ".": [
-        "dist/common.d.ts"
+        "dist/index"
+      ],
+      "node": [
+        "dist/node"
+      ],
+      "langiumWorker": [
+        "dist/langium/langiumServerWorker"
       ]
     }
   },
   "dependencies": {
     "express": "~4.18.2",
-    "langium": "~2.0.0",
+    "langium": "~2.0.1",
     "langium-statemachine-dsl": "~2.0.0",
     "monaco-editor-workers": "~0.41.0",
-    "monaco-languageclient": "~6.4.4",
+    "monaco-languageclient": "~6.4.5",
     "pyright": "~1.1.322",
     "react": "~18.2.0",
     "react-dom": "~18.2.0",
     "request-light": "~0.7.0",
-    "vscode-json-languageservice": "~5.3.5",
+    "vscode-json-languageservice": "~5.3.6",
     "vscode-languageserver": "~8.1.0",
     "vscode-ws-jsonrpc": "~3.0.0",
     "ws": "~8.13.0"
@@ -45,6 +73,15 @@
     "node": "18.17.1",
     "npm": "9.6.7"
   },
+  "files": [
+    "dist",
+    "src",
+    "*.html",
+    "*.ts",
+    "README.md",
+    "CHANGELOG.md",
+    "License.txt"
+  ],
   "scripts": {
     "clean": "shx rm -fr dist *.tsbuildinfo",
     "compile": "tsc --build tsconfig.src.json",

diff --git a/packages/examples/main/src/index.ts b/packages/examples/main/src/index.ts
@@ -0,0 +1,13 @@
+/* --------------------------------------------------------------------------------------------
+ * Copyright (c) 2018-2022 TypeFox GmbH (http://www.typefox.io). All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ * ------------------------------------------------------------------------------------------ */
+
+export * from './common.js';
+export * from './browser/main.js';
+export * from './json/client/main.js';
+export * from './langium/langiumClient.js';
+export * from './langium/statemachineClient.js';
+export * from './python/client.js';
+export * from './react/app.js';
+export * from './react/main.js';
diff --git a/packages/examples/main/src/langium/langiumClient.ts b/packages/examples/main/src/langium/langiumClient.ts
@@ -96,9 +96,7 @@ const setup = async () => {
     registerFileSystemOverlay(1, fileSystemProvider);
 
     textModelRef = await createModelReference(Uri.file('/workspace/example.langium'));
-};
 
-const run = async () => {
     createConfiguredEditor(document.getElementById('container')!, {
         model: textModelRef.object.textEditorModel
     });
@@ -138,9 +136,11 @@ const run = async () => {
     // any further language client / server interaction can't be defined as needed
 };
 
-try {
-    await setup();
-    await run();
-} catch (e) {
-    console.log(e);
-}
+const run = async () => {
+    try {
+        await setup();
+    } catch (e) {
+        console.log(e);
+    }
+};
+run();
diff --git a/packages/examples/main/src/langium/statemachineClient.ts b/packages/examples/main/src/langium/statemachineClient.ts
@@ -98,9 +98,7 @@ const setup = async () => {
     "editor.fontSize": 14,
     "workbench.colorTheme": "Default Dark Modern"
 }`);
-};
 
-const run = async () => {
     const exampleStatemachineUrl = new URL('./src/langium/example.statemachine', window.location.href).href;
     const editorText = await (await fetch(exampleStatemachineUrl)).text();
 
@@ -143,9 +141,11 @@ const run = async () => {
     reader.onClose(() => languageClient.stop());
 };
 
-try {
-    await setup();
-    await run();
-} catch (e) {
-    console.error(e);
-}
+const run = async () => {
+    try {
+        await setup();
+    } catch (e) {
+        console.error(e);
+    }
+};
+run();
diff --git a/packages/examples/main/src/node.ts b/packages/examples/main/src/node.ts
@@ -0,0 +1,9 @@
+/* --------------------------------------------------------------------------------------------
+ * Copyright (c) 2018-2022 TypeFox GmbH (http://www.typefox.io). All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ * ------------------------------------------------------------------------------------------ */
+
+export * from './json/server/json-server.js';
+export * from './json/server/main.js';
+export * from './python/server.js';
+export * from './utils/fs-utils.js';
diff --git a/packages/examples/main/src/python/server.ts b/packages/examples/main/src/python/server.ts
@@ -15,9 +15,9 @@ import { getLocalDirectory } from '../utils/fs-utils.js';
 
 const serverName = 'PYRIGHT';
 
-const launchLanguageServer = (socket: IWebSocket) => {
+const launchLanguageServer = (socket: IWebSocket, baseDir: string, relativeDir: string) => {
     // start the language server as an external process
-    const ls = resolve(getLocalDirectory(import.meta.url), '../../../../../node_modules/pyright/dist/pyright-langserver.js');
+    const ls = resolve(baseDir, relativeDir);
     const serverConnection = createServerProcess(serverName, 'node', [ls, '--stdio']);
 
     const reader = new WebSocketMessageReader(socket);
@@ -97,11 +97,13 @@ const run = () => {
                     dispose: () => webSocket.close()
                 };
                 // launch the server when the web socket is opened
+                const baseDir = resolve(getLocalDirectory(import.meta.url));
+                const relativeDir = '../../../../../node_modules/pyright/dist/pyright-langserver.js';
                 if (webSocket.readyState === webSocket.OPEN) {
-                    launchLanguageServer(socket);
+                    launchLanguageServer(socket, baseDir, relativeDir);
                 } else {
                     webSocket.on('open', () => {
-                        launchLanguageServer(socket);
+                        launchLanguageServer(socket, baseDir, relativeDir);
                     });
                 }
             });

diff --git a/packages/verify/pnpm/package.json b/packages/verify/pnpm/package.json
@@ -3,7 +3,7 @@
   "version": "0.0.0",
   "private": "true",
   "dependencies": {
-    "monaco-languageclient": "~6.4.4",
+    "monaco-languageclient": "~6.4.5",
     "monaco-editor": "~0.41.0",
     "vscode": "npm:@codingame/monaco-vscode-api@1.81.5"
   },

diff --git a/packages/verify/vite/package.json b/packages/verify/vite/package.json
@@ -5,8 +5,8 @@
   "type": "module",
   "dependencies": {
     "monaco-editor-workers": "~0.41.0",
-    "monaco-languageclient": "~6.4.4",
-    "examples-main": "../../examples/main",
+    "monaco-languageclient": "~6.4.5",
+    "monaco-languageclient-examples": "~6.4.5",
     "vscode-ws-jsonrpc": "~3.0.0"
   },
   "devDependencies": {

diff --git a/packages/verify/vite/src/client/main.ts b/packages/verify/vite/src/client/main.ts
@@ -3,7 +3,7 @@
  * Licensed under the MIT License. See License.txt in the project root for license information.
  * ------------------------------------------------------------------------------------------ */
 
-import { createDefaultJsonContent, createJsonEditor, createUrl, createWebSocketAndStartClient, performInit } from 'examples-main';
+import { createDefaultJsonContent, createJsonEditor, createUrl, createWebSocketAndStartClient, performInit } from 'monaco-languageclient-examples';
 import { buildWorkerDefinition } from 'monaco-editor-workers';
 buildWorkerDefinition('./workers', new URL('', window.location.href).href, false);
 

diff --git a/packages/verify/webpack/package.json b/packages/verify/webpack/package.json
@@ -5,8 +5,8 @@
   "type": "module",
   "dependencies": {
     "monaco-editor-workers": "~0.41.0",
-    "monaco-languageclient": "~6.4.4",
-    "examples-main": "../../examples/main",
+    "monaco-languageclient": "~6.4.5",
+    "monaco-languageclient-examples": "~6.4.5",
     "vscode-ws-jsonrpc": "~3.0.0"
   },
   "devDependencies": {

diff --git a/packages/verify/webpack/src/client/main.ts b/packages/verify/webpack/src/client/main.ts
@@ -3,7 +3,7 @@
  * Licensed under the MIT License. See License.txt in the project root for license information.
  * ------------------------------------------------------------------------------------------ */
 
-import { createDefaultJsonContent, createJsonEditor, createUrl, createWebSocketAndStartClient, performInit } from 'examples-main';
+import { createDefaultJsonContent, createJsonEditor, createUrl, createWebSocketAndStartClient, performInit } from 'monaco-languageclient-examples';
 import { buildWorkerDefinition } from 'monaco-editor-workers';
 buildWorkerDefinition('dist/client/workers', new URL('', window.location.href).href, false);
 

diff --git a/packages/verify/webpack/webpack.config.js b/packages/verify/webpack/webpack.config.js
@@ -26,7 +26,7 @@ const config = {
             enforce: 'pre',
             use: ['source-map-loader'],
             // These modules seems to have broken sourcemaps, exclude them to prevent an error flood in the logs
-            exclude: [/vscode-jsonrpc/, /vscode-languageclient/, /vscode-languageserver-protocol/]
+            exclude: [/vscode-jsonrpc/, /vscode-languageclient/, /vscode-languageserver/, /vscode-languageserver-protocol/]
         },
         {
             test: /\.(mp3|wasm)$/i,

diff --git a/packages/verify/yarn/package.json b/packages/verify/yarn/package.json
@@ -3,7 +3,7 @@
   "version": "0.0.0",
   "private": "true",
   "dependencies": {
-    "monaco-languageclient": "~6.4.4"
+    "monaco-languageclient": "~6.4.5"
   },
   "devDependencies": {
     "shx": "~0.3.4"