alfresco-ng2-components/tools/tslint-rules/adfPrefixNameRule.ts

import * as Lint from 'tslint';
import * as ts from 'typescript';
import { sprintf } from 'sprintf-js';
import { NgWalker } from 'codelyzer/angular/ngWalker';

export class Rule extends Lint.Rules.AbstractRule {
    public static metadata: Lint.IRuleMetadata = {
        ruleName: 'adf-prefix-name',
        type: 'maintainability',
        description: `Name events without the prefix on`,
        descriptionDetails: `See more at https://angular.io/guide/styleguide#dont-prefix-output-properties`,
        rationale: `Angular allows for an alternative syntax on-*. If the event itself was prefixed with on this would result in an on-onEvent binding expression`,
        options: null,
        optionsDescription: `Not configurable.`,
        typescriptOnly: true,
    };

    static FAILURE_STRING: string = 'In the class "%s", the output ' +
        'property "%s" should not be prefixed with on';

    public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {
        return this.applyWithWalker(
            new ADFOutputPrefixNameRule(sourceFile,
                this.getOptions()));
    }
}

class ADFOutputPrefixNameRule extends NgWalker {
    visitNgOutput(property: ts.PropertyDeclaration, output: ts.Decorator, args: string[]) {
        let className = (<any>property).parent.name.text;
        let memberName = (<any>property.name).text;

        if (memberName && memberName.startsWith('on')) {
            let failureConfig: string[] = [className, memberName];
            failureConfig.unshift(Rule.FAILURE_STRING);
            this.addFailure(
                this.createFailure(
                    property.getStart(),
                    property.getWidth(),
                    sprintf.apply(this, failureConfig)));
        }
    }
}