← All rules

CommentsComment quality

comments/no-commented-out-code

Remove executable code hidden in comments while retaining legitimate examples, pseudocode, patterns, and data.

dead-codemaintenancecomments

01 Examples

TypeScript

// await legacySave(record);
await save(record);

Finding

Disallow disabled executable implementation.

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/no-commented-out-code": "warn"

Package

@scruple/comments

Default threshold

0.95

Minimum confidence

0.7