mirror of
https://github.com/danbulant/monaco-yaml
synced 2026-06-20 23:11:05 +00:00
House keeping
This commit is contained in:
parent
e658a06c82
commit
c65f0f4a95
5 changed files with 2131 additions and 21 deletions
20
README.md
20
README.md
|
|
@ -1,6 +1,6 @@
|
|||
# Monaco JSON
|
||||
# Monaco YAML
|
||||
|
||||
JSON language plugin for the Monaco Editor. It provides the following features when editing JSON files:
|
||||
YAML language plugin for the Monaco Editor. It provides the following features when editing YAML 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
|
||||
|
|
@ -11,25 +11,17 @@ JSON language plugin for the Monaco Editor. It provides the following features w
|
|||
Schemas can be provided by configuration. See [here](https://github.com/Microsoft/monaco-json/blob/master/src/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 functionally listed above. The same module is also used
|
||||
in [Visual Studio Code](https://github.com/Microsoft/vscode) to power the JSON editing experience.
|
||||
|
||||
## Issues
|
||||
|
||||
Please file issues concering `monaco-json` in the [`monaco-editor` repository](https://github.com/Microsoft/monaco-editor/issues).
|
||||
|
||||
## Installing
|
||||
|
||||
This npm module is bundled and distributed in the [monaco-editor](https://www.npmjs.com/package/monaco-editor) npm module.
|
||||
|
||||
## Development
|
||||
|
||||
* `git clone https://github.com/Microsoft/monaco-json`
|
||||
* `cd monaco-json`
|
||||
* `git clone https://github.com/kpdecker/monaco-yaml`
|
||||
* `cd monaco-yaml`
|
||||
* `npm install .`
|
||||
* `npm run watch`
|
||||
* open `$/monaco-json/test/index.html` in your favorite browser.
|
||||
* open `$/monaco-yaml/test/index.html` in your favorite browser.
|
||||
|
||||
## License
|
||||
[MIT](https://github.com/Microsoft/monaco-json/blob/master/LICENSE.md)
|
||||
[MIT](https://github.com/kpdecker/monaco-yaml/blob/master/LICENSE.md)
|
||||
|
|
|
|||
11
package.json
11
package.json
|
|
@ -1,20 +1,17 @@
|
|||
{
|
||||
"name": "monaco-yaml",
|
||||
"version": "1.3.2",
|
||||
"description": "JSON plugin for the Monaco Editor",
|
||||
"version": "1.0.0",
|
||||
"description": "YAML plugin for the Monaco Editor",
|
||||
"scripts": {
|
||||
"compile": "gulp compile",
|
||||
"watch": "gulp watch",
|
||||
"prepublish": "gulp release"
|
||||
},
|
||||
"author": "Microsoft Corporation",
|
||||
"author": "Kevin Decker <kpdecker@gmail.com> (http://incaseofstairs.com)",
|
||||
"license": "MIT",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/Microsoft/monaco-json"
|
||||
},
|
||||
"bugs": {
|
||||
"url": "https://github.com/Microsoft/monaco-json/issues"
|
||||
"url": "https://github.com/kpdecker/monaco-yaml"
|
||||
},
|
||||
"devDependencies": {
|
||||
"event-stream": "^3.3.2",
|
||||
|
|
|
|||
13
src/yaml-ast-parser/license.txt
Normal file
13
src/yaml-ast-parser/license.txt
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
Copyright 2015 (c) MuleSoft, Inc.
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing,
|
||||
software distributed under the License is distributed on an
|
||||
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
|
||||
either express or implied. See the License for the specific
|
||||
language governing permissions and limitations under the License.
|
||||
21
src/yaml-languageservice/LICENSE
Normal file
21
src/yaml-languageservice/LICENSE
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2017 Red Hat Inc. and others.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
Loading…
Reference in a new issue