Skip to content

Latest commit

 

History

History

hello-world-lsp-runtimes

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
src
src
 
 
.eslintrc.js
.eslintrc.js
 
 
README.md
README.md
 
 
package.json
package.json
 
 
tsconfig.json
tsconfig.json
 
 
webpack.config.js
webpack.config.js
 
 

README.md

Hello World Runtimes bundling example

This package demonstrates how to bundle Language Server with AWS Language Server Runtimes for different target runtimes environments.

Runtimes supported include:

  • standalone - bundling language server into standalone NodeJS executable program.
  • webworker - bundling language server into webworker, running in web browser environment.

Source code examples of runtime bundle configuration in /src directory.

Creating bundles

We use webpack to create javascript bundles to run with NodeJS or as a webworker.

Before creating runtime bundle, make sure that Hello World Language Server package is compiled:

cd ./language-servers/server/hello-world-lsp
npm run compile

To produce all bundles in this package, run:

npm run bundle

Bundling specific variants is also possible.

  • To create javascript bundled files with webpack, run: 
    npm run webpack

Result artifacts can be found in /out and /build directories.

Package structure

.
├── build - Budled Javascript runtime programms
│   ├── hello-world-lsp-standalone.js - standalone bundle
│   ├── hello-world-lsp-webworker.js - webworker bundle
├── out - Compiled Javascipt
│   ├── standalone.js
│   ├── webworker.js
├── src - source code configuration for bundling
│   ├── standalone.ts
└── └── webworker.ts

Testing and running

To test build bundles, you can run standalone bundle locally using NodeJs:

node ./out/hello-world-lsp-standalone.js --stdio

You should see process logging JSON-RPC messages, indicating Runtime and Language Server features were initialised:

Content-Length: 127

{"jsonrpc":"2.0","method":"window/logMessage","params":{"type":3,"message":"Runtime: Initializing runtime without encryption"}}Content-Length: 130

{"jsonrpc":"2.0","method":"window/logMessage","params":{"type":3,"message":"Runtime: Registering IAM credentials update handler"}}Content-Length: 133

{"jsonrpc":"2.0","method":"window/logMessage","params":{"type":3,"message":"Runtime: Registering bearer credentials update handler"}}Content-Length: 153

{"jsonrpc":"2.0","method":"window/logMessage","params":{"type":3,"message":"[2024-05-14T10:16:02.618Z] The Hello World Capability has been initialised"}}