← All rules

CommentsAPI documentation

comments/require-actionable-deprecations

Deprecated APIs should name a replacement, give concrete migration steps, or explain usefully why no replacement exists.

deprecationmigrationdocumentation

01 Examples

TypeScript

/** @deprecated */
export function loadOld() {}

Finding

Require migration guidance in deprecations.

02 Enable it

Setup

Install the package, register its plugin factory, then enable the rule.

Install the package

pnpm add -D @scruple/comments

Register the plugin

In scruple.config.ts, register the factory under the comments namespace used by the rule ID.

import { comments } from "@scruple/comments";

plugins: {
  "comments": comments(),
},

Enable the rule

"comments/require-actionable-deprecations": "warn"

Package

@scruple/comments

Default threshold

0.85

Minimum confidence

0.7