diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 57d8bffd..996c5e77 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,6 +9,24 @@ This repository contains source code only for Monaco Editor Languages, the core | [vscode](https://github.com/microsoft/vscode) | [monaco-editor-core](https://www.npmjs.com/package/monaco-editor-core) | editor core functionality (language agnostic) is shipped out of vscode. | | [monaco-editor](https://github.com/microsoft/monaco-editor) | [monaco-editor](https://www.npmjs.com/package/monaco-editor) | the Monaco Editor. | +## Contributing a new tokenizer / a new language + +- create `$/monaco-languages/src/myLang/myLang.contribution.ts` +- create `$/monaco-languages/src/myLang/myLang.ts` +- create `$/monaco-languages/src/myLang/myLang.test.ts` +- edit `$/monaco-languages/src/monaco.contribution.ts` and register your new language + +```js +import './myLang/myLang.contribution'; +``` + +## Updating TypeScript + +- change typescript's version in `package.json`. +- execute `npm install .` +- execute `npm run import-typescript` +- adopt new APIs + ## Running the editor from source You need to have all the build setup of VS Code to be able to build the Monaco Editor. diff --git a/monaco-css/README.md b/monaco-css/README.md deleted file mode 100644 index 7de819d1..00000000 --- a/monaco-css/README.md +++ /dev/null @@ -1,22 +0,0 @@ -# Monaco CSS - -CSS language plugin for the Monaco Editor. It provides the following features when editing CSS, LESS and SCSS files: - -- Code completion -- Hovers -- Validation: Syntax errors and linting -- Find definition, references & highlights for symbols in the same file -- Document Symbols -- Color Decorators - -Linting an be configured through the API. See [`monaco.d.ts`](./monaco.d.ts) for the API that the -CSS plugin offers to configure the CSS/LESS/SCSS language support. - -Internally the CSS plugin uses the [`vscode-css-languageservice`](https://github.com/microsoft/vscode-css-languageservice) -node module, providing the implementation of the functionally listed above. The same module is also used -in [Visual Studio Code](https://github.com/microsoft/vscode) to power the CSS, LESS and SCSS editing experience. - -## Development - -- watch with `npm run watch` -- compile with `npm run prepublishOnly` diff --git a/monaco-html/README.md b/monaco-html/README.md deleted file mode 100644 index 0be612bc..00000000 --- a/monaco-html/README.md +++ /dev/null @@ -1,18 +0,0 @@ -# Monaco HTML - -HTML language plugin for the Monaco Editor. It provides the following features when editing HTML files: - -- Code completion -- Formatting -- Document Highlights -- Link detection -- Syntax highlighting - -Internally the HTML plugin uses the [`vscode-html-languageservice`](https://github.com/microsoft/vscode-html-languageservice) -node module, providing the implementation of the functionally listed above. The same module is also used -in [Visual Studio Code](https://github.com/microsoft/vscode) to power the HTML editing experience. - -## Development - -- watch with `npm run watch` -- compile with `npm run prepublishOnly` diff --git a/monaco-json/README.md b/monaco-json/README.md deleted file mode 100644 index ecdead4c..00000000 --- a/monaco-json/README.md +++ /dev/null @@ -1,23 +0,0 @@ -# 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 -- Color decorators for all properties matching a schema containing `format: "color-hex"'` (non-standard schema extension) - -Schemas can be provided by configuration. See [`monaco.d.ts`](./monaco.d.ts) -for the API that the JSON plugin offers to configure the JSON language support. - -Internally the JSON plugin uses the [`vscode-json-languageservice`](https://github.com/microsoft/vscode-json-languageservice) -node module, providing the implementation of the features listed above. The same module is also used -in [Visual Studio Code](https://github.com/microsoft/vscode) to power the JSON editing experience. - -## Development - -- watch with `npm run watch` -- compile with `npm run prepublishOnly` diff --git a/monaco-languages/README.md b/monaco-languages/README.md deleted file mode 100644 index 05224ce6..00000000 --- a/monaco-languages/README.md +++ /dev/null @@ -1,22 +0,0 @@ -# Monaco Languages - -Colorization and configuration supports for multiple languages for the Monaco Editor: - -![monaco-languages](https://cloud.githubusercontent.com/assets/5047891/15938606/1fd4bac6-2e74-11e6-8839-d455da8bc8a7.gif) - -## Development - -- watch with `npm run watch` -- compile with `npm run prepublishOnly` -- test with `npm run test` - -## Dev: Adding a new language - -- create `$/src/myLang/myLang.contribution.ts` -- create `$/src/myLang/myLang.ts` -- create `$/src/myLang/myLang.test.ts` -- edit `$/src/monaco.contribution.ts` and register your new language - -```js -import './myLang/myLang.contribution'; -``` diff --git a/monaco-typescript/README.md b/monaco-typescript/README.md deleted file mode 100644 index 7f848d5a..00000000 --- a/monaco-typescript/README.md +++ /dev/null @@ -1,20 +0,0 @@ -# Monaco TypeScript - -Simple TypeScript and JavaScript language support for the Monaco Editor. - -![typescript](https://cloud.githubusercontent.com/assets/5047891/15926623/5262fe08-2e3d-11e6-9b90-1d43fda07178.gif) - -_Note_ that this project focuses on single-file scenarios and that things like project-isolation, cross-file-features like Rename etc. are _outside_ the scope of this project and not supported. - -## Development - -- watch with `npm run watch` -- compile with `npm run prepublishOnly` -- open `$/monaco-typescript/test/index.html` in your favorite browser. - -## Updating TypeScript - -- change typescript's version in `package.json`. -- execute `npm install .` -- execute `npm run import-typescript` -- adopt new APIs