Found warning comments in code JS-0099
Documentation
Minor
6 months ago
—
2 years old
Unexpected 'todo' comment: 'TODO: Why do we need to explicitly cast...'
33import type { TF, ModelDefinitionObjectOrFn, } from '../../../shared/src/types';
34import { getModel, } from './model-utils';
35
36// TODO: Why do we need to explicitly cast this to ModelDefinition? 37// This is an ESLint issue, Typescript picks this up correctly
38/* eslint-disable @typescript-eslint/no-unsafe-assignment */
39const DEFAULT_MODEL: ModelDefinitionObjectOrFn = DefaultUpscalerModel;
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
}