monaco-editor/README.md

Monaco Languages

Colorization and configuration supports for multiple languages for the Monaco Editor:

• bat
• coffee script
• cpp
• csharp
• fsharp
• go
• html
• ini
• jade
• lua
• objective-c
• postiats
• php
• powershell
• python
• r
• ruby
• sql
• swift
• vb
• xml

Also css dialects:

• css
• less
• scss

Issues

Please file issues concering monaco-languages in the monaco-editor-repository.

Installing

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

Dev: cheat sheet

• initial setup with npm install .
• compile with npm run watch
• test with npm run test
• There is a problem with nls.js while running under the test environment. If you get Uncaught Error: Evaluating node_modules/monaco-editor-core/dev/vs/nls.js as module "vs/nls" failed with error: TypeError: Cannot read property 'Plugin' of undefined you must edit for now $/node_modules/monaco-editor-core/dev/vs/nls.js and around line 27 use var global = _nlsPluginGlobal || {};. A fix will come soon.
• bundle with npm run prepublish

Dev: Running monaco-languages from source

• clone https://github.com/Microsoft/monaco-languages in $/src/monaco-languages
• run $/src/monaco-languages> npm run watch
• clone https://github.com/Microsoft/monaco-editor in $/src/monaco-editor
• run $/src/monaco-editor> npm run simpleserver
• edit $/src/monaco-editor/test/index.html and set RUN_PLUGINS_FROM_SOURCE['monaco-languages'] = true;
• open http://localhost:8080/monaco-editor/test/

[Optional] Running monaco-editor-core from source

• this is only needed when you want to make changes also in monaco-editor-core.
• clone https://github.com/Microsoft/vscode in $/src/vscode/
• run gulp watch
• edit $/src/monaco-editor/test/index.html and set var RUN_EDITOR_FROM_SOURCE = true;
• open http://localhost:8080/monaco-editor/test/

Dev: Adding a new language

• create $/src/myLang.ts
• create $/test/myLang.test.ts
• update tsconfig.json with $> node_modules/.bin/tscg .
• restart compilation with $> npm run watch
• edit $/src/monaco.contribution.ts and register your new language:

registerLanguage({
	id: 'sql',
	extensions: [ '.sql' ],
	aliases: [ 'SQL' ],
	module: './sql'
});

• edit $/test/all.js and load your new language while testing

'out/test/sql.test',

• edit $/gulpfile.js and ship your new language

bundleOne('src/sql'),

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

License

MIT