vrsource-tslint-rules/rules/literalSpacingRule.ts

Extension rules for tslint

/*  KEEP IN SYNC with README.md

## literal-spacing

Rule to enforce consistent spacing inside array and object literals.

See: eslint: object-curly-spacing and array-bracket-spacing

```javascript
"literal-spacing": [
    true,
    {
        "array": ["always"],
        "object": ["never"],
        "import": ["always"]
    }
]
```
*/

import * as Lint from "tslint";
import * as ts from "typescript";

const NEVER_FAIL = "Found extra space";
const ALWAYS_FAIL = "Missing whitespace";

const NEVER_OPT  = "never";
const ALWAYS_OPT = "always";

class LiteralSpacingRuleWalker extends Lint.RuleWalker {
    public arrayCheck:  string = NEVER_OPT;
    public objCheck:    string = NEVER_OPT;
    public importCheck: string = NEVER_OPT;

    constructor(sourceFile: ts.SourceFile, options: Lint.IOptions) {
        super(sourceFile, options);

        let array_opts  = this.getOption("array", []);
        let obj_opts    = this.getOption("object", []);
        let import_opts = this.getOption("import", []);

        this.arrayCheck  = contains(array_opts,  ALWAYS_OPT) ? ALWAYS_OPT : NEVER_OPT;
        this.objCheck    = contains(obj_opts,    ALWAYS_OPT) ? ALWAYS_OPT : NEVER_OPT;
        this.importCheck = contains(import_opts, ALWAYS_OPT) ? ALWAYS_OPT : NEVER_OPT;
    }

    protected getOption(option: string, defVal: any) {
        const allOptions = this.getOptions();
        if (allOptions == null || allOptions.length === 0) {
            return defVal;
        }

        return allOptions[0][option];
    }

    protected visitArrayLiteralExpression(node: ts.ArrayLiteralExpression) {
        this.lintNode(node, this.arrayCheck);
        super.visitArrayLiteralExpression(node);
    }

    protected visitBindingPattern(node: ts.BindingPattern) {
        if (node.kind === ts.SyntaxKind.ArrayBindingPattern) {
            this.lintNode(node, this.arrayCheck);
        }
        if (node.kind === ts.SyntaxKind.ObjectBindingPattern) {
            this.lintNode(node, this.objCheck);
        }
        super.visitBindingPattern(node);
    }

    protected visitNamedImports(node: ts.NamedImports) {
        this.lintNode(node, this.importCheck);
        super.visitNamedImports(node);
    }

    protected visitObjectLiteralExpression(node: ts.ObjectLiteralExpression) {
        this.lintNode(node, this.objCheck);
        super.visitObjectLiteralExpression(node);
    }

    protected lintNode(node: ts.Node, checkType: string) {
        // Assume that we have list of children where first child is [ or { and last is } or ]
        const children = node.getChildren();
        const self = this;

        if (children.length < 3) {
            return;
        }
        // const first_child = children[0];                 // " ["
        const second_child = children[1];                   // " 1, 3, 5,"
        const last_child   = children[children.length - 1];  // " ]"
        const is_empty     = second_child.getText() === "";

        let [front_start, front_end] = [second_child.getFullStart(), second_child.getStart()];
        let [back_start,  back_end]  = [last_child.getFullStart(), last_child.getStart()];

        let front_text = this.getSourceText(front_start, front_end);
        let back_text  = this.getSourceText(back_start, back_end);

        // outerText: the string between the full edge and the start of the node content
        // nodeEdgeChar: the first character of the node content
        function doCheck(edgeText: string, nodeEdgeChar: string, start: number, end: number) {
            if ((NEVER_OPT === checkType) &&
                ((edgeText.length > 0) || (nodeEdgeChar === " ")) &&
                (edgeText.indexOf("\n") === -1)) {
                const len = Math.max((end - start), 1);
                self.addFailure(self.createFailure(start, len, NEVER_FAIL));
            }

            if (ALWAYS_OPT === checkType) {
                if ((!is_empty) &&
                    (edgeText.length === 0) &&
                    (nodeEdgeChar !== " ")) {
                     self.addFailure(self.createFailure(start, 1, ALWAYS_FAIL));
                }
            }
        }

        doCheck(front_text, second_child.getText()[0], front_start, front_end);
        doCheck(back_text, last_child.getText()[-1], back_start, back_end);
    }

    protected getSourceText(pos: number, end: number): string {
        return this.getSourceFile().text.substring(pos, end);
    }
}

function contains(arr: any[], value: any): boolean {
   return arr && arr.indexOf(value) !== -1;
}

export class Rule extends Lint.Rules.AbstractRule {
    public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {
        return this.applyWithWalker(new LiteralSpacingRuleWalker(sourceFile, this.getOptions()));
    }
}