monaco-json - npm Package Compare versions

Comparing version 1.0.1 to 1.0.2

package.json

 {
   "name": "monaco-json",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "JSON plugin for the Monaco Editor",
@@ -20,3 +20,3 @@ "scripts": {
   "dependencies": {
-    "vscode-json-languageservice": "^1.1.0",
+    "vscode-json-languageservice": "1.1.2",
     "vscode-languageserver-types": "^1.0.1"
@@ -23,0 +23,0 @@ },

README.md

 # Monaco JSON
 
-JSON language plugin for the Monaco Editor.
+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
 
+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.
+
 ## Installing
@@ -10,3 +22,28 @@
 
+* change to your favorite source folder (`/src/`)
+* `git clone https://github.com/Microsoft/monaco-editor` (this will create `$/src/monaco-editor`)
+* in folder `monaco-editor` run `npm install` and run `npm run simpleserver`
+* open http://localhost:8080/monaco-editor/test/index.html#sample - json
+
+## Development
+
+### Dev: Running monaco-json from source
+* change to your favorite source folder (`/src/`).
+* if you haven't done so: `git clone https://github.com/Microsoft/monaco-editor` (this will create `$/src/monaco-editor`)
+* `git clone https://github.com/Microsoft/monaco-json` (this will create `$/src/monaco-json`)
+* Important: both monaco repositories must have the same parent folder.
+* in folder `monaco-json` run `npm install` and run `npm run watch`
+* in folder `monaco-editor` run `npm install` and run `npm run simpleserver`
+* open http://localhost:8080/monaco-editor/test/?monaco-json=dev
+
+### [Optional] Running monaco-editor-core from source
+
+* this is only needed when you want to make changes also in `monaco-editor-core`.
+* change to the same favorite source folder (`/src/`) that already contains `monaco-json` and `monaco-editor`
+* `git clone https://github.com/Microsoft/vscode` (this will create `$/src/vscode/`)
+* read [here](https://github.com/Microsoft/vscode/wiki/How-to-Contribute#installing-prerequisites) on how to initialize the VS code source repository.
+* in folder `vscode` run `gulp watch`
+* open http://localhost:8080/monaco-editor/test/?monaco-json=dev&editor=dev
+
 ## License
 [MIT](https://github.com/Microsoft/monaco-json/blob/master/LICENSE.md)

release/min/jsonMode.js

 /*!-----------------------------------------------------------------------------
  * Copyright (c) Microsoft Corporation. All rights reserved.
- * monaco-json version: 1.0.1(76d2d0b8d1e3bc508dfa7b0ea08bfdc27ef3c7f5)
+ * monaco-json version: 1.0.2(7e50cccbb2e8248ffbdbae54ca440f2714dbc945)
  * Released under the MIT license
@@ -5,0 +5,0 @@ * https://github.com/Microsoft/monaco-json/blob/master/LICENSE.md

release/min/monaco.contribution.js

 /*!-----------------------------------------------------------------------------
  * Copyright (c) Microsoft Corporation. All rights reserved.
- * monaco-json version: 1.0.1(76d2d0b8d1e3bc508dfa7b0ea08bfdc27ef3c7f5)
+ * monaco-json version: 1.0.2(7e50cccbb2e8248ffbdbae54ca440f2714dbc945)
  * Released under the MIT license
@@ -5,0 +5,0 @@ * https://github.com/Microsoft/monaco-json/blob/master/LICENSE.md

release/min/monaco.d.ts

@@ -9,7 +9,7 @@ /*---------------------------------------------------------------------------------------------
         /**
-         * If set, the validator will return syntax errors.
+         * If set, the validator will be enabled and perform syntax validation as well as schema based validation.
          */
         validate?: boolean;
         /**
-         * If set, comments are toleranted. If not set, a syntax error is emmited for comments.
+         * If set, comments are tolerated. If set to false, syntax errors will be emmited for comments.
          */
@@ -16,0 +16,0 @@ allowComments?: boolean;

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

127074

increased by2.03%

Number of lines in readme file

49

increased by308.33%

Dependency changes

• + Addedvscode-json-languageservice@1.1.2(transitive)

• + Addedvscode-nls@1.0.7(transitive)

• - Removedvscode-json-languageservice@1.1.9(transitive)

• - Removedvscode-languageserver-types@1.0.2(transitive)

• - Removedvscode-nls@1.0.4(transitive)

• - Removedvscode-uri@0.0.7(transitive)

• Updatedvscode-json-languageservice@1.1.2