← All rules

CommentsComment quality

comments/require-actionable-todos

Task markers need enough context to identify the work, rationale, removal condition, or relevant issue without requiring an owner or date.

todofixmemaintenance

01 Examples

TypeScript

// TODO: fix this

Finding

Require actionable TODO, FIXME, and HACK markers.

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-todos": "warn"

Package

@scruple/comments

Default threshold

0.8

Minimum confidence

0.7