This repository has been archived by the owner on Mar 25, 2021. It is now read-only.
/
eoflineRule.ts
69 lines (63 loc) · 2.27 KB
/
eoflineRule.ts
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
/**
* @license
* Copyright 2013 Palantir Technologies, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import * as ts from "typescript";
import * as Lint from "../index";
export class Rule extends Lint.Rules.AbstractRule {
/* tslint:disable:object-literal-sort-keys */
public static metadata: Lint.IRuleMetadata = {
ruleName: "eofline",
description: "Ensures the file ends with a newline.",
descriptionDetails: "Fix for single-line files is not supported.",
rationale:
"It is a [standard convention](https://stackoverflow.com/q/729692/3124288) to end files with a newline.",
optionsDescription: "Not configurable.",
options: null,
optionExamples: [true],
hasFix: true,
type: "formatting",
typescriptOnly: false,
};
/* tslint:enable:object-literal-sort-keys */
public static FAILURE_STRING = "file should end with a newline";
public apply(sourceFile: ts.SourceFile): Lint.RuleFailure[] {
const length = sourceFile.text.length;
if (
length === 0 || // if the file is empty, it "ends with a newline", so don't return a failure
sourceFile.text[length - 1] === "\n"
) {
return [];
}
let fix: Lint.Fix | undefined;
const lines = sourceFile.getLineStarts();
if (lines.length > 1) {
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,
),
];
}
}