|
@@ -27,11 +27,54 @@ Colorization and configuration supports for multiple languages for the Monaco Ed
|
|
|
|
|
|
This npm module is bundled and distributed in the [monaco-editor](https://www.npmjs.com/package/monaco-editor) npm module.
|
|
|
|
|
|
-## Dev:
|
|
|
+## Dev: cheat sheet
|
|
|
|
|
|
+* initial setup with `npm install .`
|
|
|
* compile with `npm run watch`
|
|
|
* test with `npm run test`
|
|
|
* 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:
|
|
|
+```js
|
|
|
+registerLanguage({
|
|
|
+ id: 'sql',
|
|
|
+ extensions: [ '.sql' ],
|
|
|
+ aliases: [ 'SQL' ],
|
|
|
+ module: './sql'
|
|
|
+});
|
|
|
+```
|
|
|
+* edit `$/test/all.js` and load your new language while testing
|
|
|
+```js
|
|
|
+'out/test/sql.test',
|
|
|
+```
|
|
|
+* edit `$/gulpfile.js` and ship your new language
|
|
|
+```js
|
|
|
+bundleOne('src/sql'),
|
|
|
+```
|
|
|
+
|
|
|
+
|
|
|
## License
|
|
|
[MIT](https://github.com/Microsoft/monaco-languages/blob/master/LICENSE.md)
|