@ckeditor/ckeditor5-inspector - npm Package Compare versions

Comparing version 1.0.0 to 1.1.0

CHANGELOG.md

 Changelog
 =========
 
+## [1.1.0](https://github.com/ckeditor/ckeditor5-inspector/compare/v1.0.0...v1.1.0) (2019-03-06)
+
+### Features
+
+* Allowed using the editor instance as the only argument of `CKEditorInspector.attach()`. Closes [#11](https://github.com/ckeditor/ckeditor5-inspector/issues/11). ([63ff58e](https://github.com/ckeditor/ckeditor5-inspector/commit/63ff58e))
+
+### Bug fixes
+
+* Command value should be displayed properly in the list when defined as an object. Related to [#9](https://github.com/ckeditor/ckeditor5-inspector/issues/9). ([3d36cfa](https://github.com/ckeditor/ckeditor5-inspector/commit/3d36cfa))
+* The command inspector should not crash when command's value is `undefined`. ([10821a3](https://github.com/ckeditor/ckeditor5-inspector/commit/10821a3))
+* The inspector should not crash when an attribute value is an object. Closes [#10](https://github.com/ckeditor/ckeditor5-inspector/issues/10). ([681f2e2](https://github.com/ckeditor/ckeditor5-inspector/commit/681f2e2))
+* The view tree inspector should display all attributes of all elements. Closes [#9](https://github.com/ckeditor/ckeditor5-inspector/issues/9). ([705f3c4](https://github.com/ckeditor/ckeditor5-inspector/commit/705f3c4))
+* View EmptyElement should not render with a closing tag. Added support for missing Empty and UI elements in the inspector and the tree. Closes [#5](https://github.com/ckeditor/ckeditor5-inspector/issues/5). ([e648ab4](https://github.com/ckeditor/ckeditor5-inspector/commit/e648ab4))
+
+### Other changes
+
+* Code refactoring. Minor improvements in rendering attributes and properties. ([ad65184](https://github.com/ckeditor/ckeditor5-inspector/commit/ad65184))
+
+
 ## [1.0.0](https://github.com/ckeditor/ckeditor5-inspector/tree/v1.0.0) (2019-02-28)
 
 Initial release.

package.json

 {
   "name": "@ckeditor/ckeditor5-inspector",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "The official CKEditor 5 instance inspector.",
@@ -5,0 +5,0 @@ "dependencies": {},

README.md

 CKEditor 5 inspector
 =====================================
 
+[![Join the chat at https://gitter.im/ckeditor/ckeditor5](https://badges.gitter.im/ckeditor/ckeditor5.svg)](https://gitter.im/ckeditor/ckeditor5?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-inspector.svg)](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-inspector)
+[![devDependency Status](https://david-dm.org/ckeditor/ckeditor5-inspector/dev-status.svg)](https://david-dm.org/ckeditor/ckeditor5-inspector?type=dev)
+
+The official [CKEditor 5](https://ckeditor.com/ckeditor-5) rich text editor instance inspector for developers.
+
+![The inspector panel attached to the editor instance.](/sample/screenshot.png)
+
 ## Usage
@@ -16,9 +24,9 @@
 ClassicEditor
-	.create( ... )
-	.then( editor => {
-		CKEditorInspector.attach( 'editor-name', editor );
-	} )
-	.catch( error => {
-		console.error( error );
-	} );
+    .create( ... )
+    .then( editor => {
+        CKEditorInspector.attach( 'editor-name', editor );
+    } )
+    .catch( error => {
+        console.error( error );
+    } );
 ```
@@ -30,4 +38,51 @@
 
+## Compatibility
+
+The inspector works with CKEditor 5 [v12.0.0](https://github.com/ckeditor/ckeditor5/releases/tag/v12.0.0)+.
+
+## Development
+
+To configure the environment:
+
+```console
+git clone [e-mail]:ckeditor/ckeditor5-inspector.git
+cd ckeditor5-inspector
+yarn install
+```
+
+### Working with the code
+
+Start the webpack file watcher:
+
+```console
+yarn dev
+```
+
+and open `http://path/to/ckeditor5-inspector/sample` in your web browser.
+
+### Building
+
+To build the production version of the inspector, run:
+
+```console
+yarn build
+```
+
+## Releasing
+
+The release process is as follows (order matters):
+
+```console
+yarn changelog
+yarn preversion
+```
+
+Run the sample and make sure global `CKEDITOR_INSPECTOR_VERSION` is right. Then:
+
+```console
+yarn release
+```
+
 ## License
 
 Licensed under the terms of [GNU General Public License Version 2 or later](http://www.gnu.org/licenses/gpl.html). For full details about the license, please check the `LICENSE.md` file.

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

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

188703

increased by2.18%

Lines of code

807

increased by0.88%

Number of lines in readme file

87

increased by171.88%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes