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
}

Recommended

// default - { "terms": ["todo", "fixme", "xxx"], "location": "start" }
function callback(err, results) {
  if (err) {
    console.error(err);
    return;
  }
  // NOT READY FOR PRIME TIME
  // but too bad, it is not a predefined warning term
}

DevClad-Inc / devclad

No ignore rules found