SystemSh0cker/monaco-editor
1
0
Fork 0
mirror of https://github.com/microsoft/monaco-editor.git synced 2025-12-22 19:42:56 +01:00
Code Issues Projects Releases Packages Activity

Update README

Browse source
This commit is contained in:
Alex Dima 2016-09-16 19:59:24 +02:00
parent bb831fbc82
commit e83992b95d
1 changed files with 14 additions and 32 deletions
Download patch file Download diff file Expand all files Collapse all files

38
README.md
View file

@ -45,26 +45,8 @@ This npm module is bundled and distributed in the [monaco-editor](https://www.np
* initial setup with `npm install .` * initial setup with `npm install .`
* compile with `npm run watch` * compile with `npm run watch`
* test with `npm run test` * 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` * 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 ## Dev: Adding a new language
* create `$/src/myLang.ts` * create `$/src/myLang.ts`
@ -72,22 +54,22 @@ This npm module is bundled and distributed in the [monaco-editor](https://www.np
* update tsconfig.json with `$> node_modules/.bin/tscg .` * update tsconfig.json with `$> node_modules/.bin/tscg .`
* restart compilation with `$> npm run watch` * restart compilation with `$> npm run watch`
* edit `$/src/monaco.contribution.ts` and register your new language: * edit `$/src/monaco.contribution.ts` and register your new language:
```js ```js
registerLanguage({ registerLanguage({
id: 'sql', id: 'sql',
extensions: [ '.sql' ], extensions: [ '.sql' ],
aliases: [ 'SQL' ], aliases: [ 'SQL' ],
module: './sql' module: './sql'
}); });
``` ```
* edit `$/test/all.js` and load your new language while testing * edit `$/test/all.js` and load your new language while testing
```js ```js
'out/test/sql.test', 'out/test/sql.test',
``` ```
* edit `$/gulpfile.js` and ship your new language * edit `$/gulpfile.js` and ship your new language
```js ```js
bundleOne('src/sql'), bundleOne('src/sql'),
``` ```
## Code of Conduct ## Code of Conduct