@buschtoens/ember-cli-version-checker
v2.1.3-beta.1
Published
Determine if your addon is being used by a minimum version of Ember CLI.
Downloads
3
Readme
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.
let path = require('path');
let VersionChecker = require('ember-cli-version-checker');
module.exports = {
name: 'awesome-addon',
treeForAddonTemplates(tree) {
let checker = new VersionChecker(this);
let dep = checker.for('ember', 'bower');
let baseTemplatesPath = path.join(this.root, 'addon/templates');
if (dep.satisfies('>= 1.13.0')) {
return this.treeGenerator(path.join(baseTemplatesPath, 'current'));
} else {
return this.treeGenerator(path.join(baseTemplatesPath, 'legacy'));
}
}
};
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
let VersionChecker = require('ember-cli-version-checker');
module.exports = {
name: 'awesome-addon',
init() {
let checker = new VersionChecker(this);
let dep = checker.for('ember-cli');
if (dep.gte('2.0.0')) {
/* deal with 2.0.0+ stuff */
} else {
/* provide backwards compat */
};
}
};
assertAbove
Throws an error with the given message if a minimum version isn't met.
let VersionChecker = require('ember-cli-version-checker');
module.exports = {
name: 'awesome-addon',
init() {
this._super && this._super.init.apply(this, arguments);
let checker = new VersionChecker(this);
checker.for('ember-cli').assertAbove('2.0.0');
}
};
You can also provide a specific message as the third argument to assertAbove
if you'd like to customize the output.
let VersionChecker = require('ember-cli-version-checker');
module.exports = {
name: 'awesome-addon',
init() {
let checker = new VersionChecker(this);
checker.for('ember-cli').assertAbove('2.0.0', 'To use awesome-addon you must have ember-cli 2.0.0');
}
};
isAbove
Returns true
if the packages version is above the specified comparison range.
let VersionChecker = require('ember-cli-version-checker');
module.exports = {
name: 'awesome-addon',
init() {
let checker = new VersionChecker(this);
let dep = checker.for('ember-cli');
if (dep.isAbove('2.0.0')) {
/* deal with 2.0.0 stuff */
} else {
/* provide backwards compat */
};
}
};
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.
let VersionChecker = require('ember-cli-version-checker');
module.exports = {
name: 'awesome-addon',
init() {
let checker = new VersionChecker(this);
let ember = checker.forEmber();
if (ember.isAbove('2.10.0')) {
/* deal with 2.10.0 stuff */
};
}
};
exists
Returns true
or false
indicating if the dependency exists (at any version).
let VersionChecker = require('ember-cli-version-checker');
module.exports = {
name: 'awesome-addon',
init() {
this._super.init.apply(this, arguments);
let checker = new VersionChecker(this);
let dep = checker.for('ember-cli-qunit');
if (dep.exists()) {
/* do things when present */
};
}
};
version
A property that returns the version for the dependency, if the dependency is not found
undefined
will be returned.
let VersionChecker = require('ember-cli-version-checker');
module.exports = {
name: 'awesome-addon',
init() {
this._super.init.apply(this, arguments);
let checker = new VersionChecker(this);
let dep = checker.for('ember-cli-qunit');
// do something with dep.version
}
};