@ember/edition-utils

WebJar for @ember/edition-utils

License	MIT
GroupId	org.webjars.npm
ArtifactId	ember__edition-utils
Last Version	1.2.0
Release Date	May 9, 2020
Type	jar
Description	@ember/edition-utils WebJar for @ember/edition-utils
Project URL	https://www.webjars.org
Source Code Management	https://github.com/emberjs/ember-edition-utils

Download ember__edition-utils

Filename	Size
ember__edition-utils-1.2.0.pom
ember__edition-utils-1.2.0.jar	8 KB
ember__edition-utils-1.2.0-sources.jar	22 bytes
ember__edition-utils-1.2.0-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/ember__edition-utils/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>ember__edition-utils</artifactId>
    <version>1.2.0</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/ember__edition-utils/
implementation 'org.webjars.npm:ember__edition-utils:1.2.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/ember__edition-utils/
implementation ("org.webjars.npm:ember__edition-utils:1.2.0")

Apache Buildr

'org.webjars.npm:ember__edition-utils:jar:1.2.0'

Apache Ivy

<dependency org="org.webjars.npm" name="ember__edition-utils" rev="1.2.0">
  <artifact name="ember__edition-utils" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='ember__edition-utils', version='1.2.0')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "ember__edition-utils" % "1.2.0"

Leiningen

[org.webjars.npm/ember__edition-utils "1.2.0"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

@ember/edition-utils

This package is the officially supported mechanism for declaring and detecting the specific edition that a given application is using.

Usage

Declaring Edition

In order to declare which edition of Ember your application (or addon's test bed application) is compatible with you would update your package.json to include the following:

{
  "name": "project-name",
  // ...snip
  "ember": {
    "edition": "octane"
  }
}

Detecting Edition

In order to detect if the currently running application is using at least a specific edition, you would call has. This will most commonly be used from within various addon's to determine which blueprint code to run. For example:

const { has } = require('@ember/edition-utils');

if (has('octane', this.project.root)) {
  // do octane stuff
} else {
  // do classic mode stuff
}

Valid use of the edition value

The edition flag should only be used by addons to determine what blueprint output to generate and to provide helpful warnings (or errors) at build time.

This does not allow for an addon to detect the edition configuration and change its fundamental implementation. This is quite intentional!

Instead, addons should rely on feature detection techniques like the following to alter implementations:

• Check to see if given methods/properties exist (this is essentially like how browser polyfills work)
• Use a tool like ember-compatibility-helpers's gte method (e.g. if (gte('ember-source', '3.14.0')) { })
• Use @ember/optional-features's isFeatureEnabled method

License

This project is licensed under the MIT License.

Ember.js

Versions

Version
1.2.0 May 9, 2020