Found warning comments in code JS-0099
Documentation
Minor
15 days ago
—
a year old
Unexpected 'todo' comment: 'TODO: [IN-924] Create generator to...'
22 dbContent: getValue(24, 24),
23}
24
25// TODO: [IN-924] Create generator to update Crowdin data on build 26
27export const sourceFiles = (lang: string) =>
28 getValue(Unexpected 'todo' comment: 'TODO: Do something to ensure that only...'
145 output.eligibility.age = eligAgeItem
146 }
147
148 // TODO: Do something to ensure that only one of these attributes is set149
150 break
151 }Unexpected 'todo' comment: 'TODO: Typescript wants these two...'
6 <ScrollArea.Autosize
7 mah='50vh'
8 placeholder={null}
9 // TODO: Typescript wants these two properties all of a sudden -- why?10 onPointerEnterCapture={undefined}
11 onPointerLeaveCapture={undefined}
12 >Unexpected 'todo' comment: 'TODO: Alter dropdown component to match...'
25 setOptions(data.map(({ id, tsKey, tsNs }) => ({ value: id, label: t(tsKey, { ns: tsNs }) }))),
26 })
27
28 //TODO: Alter dropdown component to match figma design 29 return <Select data={options} {...form.getInputProps('phoneTypeId')} />
30}
31Unexpected 'todo' comment: 'TODO: [IN-807] Validate accessibility...'
92 {address}
93 {remoteSection}
94 <Hours parentId={locationId} />
95 {/* TODO: [IN-807] Validate accessibility data points before enabling. 96 <Stack spacing={12} align='flex-start'> 97 <Badge 98 variant='attribute' 99 tsNs='attribute'100 tsKey='additional.wheelchair-accessible'101 tProps={{ context: `${isAccessible}` }}102 icon={isAccessible ? 'carbon:accessibility' : 'carbon:warning'}103 style={{ marginLeft: 0 }}104 />105 <Text variant={variants.Text.utility2}>106 {t('accessible-building', { context: `${isAccessible}` })}107 </Text>108 </Stack> */}109 </Stack>
110 )
111
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
}