npm-update-package 0.37.0 → 0.40.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -0
- package/dist/package.json +2 -2
- package/dist/src/git/CommitMessageCreator.js +3 -1
- package/dist/src/github/createGitHub.js +2 -2
- package/dist/src/github/createOctokit.js +10 -8
- package/dist/src/github/pull-request/creator/PullRequestBodyCreator.js +13 -5
- package/dist/src/github/pull-request/creator/PullRequestTitleCreator.js +3 -1
- package/dist/src/github/releases/fetcher/ReleasesFetcher.js +0 -1
- package/dist/src/main.js +5 -2
- package/dist/src/ncu/Ncu.js +35 -7
- package/dist/src/package-json/DependencyType.js +12 -0
- package/dist/src/package-json/index.js +1 -0
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -27,6 +27,7 @@ Commit message template
|
|
|
27
27
|
- `newVersion`: new package version
|
|
28
28
|
- `packageName`: package name
|
|
29
29
|
- `level`: semver level (major/minor/patch)
|
|
30
|
+
- `dependencyType`: dependency type (dependencies/devDependencies/peerDependencies/optionalDependencies)
|
|
30
31
|
- default: `chore(deps): {{{level}}} update {{{packageName}}} to v{{{newVersion}}}`
|
|
31
32
|
|
|
32
33
|
### `--github-token`
|
|
@@ -74,6 +75,7 @@ Pull request title template
|
|
|
74
75
|
- `newVersion`: new package version
|
|
75
76
|
- `packageName`: package name
|
|
76
77
|
- `level`: semver level (major/minor/patch)
|
|
78
|
+
- `dependencyType`: dependency type (dependencies/devDependencies/peerDependencies/optionalDependencies)
|
|
77
79
|
- default: `chore(deps): {{{level}}} update {{{packageName}}} to v{{{newVersion}}}`
|
|
78
80
|
|
|
79
81
|
### `--reviewers`
|
package/dist/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "npm-update-package",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.40.0",
|
|
4
4
|
"description": "CLI tool for creating pull requests to update npm packages",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "tsc --project tsconfig.build.json",
|
|
@@ -36,7 +36,7 @@
|
|
|
36
36
|
"@types/parse-github-url": "1.0.0",
|
|
37
37
|
"@types/semver": "7.3.9",
|
|
38
38
|
"@typescript-eslint/eslint-plugin": "5.12.1",
|
|
39
|
-
"eslint": "8.
|
|
39
|
+
"eslint": "8.10.0",
|
|
40
40
|
"eslint-config-standard-with-typescript": "21.0.1",
|
|
41
41
|
"eslint-plugin-import": "2.25.4",
|
|
42
42
|
"eslint-plugin-jest": "26.1.1",
|
|
@@ -11,11 +11,13 @@ class CommitMessageCreator {
|
|
|
11
11
|
const currentVersion = outdatedPackage.currentVersion.version;
|
|
12
12
|
const newVersion = outdatedPackage.newVersion.version;
|
|
13
13
|
const level = outdatedPackage.level;
|
|
14
|
+
const dependencyType = outdatedPackage.dependencyType;
|
|
14
15
|
return (0, mustache_1.render)(this.template, {
|
|
15
16
|
packageName,
|
|
16
17
|
currentVersion,
|
|
17
18
|
newVersion,
|
|
18
|
-
level
|
|
19
|
+
level,
|
|
20
|
+
dependencyType
|
|
19
21
|
});
|
|
20
22
|
}
|
|
21
23
|
}
|
|
@@ -3,9 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
3
3
|
exports.createGitHub = void 0;
|
|
4
4
|
const createOctokit_1 = require("./createOctokit");
|
|
5
5
|
const GitHub_1 = require("./GitHub");
|
|
6
|
-
const createGitHub = ({
|
|
6
|
+
const createGitHub = ({ host, token }) => {
|
|
7
7
|
const octokit = (0, createOctokit_1.createOctokit)({
|
|
8
|
-
|
|
8
|
+
host,
|
|
9
9
|
token
|
|
10
10
|
});
|
|
11
11
|
return new GitHub_1.GitHub(octokit);
|
|
@@ -6,22 +6,24 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
6
6
|
exports.createOctokit = void 0;
|
|
7
7
|
const rest_1 = require("@octokit/rest");
|
|
8
8
|
const package_json_1 = __importDefault(require("../../package.json"));
|
|
9
|
-
const createOctokit = ({
|
|
10
|
-
const { host } = repository.url;
|
|
11
|
-
const auth = `token ${token}`;
|
|
9
|
+
const createOctokit = ({ host, token }) => {
|
|
12
10
|
const userAgent = `${package_json_1.default.name}/${package_json_1.default.version}`;
|
|
13
|
-
if (
|
|
11
|
+
if (token === undefined) {
|
|
14
12
|
return new rest_1.Octokit({
|
|
15
|
-
auth,
|
|
16
13
|
userAgent
|
|
17
14
|
});
|
|
18
15
|
}
|
|
19
|
-
|
|
16
|
+
const auth = `token ${token}`;
|
|
17
|
+
if (host === 'github.com') {
|
|
20
18
|
return new rest_1.Octokit({
|
|
21
19
|
auth,
|
|
22
|
-
userAgent
|
|
23
|
-
baseUrl: `https://${host}/api/v3`
|
|
20
|
+
userAgent
|
|
24
21
|
});
|
|
25
22
|
}
|
|
23
|
+
return new rest_1.Octokit({
|
|
24
|
+
auth,
|
|
25
|
+
userAgent,
|
|
26
|
+
baseUrl: `https://${host}/api/v3`
|
|
27
|
+
});
|
|
26
28
|
};
|
|
27
29
|
exports.createOctokit = createOctokit;
|
|
@@ -21,8 +21,7 @@ class PullRequestBodyCreator {
|
|
|
21
21
|
});
|
|
22
22
|
const metadataSection = this.createMetadataSection(outdatedPackage);
|
|
23
23
|
const footer = this.createFooter();
|
|
24
|
-
|
|
25
|
-
return `This PR updates these packages:
|
|
24
|
+
const body = `This PR updates these packages:
|
|
26
25
|
|
|
27
26
|
${outdatedPackagesTable}
|
|
28
27
|
|
|
@@ -31,11 +30,16 @@ ${metadataSection}
|
|
|
31
30
|
|
|
32
31
|
---
|
|
33
32
|
${footer}`;
|
|
33
|
+
if (gitRepo === undefined) {
|
|
34
|
+
return body;
|
|
34
35
|
}
|
|
35
36
|
const releaseNotesSection = await this.createReleaseNotesSection({
|
|
36
37
|
outdatedPackage,
|
|
37
38
|
gitRepo
|
|
38
39
|
});
|
|
40
|
+
if (releaseNotesSection === undefined) {
|
|
41
|
+
return body;
|
|
42
|
+
}
|
|
39
43
|
return `This PR updates these packages:
|
|
40
44
|
|
|
41
45
|
${outdatedPackagesTable}
|
|
@@ -59,6 +63,9 @@ ${footer}`;
|
|
|
59
63
|
from: outdatedPackage.currentVersion,
|
|
60
64
|
to: outdatedPackage.newVersion
|
|
61
65
|
});
|
|
66
|
+
if (releases.length === 0) {
|
|
67
|
+
return undefined;
|
|
68
|
+
}
|
|
62
69
|
const items = releases.map(release => `- [${release.tag_name}](${release.html_url})`);
|
|
63
70
|
return `## Release notes
|
|
64
71
|
|
|
@@ -68,6 +75,7 @@ ${items.join('\n')}`;
|
|
|
68
75
|
const packageName = outdatedPackage.name;
|
|
69
76
|
const packageLink = `[${packageName}](https://www.npmjs.com/package/${packageName})`;
|
|
70
77
|
const repositoryLink = gitRepo !== undefined ? `[${gitRepo.owner}/${gitRepo.name}](${gitRepo.url.toString()})` : '-';
|
|
78
|
+
const dependencyType = outdatedPackage.dependencyType;
|
|
71
79
|
const level = outdatedPackage.level;
|
|
72
80
|
const currentVersion = outdatedPackage.currentVersion.version;
|
|
73
81
|
const currentVersionLink = `[\`${currentVersion}\`](https://www.npmjs.com/package/${packageName}/v/${currentVersion})`;
|
|
@@ -75,9 +83,9 @@ ${items.join('\n')}`;
|
|
|
75
83
|
const newVersionLink = `[\`${newVersion}\`](https://www.npmjs.com/package/${packageName}/v/${newVersion})`;
|
|
76
84
|
const diffLink = `[diff](https://renovatebot.com/diffs/npm/${packageName}/${currentVersion}/${newVersion})`;
|
|
77
85
|
const version = `${currentVersionLink} -> ${newVersionLink} (${diffLink})`;
|
|
78
|
-
return `|Package|Repository|Level|Version|
|
|
79
|
-
|
|
80
|
-
|${packageLink}|${repositoryLink}|${level}|${version}|`;
|
|
86
|
+
return `|Package|Repository|Dependency type|Level|Version|
|
|
87
|
+
|---|---|---|---|---|
|
|
88
|
+
|${packageLink}|${repositoryLink}|${dependencyType}|${level}|${version}|`;
|
|
81
89
|
}
|
|
82
90
|
createMetadataSection(outdatedPackage) {
|
|
83
91
|
const metadata = (0, metadata_1.createPullRequestMetadata)([outdatedPackage]);
|
|
@@ -11,11 +11,13 @@ class PullRequestTitleCreator {
|
|
|
11
11
|
const currentVersion = outdatedPackage.currentVersion.version;
|
|
12
12
|
const newVersion = outdatedPackage.newVersion.version;
|
|
13
13
|
const level = outdatedPackage.level;
|
|
14
|
+
const dependencyType = outdatedPackage.dependencyType;
|
|
14
15
|
return (0, mustache_1.render)(this.template, {
|
|
15
16
|
packageName,
|
|
16
17
|
currentVersion,
|
|
17
18
|
newVersion,
|
|
18
|
-
level
|
|
19
|
+
level,
|
|
20
|
+
dependencyType
|
|
19
21
|
});
|
|
20
22
|
}
|
|
21
23
|
}
|
package/dist/src/main.js
CHANGED
|
@@ -27,7 +27,7 @@ const main = async ({ options, logger }) => {
|
|
|
27
27
|
const gitRepo = await git.getRepository();
|
|
28
28
|
logger.debug(`gitRepo=${JSON.stringify(gitRepo)}`);
|
|
29
29
|
const github = (0, github_1.createGitHub)({
|
|
30
|
-
|
|
30
|
+
host: gitRepo.url.host,
|
|
31
31
|
token: options.githubToken
|
|
32
32
|
});
|
|
33
33
|
const githubRepo = await github.fetchRepository({
|
|
@@ -61,7 +61,10 @@ const main = async ({ options, logger }) => {
|
|
|
61
61
|
packageManager: options.packageManager
|
|
62
62
|
});
|
|
63
63
|
const pullRequestTitleCreator = new github_1.PullRequestTitleCreator(options.pullRequestTitle);
|
|
64
|
-
const
|
|
64
|
+
const githubWithoutToken = (0, github_1.createGitHub)({
|
|
65
|
+
host: 'github.com'
|
|
66
|
+
});
|
|
67
|
+
const releasesFetcher = new github_1.ReleasesFetcher(githubWithoutToken);
|
|
65
68
|
const pullRequestBodyCreator = new github_1.PullRequestBodyCreator({
|
|
66
69
|
releasesFetcher
|
|
67
70
|
});
|
package/dist/src/ncu/Ncu.js
CHANGED
|
@@ -34,19 +34,46 @@ class Ncu {
|
|
|
34
34
|
if (!(0, NcuResult_1.isNcuResult)(result)) {
|
|
35
35
|
throw new Error('Failed to running ncu.');
|
|
36
36
|
}
|
|
37
|
-
const
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
37
|
+
const { dependencies, devDependencies, peerDependencies, optionalDependencies } = pkg;
|
|
38
|
+
const toCurrentVersionString = (packageName) => {
|
|
39
|
+
if ((dependencies === null || dependencies === void 0 ? void 0 : dependencies[packageName]) !== undefined) {
|
|
40
|
+
return dependencies[packageName];
|
|
41
|
+
}
|
|
42
|
+
else if ((devDependencies === null || devDependencies === void 0 ? void 0 : devDependencies[packageName]) !== undefined) {
|
|
43
|
+
return devDependencies[packageName];
|
|
44
|
+
}
|
|
45
|
+
else if ((peerDependencies === null || peerDependencies === void 0 ? void 0 : peerDependencies[packageName]) !== undefined) {
|
|
46
|
+
return peerDependencies[packageName];
|
|
47
|
+
}
|
|
48
|
+
else if ((optionalDependencies === null || optionalDependencies === void 0 ? void 0 : optionalDependencies[packageName]) !== undefined) {
|
|
49
|
+
return optionalDependencies[packageName];
|
|
50
|
+
}
|
|
51
|
+
};
|
|
52
|
+
const toDependencyType = (packageName) => {
|
|
53
|
+
if ((dependencies === null || dependencies === void 0 ? void 0 : dependencies[packageName]) !== undefined) {
|
|
54
|
+
return package_json_1.DependencyType.Dependencies;
|
|
55
|
+
}
|
|
56
|
+
else if ((devDependencies === null || devDependencies === void 0 ? void 0 : devDependencies[packageName]) !== undefined) {
|
|
57
|
+
return package_json_1.DependencyType.DevDependencies;
|
|
58
|
+
}
|
|
59
|
+
else if ((peerDependencies === null || peerDependencies === void 0 ? void 0 : peerDependencies[packageName]) !== undefined) {
|
|
60
|
+
return package_json_1.DependencyType.PeerDependencies;
|
|
61
|
+
}
|
|
62
|
+
else if ((optionalDependencies === null || optionalDependencies === void 0 ? void 0 : optionalDependencies[packageName]) !== undefined) {
|
|
63
|
+
return package_json_1.DependencyType.OptionalDependencies;
|
|
64
|
+
}
|
|
42
65
|
};
|
|
43
66
|
const resultEntries = Object.entries(result);
|
|
44
67
|
const outdatedPackages = resultEntries
|
|
45
68
|
.map(([name, newVersionString]) => {
|
|
46
|
-
const currentVersionString =
|
|
69
|
+
const currentVersionString = toCurrentVersionString(name);
|
|
47
70
|
if (currentVersionString === undefined) {
|
|
48
71
|
return undefined;
|
|
49
72
|
}
|
|
73
|
+
const dependencyType = toDependencyType(name);
|
|
74
|
+
if (dependencyType === undefined) {
|
|
75
|
+
return undefined;
|
|
76
|
+
}
|
|
50
77
|
const currentVersion = semver_1.SemVer.of(currentVersionString);
|
|
51
78
|
const newVersion = semver_1.SemVer.of(newVersionString);
|
|
52
79
|
const level = (0, semver_1.compareSemVers)(currentVersion, newVersion);
|
|
@@ -57,7 +84,8 @@ class Ncu {
|
|
|
57
84
|
name,
|
|
58
85
|
currentVersion,
|
|
59
86
|
newVersion,
|
|
60
|
-
level
|
|
87
|
+
level,
|
|
88
|
+
dependencyType
|
|
61
89
|
};
|
|
62
90
|
return outdatedPackage;
|
|
63
91
|
})
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.isDependencyType = exports.DependencyType = void 0;
|
|
4
|
+
exports.DependencyType = {
|
|
5
|
+
Dependencies: 'dependencies',
|
|
6
|
+
DevDependencies: 'devDependencies',
|
|
7
|
+
PeerDependencies: 'peerDependencies',
|
|
8
|
+
OptionalDependencies: 'optionalDependencies'
|
|
9
|
+
};
|
|
10
|
+
const dependencyTypes = Object.values(exports.DependencyType);
|
|
11
|
+
const isDependencyType = (value) => dependencyTypes.includes(value);
|
|
12
|
+
exports.isDependencyType = isDependencyType;
|
|
@@ -10,6 +10,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
10
10
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
11
11
|
};
|
|
12
12
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
13
|
+
__exportStar(require("./DependencyType"), exports);
|
|
13
14
|
__exportStar(require("./extractRepository"), exports);
|
|
14
15
|
__exportStar(require("./PackageMetadata"), exports);
|
|
15
16
|
__exportStar(require("./parsePackageJson"), exports);
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "npm-update-package",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.40.0",
|
|
4
4
|
"description": "CLI tool for creating pull requests to update npm packages",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "tsc --project tsconfig.build.json",
|
|
@@ -36,7 +36,7 @@
|
|
|
36
36
|
"@types/parse-github-url": "1.0.0",
|
|
37
37
|
"@types/semver": "7.3.9",
|
|
38
38
|
"@typescript-eslint/eslint-plugin": "5.12.1",
|
|
39
|
-
"eslint": "8.
|
|
39
|
+
"eslint": "8.10.0",
|
|
40
40
|
"eslint-config-standard-with-typescript": "21.0.1",
|
|
41
41
|
"eslint-plugin-import": "2.25.4",
|
|
42
42
|
"eslint-plugin-jest": "26.1.1",
|