noFdescribeOrFitRule.ts

// Dependencies:
import { tsquery } from '@phenomnomnominal/tsquery';
import { Fix, Replacement, RuleFailure, Rules } from 'tslint';
import { SourceFile } from 'typescript';

// Constants:
const FDESCRIBE_FIT_QUERY = 'CallExpression > Identifier[name=/^f(describe|it)$/]';

const FAILURE_MESSAGE = (filter: string) => `
    Remember to remove "${filter}" once you have finished working on tests.
`;

export class Rule extends Rules.AbstractRule {
    public apply (sourceFile: SourceFile): Array<RuleFailure> {
        return tsquery(sourceFile, FDESCRIBE_FIT_QUERY).map(result => {
            return new RuleFailure(result.getSourceFile(), result.getStart(), result.getEnd(), FAILURE_MESSAGE(result.name as string), this.ruleName);
        });
    }
}