@atomist/sdm
Version:
Atomist Software Delivery Machine SDK
100 lines • 3.84 kB
JavaScript
;
/*
* Copyright © 2020 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.
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.EslintInspection = exports.RunEslintOnProject = exports.mapEslintResultsToReviewComments = exports.esLintReviewCategory = void 0;
const LocalProject_1 = require("@atomist/automation-client/lib/project/local/LocalProject");
const logger_1 = require("@atomist/automation-client/lib/util/logger");
const _ = require("lodash");
const path = require("path");
const child_process_1 = require("../../../api-helper/misc/child_process");
exports.esLintReviewCategory = "eslint";
function eslintReviewComment(detail, rule, severity = "info", sourceLocation) {
return {
category: exports.esLintReviewCategory,
detail,
severity,
sourceLocation,
subcategory: rule,
};
}
function mapEslintResultsToReviewComments(tslintOutput, dir) {
let results;
try {
results = JSON.parse(tslintOutput);
}
catch (e) {
logger_1.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 = {
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);
}
exports.mapEslintResultsToReviewComments = mapEslintResultsToReviewComments;
const RunEslintOnProject = async (p) => {
const review = { repoId: p.id, comments: [] };
if (!LocalProject_1.isLocalProject(p)) {
logger_1.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 = JSON.parse(await pj.getContent());
let files = ["."];
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 child_process_1.spawnPromise(eslintExe, eslintArgs, { cwd });
if (eslintResult.stderr) {
logger_1.logger.debug(`eslint standard error from ${p.name}: ${eslintResult.stderr}`);
}
const comments = mapEslintResultsToReviewComments(eslintResult.stdout, p.baseDir);
review.comments.push(...comments);
}
catch (e) {
logger_1.logger.error(`Failed to run eslint: ${e.message}`);
}
return review;
};
exports.RunEslintOnProject = RunEslintOnProject;
/**
* Provide a code inspection that runs eslint and returns a
* ProjectReview.
*/
exports.EslintInspection = {
name: "EslintInspection",
description: "Run eslint on project",
inspection: exports.RunEslintOnProject,
intent: "eslint",
};
//# sourceMappingURL=eslint.js.map