Found warning comments in code JS-0099
Documentation
Minor
11 days ago
—
11 days old
Unexpected 'todo' comment: 'TODO: it's harcoded'
43 id: finding.identifier,
44 name: finding.title,
45 category: 'No Category',
46 severity: 'L', //TODO: it's harcoded 47 };
48 }),
49 );Unexpected 'todo' comment: 'TODO: Show error'
237
238 const handleSubmitNewAudit = async () => {
239 if (!currentAuditType || !currentLanguage) {
240 return; // TODO: Show error241 }
242
243 try {Unexpected 'todo' comment: 'TODO: Agregar loading page'
25 }, [isAuth, navigate]);
26
27 if (loading) {
28 return <div>Loading...</div>; // TODO: Agregar loading page29 }
30
31 return children;
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
}