This repository has been archived by the owner on Jul 13, 2020. It is now read-only.
/
eslint.ts
140 lines (123 loc) · 3.99 KB
/
eslint.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
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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
/*
* Copyright © 2019 Atomist, 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 {
isLocalProject,
logger,
NoParameters,
Project,
ProjectReview,
ReviewComment,
Severity,
SourceLocation,
} from "@atomist/automation-client";
import {
CodeInspection,
CodeInspectionRegistration,
spawnPromise,
} from "@atomist/sdm";
import * as _ from "lodash";
import * as path from "path";
import { PackageJson } from "../util/PackageJson";
export interface EslintMessage {
ruleId: string;
severity: number;
message: string;
line: number;
column: number;
}
export interface EslintResult {
filePath: string;
messages?: EslintMessage[];
}
export type EslintResults = EslintResult[];
export const esLintReviewCategory = "eslint";
function eslintReviewComment(
detail: string,
rule: string,
severity: Severity = "info",
sourceLocation?: SourceLocation,
): ReviewComment {
return {
category: esLintReviewCategory,
detail,
severity,
sourceLocation,
subcategory: rule,
};
}
export function mapEslintResultsToReviewComments(tslintOutput: string, dir: string): ReviewComment[] {
let results: EslintResults;
try {
results = JSON.parse(tslintOutput);
} catch (e) {
logger.error(`Failed to parse eslint output '${tslintOutput}': ${e.message}`);
return [];
}
const comments = results.filter(r => !!r.messages && r.messages.length > 0).map(r => {
return r.messages.map(m => {
const location: SourceLocation = {
path: r.filePath.replace(dir + path.sep, ""),
offset: undefined,
columnFrom1: m.column,
lineFrom1: m.line,
};
const severity = (m.severity === 1) ? "warn" : "error";
return eslintReviewComment(m.message, m.ruleId, severity, location);
});
});
return _.flatten(comments);
}
export const RunEslintOnProject: CodeInspection<ProjectReview, NoParameters> = async (p: Project) => {
const review: ProjectReview = { repoId: p.id, comments: [] };
if (!isLocalProject(p)) {
logger.error(`Project ${p.name} is not a local project`);
return review;
}
const cwd = p.baseDir;
const pj = await p.getFile("package.json");
const rawPj: PackageJson = JSON.parse(await pj.getContent()) as PackageJson;
let files: string[] = ["."];
if (!!rawPj.scripts && !!rawPj.scripts.lint) {
files = rawPj.scripts.lint.replace(/"/g, "").split(" ").slice(1);
}
const eslintArgs = [
...files,
"--format", "json",
];
// TODO does this work on windows?
const eslintExe = path.join(cwd, "node_modules", ".bin", "eslint");
try {
const eslintResult = await spawnPromise(eslintExe, eslintArgs, { cwd });
if (eslintResult.stderr) {
logger.debug(`eslint standard error from ${p.name}: ${eslintResult.stderr}`);
}
const comments = mapEslintResultsToReviewComments(eslintResult.stdout, p.baseDir);
review.comments.push(...comments);
} catch (e) {
logger.error(`Failed to run eslint: ${e.message}`);
}
return review;
};
/**
* Provide a code inspection that runs eslint and returns a
* ProjectReview.
*/
export const EslintInspection: CodeInspectionRegistration<ProjectReview, NoParameters> = {
name: "EslintInspection",
description: "Run eslint on project",
inspection: RunEslintOnProject,
intent: "eslint",
};