npm-update-package 0.19.1 → 0.21.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 CHANGED
@@ -73,33 +73,6 @@ Package manager of your project
73
73
  - required: false
74
74
  - default: `npm`
75
75
 
76
- ### `--pull-request-body`
77
-
78
- Pull request body template
79
-
80
- - type: string
81
- - variables:
82
- - `appName`
83
- - `appVersion`
84
- - `appWeb`
85
- - `currentVersion`
86
- - `newVersion`
87
- - `packageName`
88
- - `updateType`
89
- - required: false
90
- - default:
91
-
92
- ```
93
- This PR updates these packages:
94
-
95
- |package|type|current version|new version|
96
- |---|---|---|---|
97
- |[{{{packageName}}}](https://www.npmjs.com/package/{{{packageName}}})|{{updateType}}|\`{{currentVersion}}\`|\`{{newVersion}}\`|
98
-
99
- ---
100
- This PR has been generated by [{{{appName}}}]({{{appWeb}}}) v{{appVersion}}
101
- ```
102
-
103
76
  ### `--pull-request-labels`
104
77
 
105
78
  Pull request labels
@@ -153,8 +126,6 @@ Actual working examples can be seen in these repositories.
153
126
 
154
127
  The following shows the process flow of npm-update-package:
155
128
 
