JS-0099 · Found warning comments in code

Found warning comments in code JS-0099

Documentation

Minor

16 hours ago — 7 months old

Unexpected 'todo' comment: 'TODO: send all the code at once and then...'

205        const files = osWalk(KNOBS_DIR);
206        const sleep = (ms: number) => new Promise((resolve) => setTimeout(resolve, ms));
207
208        // TODO: send all the code at once and then rename the files.209
210        for (let i = 0; i < files.length; i++) {
211            const file = files[i];

Unexpected 'todo' comment: 'TODO: add command only to knobs'

src/nuke/nodes_tree.ts

171        this.description = this.version;
172        this.contextValue = context.context;
173
174        // TODO: add command only to knobs175        this.command = {
176            command: "nuke-tools.on_itemClicked",
177            title: label,

Unexpected 'todo' comment: 'TODO: add windows support.'

src/launch_executable.ts

118export function getCliCmd(execPath: ExecutablePath): string {
119    const cliCmd = execPath.cliCmd();
120
121    // TODO: add windows support.122    if (os.type() === "Windows_NT") {
123        return cliCmd;
124    }

Description

Developers often add comments to code that is not complete or needs review. You probably want to fix or review the code and then remove the comments before considering the code to be production-ready. Issues are raised whenever our analyzer finds these keywords in the comments i.e., TODO, FIXME, XXX.

// TODO: do something
// FIXME: this is not a good idea

Bad Practice

// default - { "terms": ["todo", "fixme", "xxx"], "location": "start" }
function callback(err, results) {
  if (err) {
    console.error(err);
    return;
  }
  // TODO
}

sisoe24 / Nuke-Tools

Bad Practice

Recommended