no-implicit-injections.md

ember/no-implicit-injections

💼 This rule is enabled in the ✅ recommended config.

🔧 This rule is automatically fixable by the --fix CLI option.

Ember 3.26 introduced a deprecation for relying on implicit service injections or allowing addons to implicitly inject services into all classes of certain types. Support for this is dropped in Ember 4.0.

In many applications, this.store from Ember Data is often used without injecting the store service in Controllers or Routes. Other addons may also have included implicit service injections via initializers and the application.inject API.

To resolve this deprecation, a service should be explicitly declared and injected using the service injection decorator.

Rule Details

This rule checks for a configured list of previously auto injected services and warns if they are used in classes without explicit injected service properties.

Examples

Examples of incorrect code for this rule:

// routes/index.js
import Route from '@ember/routing/route';

export default class IndexRoute extends Route {
  model() {
    return this.store.findAll('rental');
  }
}

// controllers/index.js
import Controller from '@ember/controller';
import { action } from '@ember/object';

export default class IndexController extends Controller {
  @action
  loadUsers() {
    return this.store.findAll('user');
  }
}

Examples of correct code for this rule:

// routes/index.js
import Route from '@ember/routing/route';
import { inject as service } from '@ember/service';

export default class IndexRoute extends Route {
  @service('store') store;

  model() {
    return this.store.findAll('rental');
  }
}

// controller/index.js
import Route from '@ember/routing/route';
import { action } from '@ember/object';
import { inject as service } from '@ember/service';

export default class IndexController extends Controller {
  @service('store') store;

  @action
  loadUsers() {
    return this.store.findAll('user');
  }
}

Migration

The autofixer for this rule will update classes and add injections for the configured services.

Configuration

This lint rule will search for instances of store used in routes or controllers by default. If you have other services that you would like to check for uses of, the configuration can be overridden.

• object -- containing the following properties:
  • array -- denyList -- Array of configuration objects configuring the lint rule to check for use of implicit injected services
    • string -- service -- The (kebab-case) service name that should be checked for implicit injections and error if found
    • array -- propertyName -- The property name where the service would be injected in classes. This defaults to the camel case version of the service config above.
    • array -- moduleNames -- Array of string listing the types of classes (Controller, Route, Component, etc) to check for implicit injections. If an array is declared, only those class types will be checked for implicit injection. (Defaults to checking all Ember Module class files/types)

Example config:

module.exports = {
  rules: {
    'ember/no-implicit-injections': ['error', {
      denyList: [
        // Ember Responsive Used to Auto Inject the media service in Components/Controllers
        { service: 'media', moduleNames: ['Component', 'Controller'] },
        // Ember CLI Flash Used to Auto Inject the flashMessages service in all modules
        { service: 'flash-messages' },
        // Check for uses of the store in Routes or Controllers
        { service: 'store', moduleNames: ['Route', 'Controller'] },
        // Check for the feature service injected as "featureChecker"
        { service: 'feature', propertyName: 'featureChecker' },
      ]
    }]
  }
}

References

• Deprecation
• Ember Data Store Service