npm-update-package 0.14.0 → 0.16.2

package/README.md

@@ -5,10 +5,6 @@
 
 CLI tool for creating pull request to update npm packages
 
-## Caution
-
-This package is currently under development, so the major version is 0 yet.
-
 ## Usage
 
 ```sh
@@ -53,7 +49,7 @@ Template strings such as `--branch-name` can embed variables like `{{packageName
 
 Branch name template
 
-- value: template string
+- type: string
 - variables:
   - `currentVersion`
   - `newVersion`
@@ -66,7 +62,7 @@ Branch name template
 
 Commit message template
 
-- value: template string
+- type: string
 - variables:
   - `currentVersion`
   - `newVersion`
@@ -79,17 +75,19 @@ Commit message template
 
 GitHub token
 
-- value: string
+- type: string
 - required: true
 
 ### `--log-level`
 
 Log level to show
 
-- value: string
-  - `error`
-  - `info`
-  - `debug`
+- type: string
+- allowed values:
+  - `off`: Do not output any logs.
+  - `error`: Output error logs.
+  - `info`: Output error/info logs.
+  - `debug`: Output error/info/debug logs.
 - required: false
 - default: `info`
 
@@ -97,7 +95,8 @@ Log level to show
 
 Package manager of your project
 
-- value: string
+- type: string
+- allowed values:
   - `npm`
   - `yarn`
 - required: false
@@ -107,7 +106,7 @@ Package manager of your project
 
 Pull request body template
 
-- value: template string
+- type: string
 - variables:
   - `appName`
   - `appVersion`
@@ -134,7 +133,7 @@ This PR has been generated by [{{{appName}}}]({{{appWeb}}}) v{{appVersion}}
 
 Pull request title template
 
-- value: template string
+- type: string
 - variables:
   - `currentVersion`
   - `newVersion`
@@ -142,3 +141,9 @@ Pull request title template
   - `updateType`
 - required: false
 - default: `chore(deps): {{updateType}} update {{{packageName}}} to v{{newVersion}}`
+
+## FAQ
+
+### Conflicts have occurred in PR. What should I do?
+
+If conflicts have occurred in PR, close it and run npm-update-package again.

package/dist/app.js

@@ -3,6 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.app = void 0;
 exports.app = {
     name: 'npm-update-package',
-    version: '0.14.0',
+    version: '0.16.2',
     web: 'https://github.com/npm-update-package/npm-update-package'
 };

package/dist/git/index.js

@@ -1,9 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Git = exports.CommitMessageCreator = exports.BranchNameCreator = void 0;
+exports.GitRepository = exports.Git = exports.CommitMessageCreator = exports.BranchNameCreator = void 0;
 var BranchNameCreator_1 = require("./BranchNameCreator");
 Object.defineProperty(exports, "BranchNameCreator", { enumerable: true, get: function () { return BranchNameCreator_1.BranchNameCreator; } });
 var CommitMessageCreator_1 = require("./CommitMessageCreator");
 Object.defineProperty(exports, "CommitMessageCreator", { enumerable: true, get: function () { return CommitMessageCreator_1.CommitMessageCreator; } });
 var Git_1 = require("./Git");
 Object.defineProperty(exports, "Git", { enumerable: true, get: function () { return Git_1.Git; } });
+var GitRepository_1 = require("./GitRepository");
+Object.defineProperty(exports, "GitRepository", { enumerable: true, get: function () { return GitRepository_1.GitRepository; } });

package/dist/github/PullRequestCreator.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PullRequestCreator = void 0;
-// TODO: add test
 class PullRequestCreator {
     constructor({ github, gitRepo, githubRepo, pullRequestTitleCreator, pullRequestBodyCreator, logger }) {
         this.github = github;
@@ -16,7 +15,7 @@ class PullRequestCreator {
         this.logger.debug(`title=${title}`);
         const body = this.pullRequestBodyCreator.create(outdatedPackage);
         this.logger.debug(`body=${body}`);
-        const createdPullRequest = await this.github.createPullRequest({
+        const pullRequest = await this.github.createPullRequest({
             owner: this.gitRepo.owner,
             repo: this.gitRepo.name,
             base: this.githubRepo.default_branch,
@@ -24,8 +23,8 @@ class PullRequestCreator {
             title,
             body
         });
-        this.logger.debug(`createdPullRequest=${JSON.stringify(createdPullRequest)}`);
-        this.logger.info(`Pull request for ${outdatedPackage.name} has created. ${createdPullRequest.html_url}`);
+        this.logger.debug(`pullRequest=${JSON.stringify(pullRequest)}`);
+        this.logger.info(`Pull request for ${outdatedPackage.name} has created. ${pullRequest.html_url}`);
     }
 }
 exports.PullRequestCreator = PullRequestCreator;

package/dist/logger/LogLevel.js

@@ -4,7 +4,8 @@ exports.isLogLevel = exports.LogLevel = void 0;
 exports.LogLevel = {
     Debug: 'debug',
     Error: 'error',
-    Info: 'info'
+    Info: 'info',
+    Off: 'off'
 };
 const logLevels = Object.values(exports.LogLevel);
 const isLogLevel = (value) => logLevels.includes(value);

package/dist/options/CLIOption.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/options/OptionType.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isOptionType = exports.OptionType = void 0;
+exports.OptionType = {
+    String: 'string',
+    StringArray: 'string[]'
+};
+const optionTypes = Object.values(exports.OptionType);
+const isOptionType = (value) => optionTypes.includes(value);
+exports.isOptionType = isOptionType;

package/dist/options/Options.js

@@ -8,7 +8,7 @@ const Options = (0, io_ts_1.type)({
     branchName: io_ts_1.string,
     commitMessage: io_ts_1.string,
     githubToken: io_ts_1.string,
-    logLevel: (0, io_ts_1.union)([(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)]),
+    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)]),
     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)]),
     pullRequestBody: io_ts_1.string,
     pullRequestTitle: io_ts_1.string

package/dist/options/cliOptions.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cliOptions = void 0;
+const logger_1 = require("../logger");
+const package_manager_1 = require("../package-manager");
+const OptionType_1 = require("./OptionType");
+exports.cliOptions = [
+    {
+        name: 'branch-name',
+        description: 'Branch name template',
+        type: OptionType_1.OptionType.String,
+        required: false,
+        default: 'npm-update-package/{{{packageName}}}/v{{newVersion}}'
+    },
+    {
+        name: 'commit-message',
+        description: 'Commit message template',
+        type: OptionType_1.OptionType.String,
+        required: false,
+        default: 'chore(deps): {{updateType}} update {{{packageName}}} to v{{newVersion}}'
+    },
+    {
+        name: 'github-token',
+        description: 'GitHub token',
+        type: OptionType_1.OptionType.String,
+        required: true
+    },
+    {
+        name: 'log-level',
+        description: 'Log level to show',
+        type: OptionType_1.OptionType.String,
+        required: false,
+        choices: [
+            logger_1.LogLevel.Off,
+            logger_1.LogLevel.Error,
+            logger_1.LogLevel.Info,
+            logger_1.LogLevel.Debug
+        ],
+        default: logger_1.LogLevel.Info
+    },
+    {
+        name: 'package-manager',
+        description: 'Package manager of your project',
+        type: OptionType_1.OptionType.String,
+        required: false,
+        choices: [
+            package_manager_1.PackageManagerName.Npm,
+            package_manager_1.PackageManagerName.Yarn
+        ],
+        default: package_manager_1.PackageManagerName.Npm
+    },
+    {
+        name: 'pull-request-body',
+        description: 'Pull request body template',
+        type: OptionType_1.OptionType.String,
+        required: false,
+        default: `This PR updates these packages:
+
+|package|type|current version|new version|
+|---|---|---|---|
+|[{{{packageName}}}](https://www.npmjs.com/package/{{{packageName}}})|{{updateType}}|\`{{currentVersion}}\`|\`{{newVersion}}\`|
+
+---
+This PR has been generated by [{{{appName}}}]({{{appWeb}}}) v{{appVersion}}`
+    },
+    {
+        name: 'pull-request-title',
+        description: 'Pull request title template',
+        type: OptionType_1.OptionType.String,
+        required: false,
+        default: 'chore(deps): {{updateType}} update {{{packageName}}} to v{{newVersion}}'
+    }
+];

package/dist/options/initOptions.js

@@ -3,38 +3,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.initOptions = void 0;
 const commander_1 = require("commander");
 const app_1 = require("../app");
-const logger_1 = require("../logger");
-const package_manager_1 = require("../package-manager");
+const cliOptions_1 = require("./cliOptions");
 const Options_1 = require("./Options");
+const toCommanderOption_1 = require("./toCommanderOption");
 // TODO: add test
 const initOptions = () => {
-    commander_1.program
-        .version(app_1.app.version)
-        .option('--branch-name <value>', 'Branch name template', 'npm-update-package/{{{packageName}}}/v{{newVersion}}')
-        .option('--commit-message <value>', 'Commit message template', 'chore(deps): {{updateType}} update {{{packageName}}} to v{{newVersion}}')
-        .requiredOption('--github-token <value>', 'GitHub token')
-        .addOption(new commander_1.Option('--log-level <value>', 'Log level to show')
-        .choices([
-        logger_1.LogLevel.Error,
-        logger_1.LogLevel.Info,
-        logger_1.LogLevel.Debug
-    ])
-        .default(logger_1.LogLevel.Info))
-        .addOption(new commander_1.Option('--package-manager <value>', 'Package manager of your project')
-        .choices([
-        package_manager_1.PackageManagerName.Npm,
-        package_manager_1.PackageManagerName.Yarn
-    ])
-        .default(package_manager_1.PackageManagerName.Npm))
-        .option('--pull-request-body <value>', 'Pull request body template', `This PR updates these packages:
-
-|package|type|current version|new version|
-|---|---|---|---|
-|[{{{packageName}}}](https://www.npmjs.com/package/{{{packageName}}})|{{updateType}}|\`{{currentVersion}}\`|\`{{newVersion}}\`|
-
----
-This PR has been generated by [{{{appName}}}]({{{appWeb}}}) v{{appVersion}}`)
-        .option('--pull-request-title <value>', 'Pull request title template', 'chore(deps): {{updateType}} update {{{packageName}}} to v{{newVersion}}');
+    commander_1.program.version(app_1.app.version);
+    cliOptions_1.cliOptions
+        .map(toCommanderOption_1.toCommanderOption)
+        .forEach(option => commander_1.program.addOption(option));
     commander_1.program.parse(process.argv);
     const options = commander_1.program.opts();
     if (!(0, Options_1.isOptions)(options)) {

package/dist/options/toCommanderOption.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toCommanderOption = void 0;
+const commander_1 = require("commander");
+const OptionType_1 = require("./OptionType");
+// TODO: add test
+const toCommanderOption = (cliOption) => {
+    const argument = createArgumentString(cliOption);
+    const option = new commander_1.Option(`--${cliOption.name} ${argument}`, cliOption.description);
+    if (cliOption.choices !== undefined) {
+        option.choices(cliOption.choices);
+    }
+    if (!cliOption.required && cliOption.default !== undefined) {
+        option.default(cliOption.default);
+    }
+    return option;
+};
+exports.toCommanderOption = toCommanderOption;
+const createArgumentString = (cliOption) => {
+    const prefix = cliOption.required ? '<' : '[';
+    const suffix = cliOption.required ? '>' : ']';
+    const name = createArgumentNameString(cliOption.type);
+    return `${prefix}${name}${suffix}`;
+};
+const createArgumentNameString = (optionType) => {
+    switch (optionType) {
+        case OptionType_1.OptionType.String:
+            return 'value';
+        case OptionType_1.OptionType.StringArray:
+            return 'values...';
+    }
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-update-package",
-  "version": "0.14.0",
+  "version": "0.16.2",
   "description": "CLI tool for creating pull request to update npm packages",
   "scripts": {
     "build": "tsc --project tsconfig.build.json",
@@ -24,7 +24,7 @@
     "io-ts": "2.2.16",
     "log4js": "6.3.0",
     "mustache": "4.1.0",
-    "npm-check-updates": "12.0.3",
+    "npm-check-updates": "12.0.5",
     "parse-github-url": "1.0.2",
     "semver": "7.3.5"
   },
@@ -36,22 +36,22 @@
     "@types/node": "12.20.15",
     "@types/parse-github-url": "1.0.0",
     "@types/semver": "7.3.9",
-    "@typescript-eslint/eslint-plugin": "5.6.0",
-    "eslint": "8.4.1",
+    "@typescript-eslint/eslint-plugin": "5.8.0",
+    "eslint": "8.5.0",
     "eslint-config-standard-with-typescript": "21.0.1",
     "eslint-plugin-import": "2.25.3",
     "eslint-plugin-jest": "25.3.0",
     "eslint-plugin-node": "11.1.0",
-    "eslint-plugin-promise": "5.2.0",
+    "eslint-plugin-promise": "6.0.0",
     "eslint-plugin-tsdoc": "0.2.14",
     "husky": "7.0.4",
     "jest": "27.0.6",
-    "lint-staged": "12.1.2",
+    "lint-staged": "12.1.4",
     "npm-run-all": "4.1.5",
     "rimraf": "3.0.2",
-    "ts-jest": "27.1.1",
+    "ts-jest": "27.1.2",
     "ts-node": "10.4.0",
-    "typescript": "4.5.3",
+    "typescript": "4.5.4",
     "utility-types": "3.10.0"
   },
   "repository": {