UNPKG

tslint-immutable

Version:

TSLint rules to disable mutation in TypeScript.

387 lines (386 loc) 11.5 kB
<!doctype html> <html lang="en"> <head> <title>Code coverage report for noLetRule.ts</title> <meta charset="utf-8" /> <link rel="stylesheet" href="prettify.css" /> <link rel="stylesheet" href="base.css" /> <meta name="viewport" content="width=device-width, initial-scale=1"> <style type='text/css'> .coverage-summary .sorter { background-image: url(sort-arrow-sprite.png); } </style> </head> <body> <div class='wrapper'> <div class='pad1'> <h1> <a href="index.html">All files</a> noLetRule.ts </h1> <div class='clearfix'> <div class='fl pad1y space-right2'> <span class="strong">100% </span> <span class="quiet">Statements</span> <span class='fraction'>28/28</span> </div> <div class='fl pad1y space-right2'> <span class="strong">94.44% </span> <span class="quiet">Branches</span> <span class='fraction'>17/18</span> </div> <div class='fl pad1y space-right2'> <span class="strong">100% </span> <span class="quiet">Functions</span> <span class='fraction'>4/4</span> </div> <div class='fl pad1y space-right2'> <span class="strong">100% </span> <span class="quiet">Lines</span> <span class='fraction'>27/27</span> </div> </div> </div> <div class='status-line high'></div> <pre><table class="coverage"> <tr><td class="line-count quiet">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108</td><td class="line-coverage quiet"><span class="cline-any cline-yes">1x</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">343x</span> <span class="cline-any cline-yes">343x</span> <span class="cline-any cline-yes">343x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">343x</span> <span class="cline-any cline-yes">29x</span> <span class="cline-any cline-yes">29x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">314x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">343x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">17x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">17x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">17x</span> <span class="cline-any cline-yes">17x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">326x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">46x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">43x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">43x</span> <span class="cline-any cline-yes">48x</span> <span class="cline-any cline-yes">48x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">34x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">34x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">43x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">3x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">import * as ts from "typescript"; import * as Lint from "tslint"; import * as Ignore from "./shared/ignore"; import { InvalidNode, createInvalidNode, CheckNodeResult, createCheckNodeRule } from "./shared/check-node"; &nbsp; type Options = Ignore.IgnoreLocalOption &amp; Ignore.IgnorePrefixOption; &nbsp; // tslint:disable-next-line:variable-name export const Rule = createCheckNodeRule( Ignore.checkNodeWithIgnore(checkNode), "Unexpected let, use const instead." ); &nbsp; function checkNode( node: ts.Node, ctx: Lint.WalkContext&lt;Options&gt; ): CheckNodeResult { const variableStatementFailures = chectVariableStatement(node, ctx); const forStatementsFailures = checkForStatements(node, ctx); return { invalidNodes: [...variableStatementFailures, ...forStatementsFailures] }; } &nbsp; function chectVariableStatement( node: ts.Node, ctx: Lint.WalkContext&lt;Options&gt; ): ReadonlyArray&lt;InvalidNode&gt; { if (node.kind === ts.SyntaxKind.VariableStatement) { const variableStatementNode: ts.VariableStatement = node as ts.VariableStatement; return checkDeclarationList(variableStatementNode.declarationList, ctx); } return []; } &nbsp; function checkForStatements( node: ts.Node, ctx: Lint.WalkContext&lt;Options&gt; ): ReadonlyArray&lt;InvalidNode&gt; { if ( node.kind === ts.SyntaxKind.ForStatement || node.kind === ts.SyntaxKind.ForInStatement || node.kind === ts.SyntaxKind.ForOfStatement ) { const forStatmentNode = node as | ts.ForStatement | ts.ForInStatement | ts.ForOfStatement; <span class="missing-if-branch" title="else path not taken" >E</span>if ( forStatmentNode.initializer &amp;&amp; forStatmentNode.initializer.kind === ts.SyntaxKind.VariableDeclarationList &amp;&amp; Lint.isNodeFlagSet(forStatmentNode.initializer, ts.NodeFlags.Let) ) { const declarationList = forStatmentNode.initializer as ts.VariableDeclarationList; return checkDeclarationList(declarationList, ctx); } } return []; } &nbsp; function checkDeclarationList( declarationList: ts.VariableDeclarationList, ctx: Lint.WalkContext&lt;Options&gt; ): ReadonlyArray&lt;InvalidNode&gt; { if (Lint.isNodeFlagSet(declarationList, ts.NodeFlags.Let)) { // It is a let declaration, now check each variable that is declared const invalidVariableDeclarationNodes = []; // If the declaration list contains multiple variables, eg. let x = 0, y = 1, mutableZ = 3; then // we should only provide one fix for the list even if two variables are invalid. // NOTE: When we have a mix of allowed and disallowed variables in the same DeclarationList // there is no sure way to know if we should do a fix or not, eg. if ignore-prefix=mutable // and the list is "let x, mutableZ", then "x" is invalid but "mutableZ" is valid, should we change // "let" to "const" or not? For now we change to const if at least one variable is invalid. let addFix = true; for (const variableDeclarationNode of declarationList.declarations) { if ( !Ignore.shouldIgnorePrefix( variableDeclarationNode, ctx.options, ctx.sourceFile ) ) { invalidVariableDeclarationNodes.push( createInvalidNode( variableDeclarationNode, addFix ? new Lint.Replacement( declarationList.getStart(ctx.sourceFile), "let".length, "const" ) : undefined ) ); addFix = false; } } return invalidVariableDeclarationNodes; } return []; } &nbsp;</pre></td></tr> </table></pre> <div class='push'></div><!-- for sticky footer --> </div><!-- /wrapper --> <div class='footer quiet pad2 space-top1 center small'> Code coverage generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Tue Jan 16 2018 21:59:42 GMT+0100 (CET) </div> </div> <script src="prettify.js"></script> <script> window.onload = function () { if (typeof prettyPrint === 'function') { prettyPrint(); } }; </script> <script src="sorter.js"></script> </body> </html>