Found warning comments in code JS-0099
Documentation
Minor
15 days ago
—
3 years old
Unexpected 'todo' comment: 'TODO - Get rid of this eventually. Its a...'
6import { enablePrimitiveServer } from "@/componentAPI";
7
8// Enables primtiive server for componentAPI and cascades to template.ts
9// TODO - Get rid of this eventually. Its a hacky workarouond paper which10// is what truly sucks in this universe.
11enablePrimitiveServer();
12const router: Express = express();Unexpected 'todo' comment: 'TODO - Make thi work with the...'
44 Registry.viewManager = viewManager;
45
46 viewManager.loadDeviceFromJSON(JSON.parse(Examples.UpdatedExample));
47 // TODO - Make thi work with the programmatic generation of the device 48 // viewManager.createNewDevice("New_Device");
49 viewManager.updateGrid();
50 viewManager.refresh();Unexpected 'todo' comment: 'TODO: Cancel renaming the connection in...'
309 },
310 renameConnectionCancel() {
311 this.connectionRenameMode = false;
312 // TODO: Cancel renaming the connection in the connection tool, pull the name and apply it to current name313 }
314 }
315};Unexpected 'todo' comment: 'TODO: Change the name of the connection...'
305 },
306 renameConnection() {
307 this.connectionRenameMode = false;
308 // TODO: Change the name of the connection in the connection tool309 },
310 renameConnectionCancel() {
311 this.connectionRenameMode = false;Unexpected 'todo' comment: 'TODO: Change this to use minttype in the...'
272 */
273 static getDefinition(threeduftype: string): LibraryEntryDefinition | null {
274 // If threeduftype is a key present in library, return the definition
275 // TODO: Change this to use minttype in the future276 if (Object.prototype.hasOwnProperty.call(ComponentAPI.library, threeduftype)) {
277 const template = ComponentAPI.library[threeduftype].object;
278 const definition = {
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
}