Ember CLI Version Checker

Makes it easier to determine if a compatible version of a given NPM or Bower package is present.

Usage

Example:

You want to provide two different sets of templates, based on the currently running Ember version.

1let path = require('path');
2let VersionChecker = require('ember-cli-version-checker');
3
4module.exports = {
5  name: 'awesome-addon',
6  treeForAddonTemplates(tree) {
7    let checker = new VersionChecker(this);
8    let dep = checker.for('ember', 'bower');
9
10    let baseTemplatesPath = path.join(this.root, 'addon/templates');
11
12    if (dep.satisfies('>= 1.13.0')) {
13      return this.treeGenerator(path.join(baseTemplatesPath, 'current'));
14    } else {
15      return this.treeGenerator(path.join(baseTemplatesPath, 'legacy'));
16    }
17  }
18};

API

Semver Methods (gt, lt, gte, lte, eq, neq, satisfies)

See https://github.com/npm/node-semver#comparison and https://github.com/npm/node-semver#ranges-1 for more info

1let VersionChecker = require('ember-cli-version-checker');
2
3module.exports = {
4  name: 'awesome-addon',
5  init() {
6    let checker = new VersionChecker(this);
7    let dep = checker.for('ember-cli');
8
9    if (dep.gte('2.0.0')) {
10      /* deal with 2.0.0+ stuff */
11    } else {
12      /* provide backwards compat */
13    };
14  }
15};

assertAbove

Throws an error with the given message if a minimum version isn't met.

1let VersionChecker = require('ember-cli-version-checker');
2
3module.exports = {
4  name: 'awesome-addon',
5  init() {
6    this._super && this._super.init.apply(this, arguments); 
7
8    let checker = new VersionChecker(this);
9
10    checker.for('ember-cli').assertAbove('2.0.0');
11  }
12};

You can also provide a specific message as the third argument to assertAbove if you'd like to customize the output.

1let VersionChecker = require('ember-cli-version-checker');
2
3module.exports = {
4  name: 'awesome-addon',
5  init() {
6    let checker = new VersionChecker(this);
7
8    checker.for('ember-cli').assertAbove('2.0.0', 'To use awesome-addon you must have ember-cli 2.0.0');
9  }
10};

isAbove

Returns true if the packages version is above the specified comparison range.

1let VersionChecker = require('ember-cli-version-checker');
2
3module.exports = {
4  name: 'awesome-addon',
5  init() {
6    let checker = new VersionChecker(this);
7    let dep = checker.for('ember-cli');
8
9    if (dep.isAbove('2.0.0')) {
10      /* deal with 2.0.0 stuff */
11    } else {
12      /* provide backwards compat */
13    };
14  }
15};

forEmber

Since ember introduced the ember-source from NPM, ember has two ways to be shipped. One from bower ember and other from NPM ember-source. The function forEmber will look for ember-source from NPM, if it doesn't find it, it will look for ember in bower.

1let VersionChecker = require('ember-cli-version-checker');
2
3module.exports = {
4  name: 'awesome-addon',
5  init() {
6    let checker = new VersionChecker(this);
7    let ember = checker.forEmber();
8
9    if (ember.isAbove('2.10.0')) {
10      /* deal with 2.10.0 stuff */
11    };
12  }
13};

exists

Returns true or false indicating if the dependency exists (at any version).

1let VersionChecker = require('ember-cli-version-checker');
2
3module.exports = {
4  name: 'awesome-addon',
5  init() {
6    this._super.init.apply(this, arguments);
7
8    let checker = new VersionChecker(this);
9    let dep = checker.for('ember-cli-qunit');
10
11    if (dep.exists()) {
12      /* do things when present */
13    };
14  }
15};

version

A property that returns the version for the dependency, if the dependency is not found undefined will be returned.

1let VersionChecker = require('ember-cli-version-checker');
2
3module.exports = {
4  name: 'awesome-addon',
5  init() {
6    this._super.init.apply(this, arguments);
7
8    let checker = new VersionChecker(this);
9    let dep = checker.for('ember-cli-qunit');
10
11    // do something with dep.version
12  }
13};