template-no-deprecated.md

ember/template-no-deprecated

Disallows using Glimmer components, helpers, or modifiers that are marked @deprecated in their JSDoc.

This rule requires TypeScript (parserServices.program must be present). It is a no-op in plain .gjs files because cross-file import deprecations require type information.

Rule Details

The rule resolves template references through ESLint's scope analysis: a <Component> or {{helper}} reference is traced back to its import declaration, then the TypeScript type checker inspects the exported symbol's JSDoc tags for @deprecated.

Covered syntax:

Template syntax	Example
Component element	<DeprecatedComponent />
Helper / value mustache	{{deprecatedHelper}}
Block component	{{#DeprecatedBlock}}…{{/DeprecatedBlock}}
Modifier	<div {{deprecatedModifier}}>

Not covered (see future work): <MyComp @deprecatedArg={{x}}> — argument names are not scope-registered by the parser.

Examples

Given a module:

// deprecated-component.ts
/** @deprecated use NewComponent instead */
export default class DeprecatedComponent {}

Examples of incorrect code for this rule:

import DeprecatedComponent from './deprecated-component';

<template>
  <DeprecatedComponent />
</template>

import { deprecatedHelper } from './deprecated-helper';

<template>
  {{deprecatedHelper}}
</template>

Examples of correct code for this rule:

import NewComponent from './new-component';

<template>
  <NewComponent />
</template>