This repository has been archived by the owner on Jul 13, 2020. It is now read-only.
/
npmAuditAutofix.ts
94 lines (80 loc) · 2.5 KB
/
npmAuditAutofix.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
/*
* 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 {
GitProject,
isLocalProject,
logger,
} from "@atomist/automation-client";
import {
AutofixRegistration,
execPromise,
hasFile,
} from "@atomist/sdm";
import * as _ from "lodash";
import { DevelopmentEnvOptions } from "../build/npmBuilder";
const Package = "package.json";
export interface NpmAuditFixResult {
added: [];
removed: [];
updated: [];
moved: [];
}
/**
* Options to configure the npm audit support
*/
export interface NpmAuditOptions {
/** Only process the package lock file */
packageLockOnly?: boolean;
}
export const DefaultNpmAuditOptions = {
packageLockOnly: true,
};
/**
* Autofix to run npm audit fix on a project.
*/
export function npmAuditAutofix(options: NpmAuditOptions = DefaultNpmAuditOptions): AutofixRegistration {
return {
name: "npm audit",
pushTest: hasFile(Package),
transform: async p => {
if (!isLocalProject(p)) {
return p;
}
const cwd = p.baseDir;
try {
const args = ["audit", "fix", "--json"];
if (options.packageLockOnly === true) {
args.push("--package-lock-only");
}
const npmAuditResult = await execPromise(
"npm",
args,
{
cwd,
...DevelopmentEnvOptions,
});
const npmAudit = JSON.parse(npmAuditResult.stdout) as NpmAuditFixResult;
if (_.isEmpty(npmAudit.added) && _.isEmpty(npmAudit.moved)
&& _.isEmpty(npmAudit.removed) && _.isEmpty(npmAudit.updated)) {
await (p as GitProject).revert();
}
} catch (e) {
logger.warn(`Failed to run npm audit fix: ${e.message}`);
}
return p;
},
};
}