@ckeditor/ckeditor5-utils - npm Package Compare versions

Comparing version 10.2.1 to 11.0.0

CHANGELOG.md

 Changelog
 =========
 
+## [11.0.0](https://github.com/ckeditor/ckeditor5-utils/compare/v10.2.1...v11.0.0) (2018-10-08)
+
+### Other changes
+
+* Removed the `lodash` library from this package (a modular `lodash` build has been kept under `src/lib/lodash/`). We now recommend using `lodash-es` directly. Closes [#251](https://github.com/ckeditor/ckeditor5-utils/issues/251). ([637c9e3](https://github.com/ckeditor/ckeditor5-utils/commit/637c9e3))
+
+### BREAKING CHANGES
+
+* Removed the `lodash` library from this package (a modular `lodash` build has been kept under `src/lib/lodash/`). We now recommend using `lodash-es` directly.
+
+
 ## [10.2.1](https://github.com/ckeditor/ckeditor5-utils/compare/v10.2.0...v10.2.1) (2018-07-18)
@@ -5,0 +16,0 @@

package.json

 {
   "name": "@ckeditor/ckeditor5-utils",
-  "version": "10.2.1",
+  "version": "11.0.0",
   "description": "Miscellaneous utils used by CKEditor 5.",
@@ -12,9 +12,10 @@ "keywords": [
   "dependencies": {
-    "ckeditor5": "^11.0.1"
+    "ckeditor5": "^11.1.0",
+    "lodash-es": "^4.17.10"
   },
   "devDependencies": {
-    "@ckeditor/ckeditor5-core": "^11.0.0",
-    "@ckeditor/ckeditor5-engine": "^10.2.0",
+    "@ckeditor/ckeditor5-core": "^11.0.1",
+    "@ckeditor/ckeditor5-engine": "^11.0.0",
     "del": "^2.2.0",
-    "eslint": "^4.15.0",
+    "eslint": "^5.5.0",
     "eslint-config-ckeditor5": "^1.0.7",
@@ -21,0 +22,0 @@ "husky": "^0.14.3",

README.md

@@ -17,3 +17,3 @@ CKEditor 5 utilities
 
-See the [`@ckeditor/ckeditor5-utils` package](https://docs.ckeditor.com/ckeditor5/latest/api/utils.html) page in [CKEditor 5 documentation](https://docs.ckeditor.com/ckeditor5/latest/).
+See the [`@ckeditor/ckeditor5-utils` package](https://ckeditor.com/docs/ckeditor5/latest/api/utils.html) page in [CKEditor 5 documentation](https://ckeditor.com/docs/ckeditor5/latest/).
 
@@ -20,0 +20,0 @@ ## License

src/ckeditorerror.js

@@ -14,3 +14,3 @@ /**
 export const DOCUMENTATION_URL =
-	'https://docs.ckeditor.com/ckeditor5/latest/framework/guides/support/error-codes.html';
+	'https://ckeditor.com/docs/ckeditor5/latest/framework/guides/support/error-codes.html';
 
@@ -17,0 +17,0 @@ /**

src/config.js

@@ -10,3 +10,3 @@ /**
 
-import isPlainObject from './lib/lodash/isPlainObject';
+import { isPlainObject } from 'lodash-es';
 
@@ -13,0 +13,0 @@ /**

src/dom/createelement.js

@@ -10,4 +10,4 @@ /**
 
-import isString from '../lib/lodash/isString';
 import isIterable from '../isiterable';
+import { isString } from 'lodash-es';
 
@@ -14,0 +14,0 @@ /**

src/dom/emittermixin.js

@@ -12,5 +12,5 @@ /**
 import uid from '../uid';
-import extend from '../lib/lodash/extend';
 import isNode from './isnode';
 import isWindow from './iswindow';
+import { extend } from 'lodash-es';
 
@@ -17,0 +17,0 @@ /**

src/dom/position.js

@@ -14,3 +14,3 @@ /**
 import getBorderWidths from './getborderwidths';
-import isFunction from '../lib/lodash/isFunction';
+import { isFunction } from 'lodash-es';
 
@@ -17,0 +17,0 @@ /**

src/dom/rect.js

@@ -12,7 +12,9 @@ /**
 import isWindow from './iswindow';
-import isElement from '../lib/lodash/isElement';
 import getBorderWidths from './getborderwidths';
 import log from '../log';
 import isText from './istext';
+import { isElement } from 'lodash-es';
 
+const rectProperties = [ 'top', 'right', 'bottom', 'left', 'width', 'height' ];
+
 /**
@@ -385,4 +387,2 @@ * A helper class representing a `ClientRect` object, e.g. value returned by
 
-const rectProperties = [ 'top', 'right', 'bottom', 'left', 'width', 'height' ];
-
 // Acquires all the rect properties from the passed source.
@@ -389,0 +389,0 @@ //

src/keystrokehandler.js

@@ -14,14 +14,31 @@ /**
 /**
- * Keystroke handler registers keystrokes so the callbacks associated
- * with these keystrokes will be executed if the matching `keydown` is fired
- * by a defined emitter.
+ * Keystroke handler allows registering callbacks for given keystrokes.
  *
- *		const handler = new KeystrokeHandler();
+ * The most frequent use of this class is through the {@link module:core/editor/editor~Editor#keystrokes `editor.keystrokes`}
+ * property. It allows listening to keystrokes executed in the editing view:
  *
- *		handler.listenTo( emitter );
- *
- *		handler.set( 'Ctrl+A', ( keyEvtData, cancel ) => {
+ *		editor.keystrokes.set( 'Ctrl+A', ( keyEvtData, cancel ) => {
  *			console.log( 'Ctrl+A has been pressed' );
  *			cancel();
  *		} );
+ *
+ * However, this utility class can be used in various part of the UI. For instance, a certain {@link module:ui/view~View}
+ * can use it like this:
+ *
+ *		class MyView extends View {
+ *			constructor() {
+ *				this.keystrokes = new KeystrokeHandler();
+ *
+ * 				this.keystrokes.set( 'tab', handleTabKey );
+ *			}
+ *
+ *			render() {
+ *				super.render();
+ *
+ *				this.keystrokes.listenTo( this.element );
+ *			}
+ *		}
+ *
+ * That keystroke handler will listen to `keydown` events fired in this view's main element.
+ *
  */
@@ -28,0 +45,0 @@ export default class KeystrokeHandler {

src/observablemixin.js

@@ -12,4 +12,3 @@ /**
 import CKEditorError from './ckeditorerror';
-import extend from './lib/lodash/extend';
-import isObject from './lib/lodash/isObject';
+import { extend, isObject } from 'lodash-es';
 
@@ -16,0 +15,0 @@ const observablePropertiesSymbol = Symbol( 'observableProperties' );

src/tomap.js

@@ -10,4 +10,4 @@ /**
 
-import isPlainObject from './lib/lodash/isPlainObject';
 import objectToMap from './objecttomap';
+import { isPlainObject } from 'lodash-es';
 
@@ -14,0 +14,0 @@ /**

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

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

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

Uses eval

Supply chain risk

Package uses dynamic code execution (e.g., eval()), which is a dangerous practice. This can prevent the code from running in certain environments and increases the risk that the code may contain exploits or malicious behavior.

Found 1 instance in 1 package

Improved metrics

Number of medium supply chain risk alerts

1

decreased by-50%

Worsened metrics

Total package byte prevSize

195211

decreased by-74.91%

Dependency count

2

increased by100%

Number of package files

55

decreased by-91.38%

Lines of code

5169

decreased by-78.22%

Dependency changes

• + Addedlodash-es@^4.17.10

• + Addedlodash-es@4.17.21(transitive)

• Updatedckeditor5@^11.1.0