156
- [![](http://www.plantuml.com/plantuml/svg/RKyxKiCm5EpVARPqYbmWRi9Gq4666GuWx4tiGPQ4z0JXzaIn70D38wsUzkrddzH4pPELAv1Jz3bWCgEJtGCLFcjlb3s2wTxCYQaL6OzexgozZM0YaSDM_RPmDz213iqNqqO0kbve4z4ulv7BQpnAjNcgueSgT8Y-Oqe-IcIWKG7-9Quye8HvvkILU8t6TGDu7fEcFodM102mkuyqjursdhs4uh6qQdyHGxOMaU-PIUjFCVtuAN6jDjzpxDe2dyDeYUQHPrtKbv2oabTOaEmlHvxiDm00)](http://www.plantuml.com/plantuml/uml/RKyxKiCm5EpVARPqYbmWRi9Gq4666GuWx4tiGPQ4z0JXzaIn70D38wsUzkrddzH4pPELAv1Jz3bWCgEJtGCLFcjlb3s2wTxCYQaL6OzexgozZM0YaSDM_RPmDz213iqNqqO0kbve4z4ulv7BQpnAjNcgueSgT8Y-Oqe-IcIWKG7-9Quye8HvvkILU8t6TGDu7fEcFodM102mkuyqjursdhs4uh6qQdyHGxOMaU-PIUjFCVtuAN6jDjzpxDe2dyDeYUQHPrtKbv2oabTOaEmlHvxiDm00)
157
-
158
129
  <!--
159
130
  ```plantuml
160
131
  @startuml
@@ -187,6 +158,8 @@ end
187
158
  ```
188
159
  -->
189
160
 
161
+ [![](http://www.plantuml.com/plantuml/svg/RKyxKiCm5EpVARPqYbmWRi9Gq4666GuWx4tiGPQ4z0JXzaIn70D38wsUzkrddzH4pPELAv1Jz3bWCgEJtGCLFcjlb3s2wTxCYQaL6OzexgozZM0YaSDM_RPmDz213iqNqqO0kbve4z4ulv7BQpnAjNcgueSgT8Y-Oqe-IcIWKG7-9Quye8HvvkILU8t6TGDu7fEcFodM102mkuyqjursdhs4uh6qQdyHGxOMaU-PIUjFCVtuAN6jDjzpxDe2dyDeYUQHPrtKbv2oabTOaEmlHvxiDm00)](http://www.plantuml.com/plantuml/uml/RKyxKiCm5EpVARPqYbmWRi9Gq4666GuWx4tiGPQ4z0JXzaIn70D38wsUzkrddzH4pPELAv1Jz3bWCgEJtGCLFcjlb3s2wTxCYQaL6OzexgozZM0YaSDM_RPmDz213iqNqqO0kbve4z4ulv7BQpnAjNcgueSgT8Y-Oqe-IcIWKG7-9Quye8HvvkILU8t6TGDu7fEcFodM102mkuyqjursdhs4uh6qQdyHGxOMaU-PIUjFCVtuAN6jDjzpxDe2dyDeYUQHPrtKbv2oabTOaEmlHvxiDm00)
162
+
190
163
  ## FAQ
191
164
 
192
165
  ### What is the purpose of npm-update-package?
package/dist/app.js CHANGED
@@ -3,6 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.app = void 0;
4
4
  exports.app = {
5
5
  name: 'npm-update-package',
6
- version: '0.19.0',
6
+ version: '0.21.0',
7
7
  web: 'https://github.com/npm-update-package/npm-update-package'
8
8
  };
@@ -4,8 +4,15 @@ exports.PullRequestBodyCreator = void 0;
4
4
  const mustache_1 = require("mustache");
5
5
  const app_1 = require("../app");
6
6
  class PullRequestBodyCreator {
7
- constructor(template) {
8
- this.template = template;
7
+ constructor() {
8
+ this.template = `This PR updates these packages:
9
+
10
+ |package|type|current version|new version|
11
+ |---|---|---|---|
12
+ |[{{{packageName}}}](https://www.npmjs.com/package/{{{packageName}}})|{{updateType}}|\`{{currentVersion}}\`|\`{{newVersion}}\`|
13
+
14
+ ---
15
+ This PR has been generated by [{{{appName}}}]({{{appWeb}}}) v{{appVersion}}`;
9
16
  }
10
17
  create(outdatedPackage) {
11
18
  const appName = app_1.app.name;
package/dist/main.js CHANGED
@@ -6,6 +6,7 @@ const git_1 = require("./git");
6
6
  const github_1 = require("./github");
7
7
  const ncu_1 = require("./ncu");
8
8
  const package_json_1 = require("./package-json");
9
+ const PackageJsonReader_1 = require("./package-json/PackageJsonReader");
9
10
  const package_manager_1 = require("./package-manager");
10
11
  const processors_1 = require("./processors");
11
12
  const terminal_1 = require("./terminal");
@@ -16,7 +17,14 @@ const main = async ({ options, logger }) => {
16
17
  githubToken: options.githubToken !== '' ? '***' : ''
17
18
  })}`);
18
19
  const packageJsonParser = new package_json_1.PackageJsonParser(logger);
19
- const ncu = new ncu_1.Ncu(packageJsonParser);
20
+ const packageJsonReader = new PackageJsonReader_1.PackageJsonReader({
21
+ packageJsonParser,
22
+ logger
23
+ });
24
+ const ncu = new ncu_1.Ncu({
25
+ packageJsonReader,
26
+ logger
27
+ });
20
28
  const outdatedPackages = await ncu.check();
21
29
  logger.debug(`outdatedPackages=${JSON.stringify(outdatedPackages)}`);
22
30
  if (outdatedPackages.length === 0) {
@@ -48,7 +56,7 @@ const main = async ({ options, logger }) => {
48
56
  packageManager: options.packageManager
49
57
  });
50
58
  const pullRequestTitleCreator = new github_1.PullRequestTitleCreator(options.pullRequestTitle);
51
- const pullRequestBodyCreator = new github_1.PullRequestBodyCreator(options.pullRequestBody);
59
+ const pullRequestBodyCreator = new github_1.PullRequestBodyCreator();
52
60
  const pullRequestCreator = new github_1.PullRequestCreator({
53
61
  github,
54
62
  gitRepo,
package/dist/ncu/Ncu.js CHANGED
@@ -2,13 +2,13 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.Ncu = void 0;
4
4
  const npm_check_updates_1 = require("npm-check-updates");
5
- const file_1 = require("../file");
6
5
  const NcuResult_1 = require("./NcuResult");
7
6
  const NcuResultConverter_1 = require("./NcuResultConverter");
8
7
  // TODO: add test
9
8
  class Ncu {
10
- constructor(packageJsonParser) {
11
- this.packageJsonParser = packageJsonParser;
9
+ constructor({ packageJsonReader, logger }) {
10
+ this.packageJsonReader = packageJsonReader;
11
+ this.logger = logger;
12
12
  }
13
13
  async check() {
14
14
  return await this.run({
@@ -23,19 +23,19 @@ class Ncu {
23
23
  });
24
24
  }
25
25
  async run(options) {
26
- const packageJson = await (0, file_1.readFile)('./package.json');
27
- const pkg = this.packageJsonParser.parse(packageJson);
28
- const currentDependencies = {
29
- ...pkg.dependencies,
30
- ...pkg.devDependencies,
31
- ...pkg.peerDependencies,
32
- ...pkg.optionalDependencies
33
- };
26
+ const pkg = await this.packageJsonReader.read();
27
+ this.logger.debug(`pkg=${JSON.stringify(pkg)}`);
34
28
  const result = await (0, npm_check_updates_1.run)(options);
29
+ this.logger.debug(`result=${JSON.stringify(result)}`);
35
30
  if (!(0, NcuResult_1.isNcuResult)(result)) {
36
31
  throw new Error('result is not NcuResult');
37
32
  }
38
- const ncuResultConverter = new NcuResultConverter_1.NcuResultConverter(currentDependencies);
33
+ const ncuResultConverter = new NcuResultConverter_1.NcuResultConverter({
34
+ ...pkg.dependencies,
35
+ ...pkg.devDependencies,
36
+ ...pkg.peerDependencies,
37
+ ...pkg.optionalDependencies
38
+ });
39
39
  return ncuResultConverter.toOutdatedPackages(result);
40
40
  }
41
41
  }
@@ -11,7 +11,6 @@ const Options = (0, io_ts_1.intersection)([
11
11
  githubToken: io_ts_1.string,
12
12
  logLevel: (0, io_ts_1.union)([(0, io_ts_1.literal)(logger_1.LogLevel.Off), (0, io_ts_1.literal)(logger_1.LogLevel.Error), (0, io_ts_1.literal)(logger_1.LogLevel.Info), (0, io_ts_1.literal)(logger_1.LogLevel.Debug)]),
13
13
  packageManager: (0, io_ts_1.union)([(0, io_ts_1.literal)(package_manager_1.PackageManagerName.Npm), (0, io_ts_1.literal)(package_manager_1.PackageManagerName.Yarn)]),
14
- pullRequestBody: io_ts_1.string,
15
14
  pullRequestTitle: io_ts_1.string
16
15
  }),
17
16
  (0, io_ts_1.partial)({
@@ -49,20 +49,6 @@ exports.cliOptions = [
49
49
  ],
50
50
  default: package_manager_1.PackageManagerName.Npm
51
51
  },
52
- {
53
- name: 'pull-request-body',
54
- description: 'Pull request body template',
55
- type: OptionType_1.OptionType.String,
56
- required: false,
57
- default: `This PR updates these packages:
58
-
59
- |package|type|current version|new version|
60
- |---|---|---|---|
61
- |[{{{packageName}}}](https://www.npmjs.com/package/{{{packageName}}})|{{updateType}}|\`{{currentVersion}}\`|\`{{newVersion}}\`|
62
-
63
- ---
64
- This PR has been generated by [{{{appName}}}]({{{appWeb}}}) v{{appVersion}}`
65
- },
66
52
  {
67
53
  name: 'pull-request-labels',
68
54
  description: 'Pull request labels',
@@ -0,0 +1,20 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.PackageJsonReader = void 0;
7
+ const fs_1 = __importDefault(require("fs"));
8
+ // TODO: add test
9
+ class PackageJsonReader {
10
+ constructor({ packageJsonParser, logger }) {
11
+ this.packageJsonParser = packageJsonParser;
12
+ this.logger = logger;
13
+ }
14
+ async read() {
15
+ const json = await fs_1.default.promises.readFile('./package.json', 'utf8');
16
+ this.logger.debug(`json=${json}`);
17
+ return this.packageJsonParser.parse(json);
18
+ }
19
+ }
20
+ exports.PackageJsonReader = PackageJsonReader;
@@ -1,5 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.PackageJsonParser = void 0;
3
+ exports.PackageJsonReader = exports.PackageJsonParser = void 0;
4
4
  var PackageJsonParser_1 = require("./PackageJsonParser");
5
5
  Object.defineProperty(exports, "PackageJsonParser", { enumerable: true, get: function () { return PackageJsonParser_1.PackageJsonParser; } });
6
+ var PackageJsonReader_1 = require("./PackageJsonReader");
7
+ Object.defineProperty(exports, "PackageJsonReader", { enumerable: true, get: function () { return PackageJsonReader_1.PackageJsonReader; } });
@@ -2,13 +2,13 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.createPackageManager = void 0;
4
4
  const Npm_1 = require("./Npm");
5
+ const PackageManagerName_1 = require("./PackageManagerName");
5
6
  const Yarn_1 = require("./Yarn");
6
- // TODO: add test
7
7
  const createPackageManager = ({ terminal, packageManager }) => {
8
8
  switch (packageManager) {
9
- case 'npm':
9
+ case PackageManagerName_1.PackageManagerName.Npm:
10
10
  return new Npm_1.Npm(terminal);
11
- case 'yarn':
11
+ case PackageManagerName_1.PackageManagerName.Yarn:
12
12
  return new Yarn_1.Yarn(terminal);
13
13
  }
14
14
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "npm-update-package",
3
- "version": "0.19.1",
3
+ "version": "0.21.0",
4
4
  "description": "CLI tool for creating pull request to update npm packages",
5
5
  "scripts": {
6
6
  "build": "tsc --project tsconfig.build.json",
@@ -20,34 +20,34 @@
20
20
  "@octokit/rest": "18.12.0",
21
21
  "commander": "8.3.0",
22
22
  "execa": "5.1.1",
23
- "fp-ts": "2.11.5",
23
+ "fp-ts": "2.11.6",
24
24
  "io-ts": "2.2.16",
25
25
  "log4js": "6.3.0",
26
26
  "mustache": "4.1.0",
27
- "npm-check-updates": "12.0.5",
27
+ "npm-check-updates": "12.1.0",
28
28
  "parse-github-url": "1.0.2",
29
29
  "semver": "7.3.5",
30
30
  "type-guards": "0.15.0"
31
31
  },
32
32
  "devDependencies": {
33
- "@jest/types": "27.0.6",
34
- "@tsconfig/node16": "1.0.2",
35
- "@types/jest": "27.0.3",
33
+ "@jest/types": "27.4.2",
34
+ "@tsconfig/node12": "1.0.9",
35
+ "@types/jest": "27.4.0",
36
36
  "@types/mustache": "4.1.2",
37
- "@types/node": "16.11.17",
37
+ "@types/node": "12.20.40",
38
38
  "@types/parse-github-url": "1.0.0",
39
39
  "@types/semver": "7.3.9",
40
- "@typescript-eslint/eslint-plugin": "5.8.1",
41
- "eslint": "8.5.0",
40
+ "@typescript-eslint/eslint-plugin": "5.9.0",
41
+ "eslint": "8.6.0",
42
42
  "eslint-config-standard-with-typescript": "21.0.1",
43
- "eslint-plugin-import": "2.25.3",
44
- "eslint-plugin-jest": "25.3.2",
43
+ "eslint-plugin-import": "2.25.4",
44
+ "eslint-plugin-jest": "25.3.4",
45
45
  "eslint-plugin-node": "11.1.0",
46
46
  "eslint-plugin-promise": "6.0.0",
47
47
  "eslint-plugin-tsdoc": "0.2.14",
48
48
  "husky": "7.0.4",
49
- "jest": "27.0.6",
50
- "lint-staged": "12.1.4",
49
+ "jest": "27.4.6",
50
+ "lint-staged": "12.1.5",
51
51
  "npm-run-all": "4.1.5",
52
52
  "rimraf": "3.0.2",
53
53
  "ts-jest": "27.1.2",
@@ -1,5 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.readFile = void 0;
4
- var readFile_1 = require("./readFile");
5
- Object.defineProperty(exports, "readFile", { enumerable: true, get: function () { return readFile_1.readFile; } });
@@ -1,10 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.readFile = void 0;
4
- const promises_1 = require("fs/promises");
5
- // TODO: add test
6
- const readFile = async (path) => {
7
- const data = await (0, promises_1.readFile)(path, 'utf8');
8
- return data;
9
- };
10
- exports.readFile = readFile;