noDeprecatedImports

Ce contenu n’est pas encore disponible dans votre langue.

JavaScript (and super languages)

Summary

Rule available since: v2.2.5
Diagnostic Category: lint/nursery/noDeprecatedImports
This rule doesn’t have a fix.
The default severity of this rule is warning.
This rule belongs to the following domains:
- project
Sources:
- Inspired from @typescript-eslint/no-deprecated
- Inspired from import/no-deprecated

How to configure

1
{
2
  "linter": {
3
    "rules": {
4
      "nursery": {
5
        "noDeprecatedImports": "error"
6
      }
7
    }
8
  }
9
}

Description

Restrict imports of deprecated exports.

This rule flags any imports for symbols (such as types, functions, or anything else that can be imported), that are documented with a JSDoc comment that contains an “@deprecated” annotation.

Examples

Invalid

1
import { oldUtility } from "./utils.js";

/foo.js:1:10 lint/nursery/noDeprecatedImports ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ⚠ Deprecated import.
  
  > 1 │ import { oldUtility } from “./utils.js”;
      │          ^^^^^^^^^^
    2 │ 
  
  ℹ An @deprecated annotation indicates the author doesn’t want you to rely on this import anymore.
  
  ℹ You should probably import a different symbol instead.

1
/**
2
 * @deprecated
3
 */
4
export function oldUtility() {}

Valid

1
import { newUtility, oldUtility } from "./utils.js";

1
export function newUtility() {}
2

3
// @deprecated (this is not a JSDoc comment)
4
export function oldUtility() {}