ember-cli-version-checker - npm Package Compare versions

Comparing version 3.1.3 to 4.0.0

CHANGELOG.md

@@ -0,1 +1,11 @@
+## v4.0.0 (2020-01-16)
+
+#### :boom: Breaking Change & :rocket: Enhancement
+* [#163](https://github.com/ember-cli/ember-cli-version-checker/pull/163) drop unsupported node versions and upgrade all dependencies ([@stefanpenner](https://github.com/stefanpenner))
+
+#### Committers: 3
+- Stefan Penner ([@stefanpenner](https://github.com/stefanpenner))
+- Thomas Wang ([@xg-wang](https://github.com/xg-wang))
+- [@dependabot-preview[bot]](https://github.com/apps/dependabot-preview)
+
 ## v3.1.3 (2019-03-26)
@@ -2,0 +12,0 @@

package.json

 {
   "name": "ember-cli-version-checker",
-  "version": "3.1.3",
+  "version": "4.0.0",
   "description": "Determine if your addon is being used by a minimum version of Ember CLI.",
@@ -29,18 +29,20 @@ "homepage": "https://github.com/rwjblue/ember-cli-version-checker",
   "dependencies": {
-    "resolve-package-path": "^1.2.6",
-    "semver": "^5.6.0"
+    "resolve-package-path": "^2.0.0",
+    "semver": "^7.1.1"
   },
   "devDependencies": {
     "broccoli-test-helper": "^2.0.0",
-    "co": "^4.6.0",
-    "eslint-config-prettier": "^4.1.0",
-    "eslint-plugin-prettier": "^3.0.1",
-    "lerna-changelog": "^0.8.2",
-    "mocha": "^6.0.2",
-    "mocha-eslint": "^5.0.0",
-    "prettier": "^1.16.4"
+    "eslint-config-prettier": "^6.9.0",
+    "eslint-plugin-prettier": "^3.1.2",
+    "lerna-changelog": "^1.0.0",
+    "mocha": "^7.0.0",
+    "mocha-eslint": "^6.0.0",
+    "prettier": "^1.19.1"
   },
   "engines": {
-    "node": "6.* || 8.* || >= 10.*"
+    "node": "10.* || >= 12.*"
+  },
+  "volta": {
+    "node": "12.14.1"
   }
 }

README.md

@@ -21,3 +21,3 @@ # Ember CLI Version Checker
   treeForAddonTemplates(tree) {
-    let checker = new VersionChecker(this);
+    let checker = new VersionChecker(this.project);
     let dep = checker.for('ember', 'bower');
@@ -48,3 +48,5 @@
   init() {
-    let checker = new VersionChecker(this);
+    this._super.init.apply(this, arguments);
+
+    let checker = new VersionChecker(this.project);
     let dep = checker.for('ember-cli');
@@ -71,5 +73,5 @@
   init() {
-    this._super && this._super.init.apply(this, arguments); 
+    this._super.init.apply(this, arguments);
 
-    let checker = new VersionChecker(this);
+    let checker = new VersionChecker(this.project);
 
@@ -89,4 +91,6 @@ checker.for('ember-cli').assertAbove('2.0.0');
   init() {
-    let checker = new VersionChecker(this);
+    this._super.init.apply(this, arguments);
 
+    let checker = new VersionChecker(this.project);
+
     checker.for('ember-cli').assertAbove('2.0.0', 'To use awesome-addon you must have ember-cli 2.0.0');
@@ -107,3 +111,5 @@ }
   init() {
-    let checker = new VersionChecker(this);
+    this._super.init.apply(this, arguments);
+
+    let checker = new VersionChecker(this.project);
     let dep = checker.for('ember-cli');
@@ -133,3 +139,5 @@
   init() {
-    let checker = new VersionChecker(this);
+    this._super.init.apply(this, arguments);
+
+    let checker = new VersionChecker(this.project);
     let ember = checker.forEmber();
@@ -156,3 +164,3 @@
 
-    let checker = new VersionChecker(this);
+    let checker = new VersionChecker(this.project);
     let dep = checker.for('ember-cli-qunit');
@@ -180,3 +188,3 @@
 
-    let checker = new VersionChecker(this);
+    let checker = new VersionChecker(this.project);
     let dep = checker.for('ember-cli-qunit');
@@ -188,1 +196,26 @@
 ```
+
+## Note
+
+### How does the version resolution works?
+
+When creating `VersionChecker(addonOrAppOrProject)`, the param needs to have a `root`
+property for the VersionChecker to perform node's
+[module resolution](https://nodejs.org/api/modules.html#modules_all_together).
+
+### Should I use project or parent?
+
+The two primary options that are valid are:
+
+- `new VersionChecker(this.project)`
+- `new VersionChecker(this.parent)`
+
+Which one to use depends on if the addon is trying to find a known top-level library or its parent's.
+
+For example, you may want to check `this.project` root path to find `ember-cli` or `ember-source`,
+which are expected to be top-level.
+Or you may want to check your parent's specific dependency that affects your addon's behavior, you should create
+from `this.parent`.
+
+If you create via `new VersionChecker(this)` in an addon, it will resolve from your addon's path and have your
+own dependency's version instead of top-level dependency's if exists. This will result in unreliable result.

src/dependency-version-checker.js

@@ -54,7 +54,3 @@ 'use strict';
     if (!message) {
-      message = `The addon \`${this._parent._addon.name}\` requires the ${
-        this._type
-      } package \`${this.name}\` to be above ${compareVersion}, but you have ${
-        this.version
-      }.`;
+      message = `The addon \`${this._parent._addon.name}\` requires the ${this._type} package \`${this.name}\` to be above ${compareVersion}, but you have ${this.version}.`;
     }
@@ -61,0 +57,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

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

18833

increased by9.97%

Dev dependency count

7

decreased by-12.5%

Number of lines in readme file

213

increased by18.33%

Worsened metrics

Lines of code

134

decreased by-2.9%

Dependency changes

• + Addedresolve-package-path@2.0.0(transitive)

• + Addedsemver@7.6.3(transitive)

• - Removedresolve-package-path@1.2.7(transitive)

• - Removedsemver@5.7.2(transitive)

• Updatedresolve-package-path@^2.0.0

• Updatedsemver@^7.1.1