Found warning comments in code JS-0099
Documentation
Minor
3 years ago
—
3 years old
Unexpected 'todo' comment: 'todo: -translate-y-1/2 this also we need...'
30 className={`btn btn-accent rounded-sm btn-size absolute left-4 top-1/2 z-20 ${
31 !hasItemsOnLeft && 'hidden'
32 }`}
33 // todo: -translate-y-1/2 this also we need to add to make it vertically center34 // disabled={isPending ? true : false}
35 onClick={scrollLeft}
36 type="button"Unexpected 'todo' comment: 'todo: -translate-y-1/2 this also we need...'
18 className={`btn btn-accent rounded-sm btn-size absolute right-4 top-1/2 z-20 ${
19 !hasItemsOnRight && 'hidden'
20 }`}
21 // todo: -translate-y-1/2 this also we need to add to make it vertically center22 // disabled={isPending ? true : false}
23 onClick={scrollRight}
24 type="button"Unexpected 'todo' comment: 'TODO send email per...'
21 };
22
23 const result = await db.collection('DeviceDonations').add(data);
24 // TODO send email per https://github.com/margaritahumanitarian/helpafamily/issues/16625 res.status(StatusCodes.OK).json({ receiptNumber: result.id, data });
26}
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
}
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
}