SystemSh0cker/monaco-editor
1
0
Fork 0
mirror of https://github.com/microsoft/monaco-editor.git synced 2025-12-22 07:00:11 +01:00
Code Issues Projects Releases Packages Activity
A browser based code editor
7 commits 40 branches 589 tags 158 MiB
Find a file
Martin Aeschlimann f999b64a46 also check npm < 3.0 node modules location
2016-06-28 12:11:05 +02:00
.vscode 1.0 2016-06-26 12:50:57 +02:00
src Update readme.md 2016-06-27 09:52:49 +02:00
.gitignore 1.0 2016-06-26 12:50:57 +02:00
.npmignore 1.0 2016-06-26 12:50:57 +02:00
gulpfile.js also check npm < 3.0 node modules location 2016-06-28 12:11:05 +02:00
LICENSE.md 1.0 2016-06-26 12:50:57 +02:00
package.json 1.0.1, take latest json-languageservice 2016-06-26 23:53:55 +02:00
README.md improve installation description (fixes #2) 2016-06-28 11:58:53 +02:00

README.md

Monaco JSON

JSON language plugin for the Monaco Editor. It provides the following features when editing JSON files:

  • Code completion, based on JSON schemas or by looking at similar objects in the same file
  • Hovers, based on JSON schemas
  • Validation: Syntax errors and schema validation
  • Formatting
  • Document Symbols
  • Syntax highlighting

Schemas can be provided by configuration. See here for the API that the JSON plugin offers to configure the JSON language support.

Internally the JSON plugin uses the vscode-json-languageservice node module, providing the implementation of the functionally listed above. The same module is also used in Visual Studio Code to power the JSON editing experience.

Installing

This npm module is bundled and distributed in the monaco-editor npm module.

Dev: cheat sheet

  • change to your favorite source folder (/src/)
  • run git clone https://github.com/Microsoft/monaco-json and change directory to monaco-json
  • initial setup with npm install .
  • compile with npm run watch
  • bundle with npm run prepublish

Dev: Running monaco-json from source

  • change to your favorite source folder (/src/). Important: both monaco repositories must have the same parent folder.
  • git clone https://github.com/Microsoft/monaco-json (this will create $/src/monaco-json)
  • git clone https://github.com/Microsoft/monaco-editor (this will create $/src/monaco-editor)
  • in folder monaco-json run npm run watch
  • in folder monaco-editor run npm run simpleserver
  • open http://localhost:8080/monaco-editor/test/?monaco-json=dev

[Optional] Running monaco-editor-core from source

  • this is only needed when you want to make changes also in monaco-editor-core.
  • change to the same favorite source folder (/src/) that already contains monaco-json and monaco-editor
  • git clone https://github.com/Microsoft/vscode (this will create $/src/vscode/)
  • read here on how to initialize the VS code source repository.
  • in folder vscode run gulp watch
  • open http://localhost:8080/monaco-editor/test/?monaco-json=dev&editor=dev

License

MIT