Code Monkey home page Code Monkey logo

monaco-languageclient's Introduction

Monaco language client

Gitpod - Code Now PRs Welcome Build Status NPM Version NPM Download

NPM module to connect Monaco editor with language servers

  • Look at the example client to learn how to start Monaco language client.
  • Look at the example express app 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.
  • Look at the browser example to learn how to use a language service written in JavaScript in a simple HTML page.

Click here for a detail explanation how to connect the Monaco editor to your language server.

Getting started

Local dev env

git clone https://github.com/TypeFox/monaco-languageclient.git
cd monaco-languageclient
npm install

Gitpod

In order to develop and run the master branch: https://gitpod.io#https://github.com/TypeFox/monaco-languageclient. Gitpod will create a dev workspace for you with a properly configured env and checked out code, run the build and start a Node.js example.

Gitpod is a one-click online IDE for GitHub. It is based on Theia IDE framework and make use of Monaco and the language server protocol by means of monaco-languageclient.

Examples

There are two different examples that demonstrate how the monaco-languageclient can be used. The Node.js example uses Express and WebSockets to enable communication between the language server process and the web application. The browser example shows how a language service written in JavaScript can be used in a Monaco Editor contained in a simple HTML page.

Node.js

The example node package is located under the monaco-languageclient/example directory. All tasks below should be run from this directory.

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 server 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 different modes.

Browser

The example browser package is located under the monaco-languageclient/examples/browser directory. All tasks below should be run from this directory.

From CLI:

  • Run npm install and npm run build to install dependencies and build the example HTML and JavaScript files.

After the example has been built, open monaco-languageclient/examples/browser/lib/index.html in a browser to open the sample page.

License

MIT

monaco-languageclient's People

Contributors

akosyakov avatar alextugarev avatar rcjsuen avatar svenefftinge avatar gatesn avatar cdietrich avatar sshumakov avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.