Implemented no-todo code style rule.

README.md

@@ -133,6 +133,8 @@ Default rules:
         "anon-function-style": "auto",
         "aa-comma-style": "no-dangling",
         "no-print": "off",
+        "no-todo": "off",
+        "todo-pattern": "TODO|todo|FIXME",
 
         "type-annotations": "off",
 
@@ -185,6 +187,10 @@ Default rules:
 
 - `no-print`: prevent usage of `print` statements in code (`error | warn | info | off`)
 
+- `no-todo`: prevent usage of `todo` comments in code (`error | warn | info | off`)
+
+- `todo-pattern`: string regex pattern to determine what a TODO is. default is `TODO|todo|FIXME` (**do not** include surrounding `/` characters).
+
 ### Strictness rules
 
 - `type-annotations`: validation of presence of `as` type annotations, for function

src/index.ts

@@ -34,6 +34,9 @@ export type BsLintConfig = Pick<BsConfig, 'project' | 'rootDir' | 'files' | 'cwd
         'aa-comma-style'?: RuleAAComma;
         'type-annotations'?: RuleTypeAnnotations;
         'no-print'?: RuleSeverity;
+        'no-todo'?: RuleSeverity;
+        // Will be transformed to RegExp type when program context is created.
+        'todo-pattern'?: string;
     };
     globals?: string[];
     ignores?: string[];
@@ -59,6 +62,7 @@ export interface BsLintRules {
     aaCommaStyle: RuleAAComma;
     typeAnnotations: RuleTypeAnnotations;
     noPrint: BsLintSeverity;
+    noTodo: BsLintSeverity;
 }
 
 export { Linter };

src/plugins/codeStyle/diagnosticMessages.ts

@@ -14,7 +14,8 @@ export enum CodeStyleError {
     TypeAnnotation = 'LINT3011',
     NoPrint = 'LINT3012',
     AACommaFound = 'LINT3013',
-    AACommaMissing = 'LINT3014'
+    AACommaMissing = 'LINT3014',
+    NoTodo = 'LINT3015'
 }
 
 const CS = 'Code style:';
@@ -113,6 +114,13 @@ export const messages = {
         message: `${CS} Avoid using direct Print statements`,
         range
     }),
+    noTodo: (range: Range, severity: DiagnosticSeverity) => ({
+        severity: severity,
+        code: CodeStyleError.NoTodo,
+        source: 'bslint',
+        message: `${CS} Avoid using TODO comments`,
+        range
+    }),
     removeAAComma: (range: Range) => ({
         severity: DiagnosticSeverity.Error,
         code: CodeStyleError.AACommaFound,

src/plugins/codeStyle/index.spec.ts

@@ -375,6 +375,42 @@ describe('codeStyle', () => {
         expect(actual).deep.equal(expected);
     });
 
+    describe('enforce no todo', () => {
+        it('default todo pattern', async () => {
+            const diagnostics = await linter.run({
+                ...project1,
+                files: ['source/no-todo.brs'],
+                rules: {
+                    'no-todo': 'error'
+                }
+            });
+            const actual = fmtDiagnostics(diagnostics);
+            const expected = [
+                `02:LINT3015:Code style: Avoid using TODO comments`,
+                `04:LINT3015:Code style: Avoid using TODO comments`,
+                `06:LINT3015:Code style: Avoid using TODO comments`,
+                `08:LINT3015:Code style: Avoid using TODO comments`,
+                '10:LINT3015:Code style: Avoid using TODO comments',
+                '12:LINT3015:Code style: Avoid using TODO comments'
+            ];
+            expect(actual).deep.equal(expected);
+        });
+
+        it('modified todo pattern', async () => {
+            const diagnostics = await linter.run({
+                ...project1,
+                files: ['source/no-todo.brs'],
+                rules: {
+                    'no-todo': 'error',
+                    'todo-pattern': 'PLEASEFIX'
+                }
+            });
+            const actual = fmtDiagnostics(diagnostics);
+            const expected = ['19:LINT3015:Code style: Avoid using TODO comments'];
+            expect(actual).deep.equal(expected);
+        });
+    });
+
     describe('AA style', () => {
         it('collects wrapping AA members indexes', () => {
             const { statements } = Parser.parse(`

src/plugins/codeStyle/index.ts

@@ -24,8 +24,9 @@ export default class CodeStyle {
 
         const diagnostics: (Omit<BsDiagnostic, 'file'>)[] = [];
         const { severity, fix } = this.lintContext;
-        const { inlineIfStyle, blockIfStyle, conditionStyle, noPrint, aaCommaStyle } = severity;
+        const { inlineIfStyle, blockIfStyle, conditionStyle, noPrint, noTodo, aaCommaStyle } = severity;
         const validatePrint = noPrint !== DiagnosticSeverity.Hint;
+        const validateTodo = noTodo !== DiagnosticSeverity.Hint;
         const validateInlineIf = inlineIfStyle !== 'off';
         const disallowInlineIf = inlineIfStyle === 'never';
         const requireInlineIfThen = inlineIfStyle === 'then';
@@ -85,6 +86,14 @@ export default class CodeStyle {
                 if (validateAAStyle) {
                     this.validateAAStyle(e, aaCommaStyle, diagnostics);
                 }
+            },
+            CommentStatement: e => {
+                if (validateTodo) {
+                    console.log('this.lintContext', this.lintContext);
+                    if (this.lintContext.todoPattern.test(e.text)) {
+                        diagnostics.push(messages.noTodo(e.range, noTodo));
+                    }
+                }
             }
         }), { walkMode: walkExpressions ? WalkMode.visitAllRecursive : WalkMode.visitStatementsRecursive });
 

src/util.ts

@@ -97,6 +97,8 @@ function tryLoadConfig(filename: string): BsLintConfig | undefined {
 export interface PluginContext {
     program: Readonly<Program>;
     severity: Readonly<BsLintRules>;
+    // TODO: Is this the right place to put this?
+    todoPattern: Readonly<RegExp>;
     globals: string[];
     ignores: (file: BscFile) => boolean;
     fix: Readonly<boolean>;
@@ -118,6 +120,7 @@ export function createContext(program: Program): PluginWrapperContext {
     return {
         program: program,
         severity: rulesToSeverity(rules),
+        todoPattern: rules['todo-pattern'] ? new RegExp(rules['todo-pattern']) : /TODO|todo|FIXME/,
         globals,
         ignores: (file: BscFile) => {
             return !file || ignorePatterns.some(pattern => minimatch(file.pathAbsolute, pattern));
@@ -152,7 +155,8 @@ function rulesToSeverity(rules: BsLintConfig['rules']) {
         anonFunctionStyle: rules['anon-function-style'],
         aaCommaStyle: rules['aa-comma-style'],
         typeAnnotations: rules['type-annotations'],
-        noPrint: ruleToSeverity(rules['no-print'])
+        noPrint: ruleToSeverity(rules['no-print']),
+        noTodo: ruleToSeverity(rules['no-todo'])
     };
 }
 

test/project1/source/no-todo.brs

@@ -0,0 +1,20 @@
+sub myFunc()
+    ' TODO: Fix this function
+
+    ' todo: please fix this
+
+' todo: fix this indentation
+
+    myLabel = CreateObject("roSGNode", "Label") ' todo: add font to label
+
+    ' FIXME: WE'RE IN ALL CAPS NOW FOR GOD'S SAKE FIX THIS!!!
+
+    ' TODO: This is a multiline todo
+    ' because sometimes we need to overexplain things.
+
+    ' and this is a regular comment!
+
+    ' another one!
+
+    ' PLEASEFIX: a different pattern
+end sub