@ember/optional-features

What is @ember/optional-features?

@ember/optional-features is an npm package that allows Ember.js developers to enable or disable optional features in their Ember applications. This package provides a way to manage feature flags for various experimental or legacy features, making it easier to adopt new features or phase out old ones.

What are @ember/optional-features's main functionalities?

Enable/Disable Optional Features

This feature allows you to enable specific optional features in your Ember application. For example, you can enable the 'application-template-wrapper' feature using the command provided.

{"command":"ember feature:enable <feature-name>","example":"ember feature:enable application-template-wrapper"}

List Available Features

This feature lists all the optional features available for your Ember application. It helps you see which features are enabled or disabled.

{"command":"ember feature:list"}

Disable Optional Features

This feature allows you to disable specific optional features in your Ember application. For example, you can disable the 'application-template-wrapper' feature using the command provided.

{"command":"ember feature:disable <feature-name>","example":"ember feature:disable application-template-wrapper"}

Other packages similar to @ember/optional-features

ember-feature-controls

ember-feature-controls is another package for managing feature flags in Ember applications. It provides a simple API for defining and checking feature flags. Similar to ember-cli-feature-flags, it offers more flexibility for custom feature management compared to @ember/optional-features, which is specifically designed for managing Ember's built-in optional features.

README

@ember/optional-features

This addon allows you to easily enable/disable optional features in ember-source. To clarify what we mean by optional, these are features that will be opt-in/opt-out and optional for the foreseeable future, not features that will be enabled by default. It is intended for use with apps only not addons.

Installation

ember install @ember/optional-features

Usage

From command-line

List available features

Features will only be available in versions of ember-source that included them. To list all available features run:

ember feature:list

Enable/disable features

To enable a feature, run:

ember feature:enable some-feature

Similarly, if you want to disable a feature, you can run:

ember feature:disable some-feature

At build-time (from an addon)

This addon exposes a build-time method called isFeatureEnabled, which can be called from an addon's index.js, e.g.:

included() {
  let optionalFeatues = this.addons.find(a => a.name === '@ember/optional-features');
  if (optionalFeatures.isFeatureEnabled('jquery-integration') {
    // ...
  }
}

It also exposes a method called isFeatureExplicitlySet, which can be used to check whether or not the user has explictly set the value of the option instead of using the default.

At run-time (from an app or addon)

WIP -- there does not yet exist a public API for accessing the state of optional features at runtime. This issue is tracking it.