monaco-languageclient - npm Package Compare versions

Comparing version 0.0.1-alpha.0 to 0.0.1-alpha.1

.vscode/launch.json

@@ -16,4 +16,17 @@ {
             ]
+        },
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "Launch Sample Server (external)",
+            "program": "${workspaceRoot}/example/lib/server.js",
+            "args": [
+                "--external"
+            ],
+            "sourceMaps": true,
+            "outFiles": [
+                "${workspaceRoot}/example/lib/**/*.js"
+            ]
         }
     ]
 }

package.json

 {
   "name": "monaco-languageclient",
-  "version": "0.0.1-alpha.0",
+  "version": "0.0.1-alpha.1",
   "description": "Monaco Language client implementation",
@@ -5,0 +5,0 @@ "author": "TypeFox GmbH (http://www.typefox.io)",

README.md

 # Monaco language client
 NPM module to connect Monaco editor with language servers
 
+- Look at [the example client](https://github.com/TypeFox/monaco-languageclient/blob/master/example/src/client.ts) to learn how to start Monaco langauge client.
+- Look at [the example express app](https://github.com/TypeFox/monaco-languageclient/blob/master/example/src/server.ts) to learn how to open a web socket with an express app and launch a language server within the current process or as an external process.
+
 ## Getting started
 
-Clone and build the following repositories from the same directory:
-- jsonrpc over web socket:
-
-```
-git clone https://github.com/TypeFox/vscode-ws-jsonrpc
-cd vscode-ws-jsonrpc
-npm install
-```
-
-- an abstract (editor agnostic) language client:
-
 ```bash
-git clone https://github.com/TypeFox/vscode-languageserver-node.git
-cd vscode-languageserver-node
-npm install
-```
-
-- Monaco language client:
-
-```bash
 git clone https://github.com/TypeFox/monaco-languageclient.git
@@ -31,13 +15,16 @@ cd monaco-languageclient
 
-## Example
+## Examples
 
-Run from `monaco-languageclient/example` directory:
-- to build and start:
+The example node package is located under `monaco-languageclient/example` directory. All tasks below should be run from this directory.
 
-```bash
-npm install
-npm run start
-```
+From CLI:
+- Run `npm install` and `npm run build` to install dependencies and build the example node package.
+- Run `npm run start` to start the express server with the language server running in the same process.
+- Run `npm run start:ext` to start the express erver with language server running in the external process.
 
+After staring the express server go to `http://localhost:3000` to open the sample page.
+
+You can as well run vscode tasks to start and debug the server in differnet modes.
+
 ## License
 [MIT](https://github.com/TypeFox/monaco-languageclient/blob/master/License.txt)

No alert changes

Improved metrics

Total package byte prevSize

69364

increased by1.37%

Lines of code

1373

increased by0.96%

Worsened metrics

Number of lines in readme file

30

decreased by-30.23%

No dependency changes