{"id":13806480,"url":"https://github.com/kategengler/ember-feature-flags","last_synced_at":"2025-05-15T07:03:43.277Z","repository":{"id":23383309,"uuid":"26744903","full_name":"kategengler/ember-feature-flags","owner":"kategengler","description":"Ember CLI addon for feature flags","archived":false,"fork":false,"pushed_at":"2025-02-22T04:21:43.000Z","size":865,"stargazers_count":212,"open_issues_count":6,"forks_count":41,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-14T10:42:46.842Z","etag":null,"topics":["hacktoberfest"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kategengler.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2014-11-17T07:20:44.000Z","updated_at":"2025-02-22T04:21:09.000Z","dependencies_parsed_at":"2024-01-09T05:01:38.052Z","dependency_job_id":"c557fb95-5a40-42e2-bd0b-163b1092baea","html_url":"https://github.com/kategengler/ember-feature-flags","commit_stats":{"total_commits":138,"total_committers":23,"mean_commits":6.0,"dds":0.4130434782608695,"last_synced_commit":"fd097c549d4b66049f0a84c1ea06fec61b09ef05"},"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kategengler%2Fember-feature-flags","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kategengler%2Fember-feature-flags/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kategengler%2Fember-feature-flags/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kategengler%2Fember-feature-flags/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kategengler","download_url":"https://codeload.github.com/kategengler/ember-feature-flags/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254291961,"owners_count":22046424,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest"],"created_at":"2024-08-04T01:01:12.302Z","updated_at":"2025-05-15T07:03:42.621Z","avatar_url":"https://github.com/kategengler.png","language":"JavaScript","funding_links":[],"categories":["Packages"],"sub_categories":["End-user customization"],"readme":"\n# ember-feature-flags [![Build Status](https://github.com/kategengler/ember-feature-flags/actions/workflows/ci.yml/badge.svg)](https://github.com/kategengler/ember-feature-flags/actions/workflows/ci.yml) [![Ember Observer Score](http://emberobserver.com/badges/ember-feature-flags.svg)](http://emberobserver.com/addons/ember-feature-flags)\n\nAn ember-cli addon to provide feature flags.\n\n### Versions\n\nTested against `ember-source` v4.12, v5.8, v5.12, v6.2, canary and beta. \n\nFor support for earlier `ember-source` use `ember-feature-flags@6.1.0`. \n\n### Installation\n\n```\nember install ember-feature-flags\n```\n\n### Usage\n\nThis addon provides a service named `features` available for injection into your routes, controllers, components, etc.\n\nFor example you may check if a feature is enabled:\n\n```js\nimport Controller from '@ember/controller';\nimport { inject as service } from '@ember/service';\nexport default class BillingPlansController extends Controller {\n  @service features;\n  get plans() {\n    if (this.features.isEnabled('newBillingPlans')) {\n      // Return new plans\n    } else {\n      // Return old plans\n    }\n  }\n}\n```\n\nCheck whether a feature is enabled in a template by using the `feature-flag` template helper:\n\n```hbs\n// templates/components/homepage-link.hbs\n{{#if (feature-flag 'newHomepage')}}\n  {{link-to \"new.homepage\"}}\n{{else}}\n  {{link-to \"old.homepage\"}}\n{{/if}}\n```\n\nFeatures can be toggled at runtime, and are bound:\n\n```js\n  this.features.enable('newHomepage');\n  this.features.disable('newHomepage');\n```\n\nFeatures can be set in bulk, resetting all existing features:\n\n```js\nthis.features.setup({\n  \"new-billing-plans\": true,\n  \"new-homepage\": false\n})\n```\n\nYou may want to set the flags based on the result of a fetch:\n\n```js\n// routes/application.js\n@service features;\nbeforeModel() {\n   return fetch('/my-flag/api').then((data) =\u003e {\n     features.setup(data.json());\n  });\n}\n```\n\n*NOTE:* `setup` methods reset previously setup flags and their state.\n\nYou can get list of known feature flags via `flags` computed property:\n```js\nthis.features.setup({\n  \"new-billing-plans\": true,\n  \"newHomepage\": false\n});\n\nthis.features.flags // ['new-billing-plans', 'newHomepage'] // Flags are exactly as they are passed in when set\n```\n\n\n### Configuration\n\n#### `config.featureFlags`\n\nYou can configure a set of initial feature flags in your app's `config/environment.js` file. This\nis an easy way to change settings for a given environment. For example:\n\n```javascript\n// config/environment.js\nmodule.exports = function(environment) {\n  var ENV = {\n    featureFlags: {\n      'show-spinners': true,\n      'download-cats': false\n    }\n  };\n\n  if (environment === 'production') {\n    ENV.featureFlags['download-cats'] = true;\n  }\n\n  return ENV;\n};\n```\n\n#### `ENV.LOG_FEATURE_FLAG_MISS`\n\nWill log when a feature flag is queried and found to be off, useful to prevent cursing at the app,\nwondering why your feature is not working.\n\n### Test Helpers\n\n#### `enableFeature` / `disableFeature`\n\nTurns on or off a feature for the test in which it is called.\nRequires ember-cli-qunit \u003e= 4.1.0 and the newer style of tests that use `setupTest`, `setupRenderingTest`, `setupApplicationTest`.\n\nExample:\n```js\nimport { enableFeature, disableFeature } from 'ember-feature-flags/test-support';\n\nmodule('Acceptance | Awesome page', function(hooks) {\n  setupApplicationTest(hooks);\n\n  test('it displays the expected welcome message', async function (assert) {\n    enableFeature('new-welcome-message');\n\n    await visit('/');\n\n    assert.dom('h1.welcome-message').hasText('Welcome to the new website!');\n\n    disableFeature('new-welcome-message');\n\n    await settled();\n\n    assert.dom('h1.welcome-message').hasText('This is our old website, upgrade coming soon');\n  });\n});\n```\n\n### Integration Tests\n\nIf you use `this.features.isEnabled()` in components under integration test, you will need to inject a stub service in your tests. Using ember-qunit 0.4.16 or later, here's how to do this:\n\n```js\nlet featuresService = Service.extend({\n  isEnabled() {\n    return false;\n  }\n});\n\nmoduleForComponent('my-component', 'Integration | Component | my component', {\n  integration: true,\n  beforeEach() {\n    this.register('service:features', featuresService);\n    getOwner(this).inject('component', 'features', 'service:features');\n  }\n});\n```\n\nNote: for Ember before 2.3.0, you'll need to use [ember-getowner-polyfill](https://github.com/rwjblue/ember-getowner-polyfill).\n\n### Development\n\n## Contributing\n\nSee the [Contributing](CONTRIBUTING.md) guide for details.\n\n## License\n\nThis project is licensed under the [MIT License](LICENSE.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkategengler%2Fember-feature-flags","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkategengler%2Fember-feature-flags","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkategengler%2Fember-feature-flags/lists"}