build: add linting rule for single new line at eof

hansl · hansl · commit 476fa6311865 · 2018-06-05T17:55:14.000-07:00
and fix the lint errors.
diff --git a/packages/angular_devkit/build_optimizer/src/purify/webpack-plugin.ts b/packages/angular_devkit/build_optimizer/src/purify/webpack-plugin.ts
@@ -33,4 +33,3 @@ export class PurifyPlugin {
     });
   }
 }
-
diff --git a/packages/angular_devkit/build_optimizer/src/transforms/scrub-file_spec.ts b/packages/angular_devkit/build_optimizer/src/transforms/scrub-file_spec.ts
@@ -203,4 +203,3 @@ describe('scrub-file', () => {
     });
   });
 });
-
diff --git a/packages/angular_devkit/schematics/src/rules/call.ts b/packages/angular_devkit/schematics/src/rules/call.ts
@@ -68,4 +68,3 @@ export function callRule(rule: Rule,
     }
   });
 }
-
diff --git a/packages/angular_devkit/schematics/src/sink/dryrun.ts b/packages/angular_devkit/schematics/src/sink/dryrun.ts
@@ -114,4 +114,3 @@ export class DryRunSink extends FileSystemSink {
     return Observable.empty<void>();
   }
 }
-
diff --git a/packages/angular_devkit/schematics/src/tree/action_spec.ts b/packages/angular_devkit/schematics/src/tree/action_spec.ts
@@ -77,4 +77,3 @@ describe('Action', () => {
     });
   });
 });
-
diff --git a/packages/angular_devkit/schematics/tools/description.ts b/packages/angular_devkit/schematics/tools/description.ts
@@ -49,4 +49,3 @@ export declare type FileSystemSchematicDesc
   = SchematicDescription<FileSystemCollectionDescription, FileSystemSchematicDescription>;
 export declare type FileSystemSchematicContext
   = TypedSchematicContext<FileSystemCollectionDescription, FileSystemSchematicDescription>;
-
diff --git a/packages/angular_devkit/schematics/tools/registry-engine-host.ts b/packages/angular_devkit/schematics/tools/registry-engine-host.ts
@@ -118,4 +118,3 @@ export class RegistryEngineHost extends FileSystemEngineHostBase {
     return desc as FileSystemSchematicDesc;
   }
 }
-
diff --git a/packages/schematics/angular/utility/ast-utils.ts b/packages/schematics/angular/utility/ast-utils.ts
@@ -399,4 +399,3 @@ export function addBootstrapToModule(source: ts.SourceFile,
                                      importPath: string): Change[] {
   return _addSymbolToNgModuleMetadata(source, modulePath, 'bootstrap', classifiedName, importPath);
 }
-
diff --git a/packages/schematics/angular/utility/route-utils.ts b/packages/schematics/angular/utility/route-utils.ts
@@ -87,4 +87,3 @@ export function insertImport(source: ts.SourceFile, fileToEdit: string, symbolNa
     ts.SyntaxKind.StringLiteral,
   );
 }
-
diff --git a/rules/singleEofLineRule.ts b/rules/singleEofLineRule.ts
@@ -0,0 +1,59 @@
+/**
+ * @license
+ * Copyright Google Inc. All Rights Reserved.
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://angular.io/license
+ */
+import * as Lint from 'tslint';
+import * as ts from 'typescript';
+
+
+export class Rule extends Lint.Rules.AbstractRule {
+  public static metadata: Lint.IRuleMetadata = {
+    ruleName: 'single-eof-line',
+    type: 'style',
+    description: `Ensure the file ends with a single new line.`,
+    rationale: `This is similar to eofline, but ensure an exact count instead of just any new
+                line.`,
+    options: null,
+    optionsDescription: `Two integers indicating minimum and maximum number of new lines.`,
+    typescriptOnly: false,
+  };
+
+  public static FAILURE_STRING = 'You need to have a single blank line at end of file.';
+
+  public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {
+    const length = sourceFile.text.length;
+    if (length === 0) {
+      // Allow empty files.
+      return [];
+    }
+
+    const matchEof = /\r?\n((\r?\n)*)$/.exec(sourceFile.text);
+    if (!matchEof) {
+      const lines = sourceFile.getLineStarts();
+      const fix = Lint.Replacement.appendText(
+        length,
+        sourceFile.text[lines[1] - 2] === '\r' ? '\r\n' : '\n',
+      );
+
+      return [
+        new Lint.RuleFailure(sourceFile, length, length, Rule.FAILURE_STRING, this.ruleName, fix),
+      ];
+    } else if (matchEof[1]) {
+      const lines = sourceFile.getLineStarts();
+      const fix = Lint.Replacement.replaceFromTo(
+        matchEof.index,
+        length,
+        sourceFile.text[lines[1] - 2] === '\r' ? '\r\n' : '\n',
+      );
+
+      return [
+        new Lint.RuleFailure(sourceFile, length, length, Rule.FAILURE_STRING, this.ruleName, fix),
+      ];
+    }
+
+    return [];
+  }
+}
diff --git a/tslint.json b/tslint.json
@@ -6,6 +6,8 @@
     "import-groups": true,
     "non-null-operator": true,
     "no-global-tslint-disable": true,
+    "single-eof-line": true,
+
 
     "import-blacklist": [
       true,

Original file line number	Diff line number	Diff line change
`@@ -33,4 +33,3 @@ export class PurifyPlugin {`
`33`	`33`	`});`
`34`	`34`	`}`
`35`	`35`	`}`
`36`		`-`
-Original file line number
+Diff line change
     });
   });
 });
+-
Original file line number	Diff line number	Diff line change
`@@ -68,4 +68,3 @@ export function callRule(rule: Rule,`
`68`	`68`	`}`
`69`	`69`	`});`
`70`	`70`	`}`
`71`		`-`
Original file line number	Diff line number	Diff line change
`@@ -114,4 +114,3 @@ export class DryRunSink extends FileSystemSink {`
`114`	`114`	`return Observable.empty<void>();`
`115`	`115`	`}`
`116`	`116`	`}`
`117`		`-`
Original file line number	Diff line number	Diff line change
`@@ -118,4 +118,3 @@ export class RegistryEngineHost extends FileSystemEngineHostBase {`
`118`	`118`	`return desc as FileSystemSchematicDesc;`
`119`	`119`	`}`
`120`	`120`	`}`
`121`		`-`
Original file line number	Diff line number	Diff line change
`@@ -399,4 +399,3 @@ export function addBootstrapToModule(source: ts.SourceFile,`
`399`	`399`	`importPath: string): Change[] {`
`400`	`400`	`return _addSymbolToNgModuleMetadata(source, modulePath, 'bootstrap', classifiedName, importPath);`
`401`	`401`	`}`
`402`		`-`
Original file line number	Diff line number	Diff line change
`@@ -87,4 +87,3 @@ export function insertImport(source: ts.SourceFile, fileToEdit: string, symbolNa`
`87`	`87`	`ts.SyntaxKind.StringLiteral,`
`88`	`88`	`);`
`89`	`89`	`}`
`90`		`-`