npm-update-package 0.9.0 → 0.11.1

package/README.md

@@ -5,31 +5,48 @@
 
 CLI tool for creating pull request to update npm packages
 
-## Installation
+## Caution
 
-If you are using npm:
+This package is currently under development, so the major version is 0 yet.
 
-```sh
-npm i -g npm-update-package
-```
+## Requirements
 
-If you are using Yarn:
+- Git v2.23.0 or higher
+
+## Usage
 
 ```sh
-yarn global add npm-update-package
+npx npm-update-package --github-token $GITHUB_TOKEN
 ```
 
-Or, you can use [npx](https://docs.npmjs.com/cli/v8/commands/npx).
-
-```sh
-npx npm-update-package
+## Examples
+
+Example of running npm-update-package on GitHub Actions at 0:00 every day:
+
+```yaml
+name: npm-update-package
+on:
+  schedule:
+    - cron: '0 0 * * *'
+jobs:
+  npm-update-package:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+      - run: |
+          git config user.name $GIT_USER_NAME
+          git config user.email $GIT_USER_EMAIL
+          npx npm-update-package --github-token $GITHUB_TOKEN
+        env:
+          GIT_USER_EMAIL: 41898282+github-actions[bot]@users.noreply.github.com
+          GIT_USER_NAME: github-actions[bot]
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```
 
-## Usage
+Actual working examples can be seen in these repositories.
 
-```sh
-npm-update-package --github-token $GITHUB_TOKEN
-```
+- [npm-update-package/example-npm](https://github.com/npm-update-package/example-npm)
 
 ## Options
 
@@ -41,7 +58,7 @@ Template strings such as `--branch-name` can embed variables like `{{packageName
 Branch name template
 
 - value: template string
-- embeddable variables:
+- variables:
   - `currentVersion`
   - `newVersion`
   - `packageName`
@@ -54,7 +71,7 @@ Branch name template
 Commit message template
 
 - value: template string
-- embeddable variables:
+- variables:
   - `currentVersion`
   - `newVersion`
   - `packageName`
@@ -62,20 +79,6 @@ Commit message template
 - required: false
 - default: `chore(deps): {{updateType}} update {{{packageName}}} to v{{newVersion}}`
 
-### `--git-user-email`
-
-User email of commit
-
-- value: string
-- required: false
-
-### `--git-user-name`
-
-User name of commit
-
-- value: string
-- required: false
-
 ### `--github-token`
 
 GitHub token
@@ -88,6 +91,7 @@ GitHub token
 Log level to show
 
 - value: string
+  - `error`
   - `info`
   - `debug`
 - required: false
@@ -108,7 +112,7 @@ Package manager of your project
 Pull request body template
 
 - value: template string
-- embeddable variables:
+- variables:
   - `appName`
   - `appVersion`
   - `appWeb`
@@ -135,7 +139,7 @@ This PR has been generated by [{{{appName}}}]({{{appWeb}}}) v{{appVersion}}
 Pull request title template
 
 - value: template string
-- embeddable variables:
+- variables:
   - `currentVersion`
   - `newVersion`
   - `packageName`

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.9.0',
+    version: '0.11.1',
     web: 'https://github.com/npm-update-package/npm-update-package'
 };

package/dist/bin.js

@@ -12,8 +12,10 @@ logger.info(`Start ${app_1.app.name} v${app_1.app.version}`);
     options,
     logger
 })
-    .then(() => logger.info(`End ${app_1.app.name} v${app_1.app.version}`))
-    .catch((e) => {
-    // TODO: improve error handling
-    logger.fatal('Unexpected error has occurred.', e);
+    .then(() => {
+    logger.info(`End ${app_1.app.name} v${app_1.app.version}`);
+})
+    .catch((error) => {
+    logger.fatal(error);
+    throw error;
 });

package/dist/git/Git.js

@@ -10,14 +10,11 @@ class Git {
     async add(...files) {
         await this.terminal.run('git', 'add', ...files);
     }
-    async checkout(branchName) {
-        await this.terminal.run('git', 'checkout', branchName);
-    }
     async commit(message) {
         await this.terminal.run('git', 'commit', '--message', message);
     }
     async createBranch(branchName) {
-        await this.terminal.run('git', 'checkout', '-b', branchName);
+        await this.terminal.run('git', 'switch', '-c', branchName);
     }
     async getConfig(key) {
         const { stdout } = await this.terminal.run('git', 'config', key);
@@ -41,8 +38,14 @@ class Git {
     async removeBranch(branchName) {
         await this.terminal.run('git', 'branch', '-D', branchName);
     }
+    async restore(...files) {
+        await this.terminal.run('git', 'restore', '--worktree', '--staged', ...files);
+    }
     async setConfig(key, value) {
         await this.terminal.run('git', 'config', key, value);
     }
+    async switch(branchName) {
+        await this.terminal.run('git', 'switch', branchName);
+    }
 }
 exports.Git = Git;

package/dist/git/index.js

@@ -1,11 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Git = exports.Committer = exports.CommitMessageCreator = exports.BranchNameCreator = void 0;
+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 Committer_1 = require("./Committer");
-Object.defineProperty(exports, "Committer", { enumerable: true, get: function () { return Committer_1.Committer; } });
 var Git_1 = require("./Git");
 Object.defineProperty(exports, "Git", { enumerable: true, get: function () { return Git_1.Git; } });

package/dist/github/RemoteBranchExistenceChecker.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RemoteBranchExistenceChecker = void 0;
-// TODO: add test
 class RemoteBranchExistenceChecker {
     constructor(remoteBranchNames) {
         this.remoteBranchNames = remoteBranchNames;

package/dist/logger/LogLevel.js

@@ -2,8 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isLogLevel = exports.LogLevel = void 0;
 exports.LogLevel = {
-    Info: 'info',
-    Debug: 'debug'
+    Debug: 'debug',
+    Error: 'error',
+    Info: 'info'
 };
 const logLevels = Object.values(exports.LogLevel);
 const isLogLevel = (value) => logLevels.includes(value);

package/dist/main.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.main = void 0;
+const Either_1 = require("fp-ts/lib/Either");
 const git_1 = require("./git");
 const github_1 = require("./github");
 const ncu_1 = require("./ncu");
@@ -43,13 +44,6 @@ const main = async ({ options, logger }) => {
     });
     logger.debug(`remoteBranches=${JSON.stringify(remoteBranches)}`);
     const remoteBranchExistenceChecker = github_1.RemoteBranchExistenceChecker.of(remoteBranches);
-    const committer = new git_1.Committer({
-        git,
-        user: {
-            name: options.gitUserName,
-            email: options.gitUserEmail
-        }
-    });
     const packageManager = (0, package_manager_1.createPackageManager)({
         terminal,
         packageManager: options.packageManager
@@ -67,7 +61,6 @@ const main = async ({ options, logger }) => {
     const branchNameCreator = new git_1.BranchNameCreator(options.branchName);
     const commitMessageCreator = new git_1.CommitMessageCreator(options.commitMessage);
     const outdatedPackageProcessor = new processors_1.OutdatedPackageProcessor({
-        committer,
         git,
         ncu,
         packageManager,
@@ -83,14 +76,24 @@ const main = async ({ options, logger }) => {
     });
     const results = await outdatedPackagesProcessor.process(outdatedPackages);
     logger.debug(`results=${JSON.stringify(results)}`);
-    const updatedPackages = results
+    const succeededResults = results.filter(Either_1.isRight).map(({ right }) => right);
+    logger.debug(`succeededResults=${JSON.stringify(succeededResults)}`);
+    const updatedPackages = succeededResults
         .filter(({ updated }) => updated)
         .map(({ outdatedPackage }) => outdatedPackage);
     logger.debug(`updatedPackages=${JSON.stringify(updatedPackages)}`);
-    const skippedPackages = results
+    const skippedPackages = succeededResults
         .filter(({ skipped }) => skipped)
         .map(({ outdatedPackage }) => outdatedPackage);
     logger.debug(`skippedPackages=${JSON.stringify(skippedPackages)}`);
-    logger.info(`${updatedPackages.length} packages has updated. ${skippedPackages.length} packages has skipped.`);
+    const failedResults = results.filter(Either_1.isLeft).map(({ left }) => left);
+    logger.debug(`failedResults=${JSON.stringify(failedResults)}`);
+    const failedPackages = failedResults.map(({ outdatedPackage }) => outdatedPackage);
+    logger.debug(`failedPackages=${JSON.stringify(failedPackages)}`);
+    // TODO: show as table
+    logger.info(`Processed ${succeededResults.length + failedPackages.length} packages:
+- ${updatedPackages.length} packages has updated: ${updatedPackages.map(({ name }) => name).join(',')}
+- ${skippedPackages.length} packages has skipped: ${skippedPackages.map(({ name }) => name).join(',')}
+- ${failedPackages.length} packages has failed: ${failedPackages.map(({ name }) => name).join(',')}`);
 };
 exports.main = main;

package/dist/options/Options.js

@@ -4,19 +4,13 @@ exports.isOptions = void 0;
 const io_ts_1 = require("io-ts");
 const logger_1 = require("../logger");
 const package_manager_1 = require("../package-manager");
-const Options = (0, io_ts_1.intersection)([
-    (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.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
-    }),
-    (0, io_ts_1.partial)({
-        gitUserEmail: io_ts_1.string,
-        gitUserName: io_ts_1.string
-    })
-]);
+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)]),
+    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
+});
 exports.isOptions = Options.is;

package/dist/options/initOptions.js

@@ -12,11 +12,10 @@ const initOptions = () => {
         .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}}')
-        .option('--git-user-email <value>', 'User email of commit')
-        .option('--git-user-name <value>', 'User name of commit')
         .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
     ])

package/dist/processors/OutdatedPackageProcessor.js

@@ -1,10 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OutdatedPackageProcessor = void 0;
+const Either_1 = require("fp-ts/lib/Either");
 // TODO: add test
 class OutdatedPackageProcessor {
-    constructor({ committer, git, ncu, packageManager, pullRequestCreator, remoteBranchExistenceChecker, logger, branchNameCreator, commitMessageCreator }) {
-        this.committer = committer;
+    constructor({ git, ncu, packageManager, pullRequestCreator, remoteBranchExistenceChecker, logger, branchNameCreator, commitMessageCreator }) {
         this.git = git;
         this.ncu = ncu;
         this.packageManager = packageManager;
@@ -22,35 +22,49 @@ class OutdatedPackageProcessor {
         this.logger.debug(`branchName=${branchName}`);
         if (this.remoteBranchExistenceChecker.check(branchName)) {
             this.logger.info(`Skip ${outdatedPackage.name} because ${branchName} branch already exists on remote.`);
-            return {
+            return (0, Either_1.right)({
                 outdatedPackage,
                 skipped: true
-            };
+            });
         }
         await this.git.createBranch(branchName);
         this.logger.info(`${branchName} branch has created.`);
-        const updatedPackages = await this.ncu.update(outdatedPackage);
-        if (updatedPackages.length !== 1) {
-            throw new Error(`Failed to update ${outdatedPackage.name}.`);
+        try {
+            try {
+                const updatedPackages = await this.ncu.update(outdatedPackage);
+                if (updatedPackages.length !== 1) {
+                    throw new Error(`Failed to update ${outdatedPackage.name}.`);
+                }
+                await this.packageManager.install();
+            }
+            catch (error) {
+                this.logger.error(error);
+                return (0, Either_1.left)({
+                    outdatedPackage,
+                    error
+                });
+            }
+            this.logger.info(`${outdatedPackage.name} has updated from v${outdatedPackage.currentVersion.version} to v${outdatedPackage.newVersion.version}`);
+            await this.git.add(...this.packageManager.packageFiles);
+            const message = this.commitMessageCreator.create(outdatedPackage);
+            this.logger.debug(`message=${message}`);
+            await this.git.commit(message);
+            await this.git.push(branchName);
+            await this.pullRequestCreator.create({
+                outdatedPackage,
+                branchName
+            });
+            return (0, Either_1.right)({
+                outdatedPackage,
+                updated: true
+            });
+        }
+        finally {
+            await this.git.restore(...this.packageManager.packageFiles);
+            await this.git.switch('-');
+            await this.git.removeBranch(branchName);
+            this.logger.info(`${branchName} branch has removed.`);
         }
-        await this.packageManager.install();
-        this.logger.info(`${outdatedPackage.name} has updated from v${outdatedPackage.currentVersion.version} to v${outdatedPackage.newVersion.version}`);
-        await this.git.add(...this.packageManager.packageFiles);
-        const message = this.commitMessageCreator.create(outdatedPackage);
-        this.logger.debug(`message=${message}`);
-        await this.committer.commit(message);
-        await this.git.push(branchName);
-        await this.pullRequestCreator.create({
-            outdatedPackage,
-            branchName
-        });
-        await this.git.checkout('-');
-        await this.git.removeBranch(branchName);
-        this.logger.info(`${branchName} branch has removed.`);
-        return {
-            outdatedPackage,
-            updated: true
-        };
     }
 }
 exports.OutdatedPackageProcessor = OutdatedPackageProcessor;

package/dist/processors/SucceededResult.js

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

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "npm-update-package",
-  "version": "0.9.0",
+  "version": "0.11.1",
   "description": "CLI tool for creating pull request to update npm packages",
   "scripts": {
     "build": "tsc --project tsconfig.build.json",
     "clean": "rimraf dist",
     "lint": "eslint '**/*.{js,ts}'",
+    "prebuild": "npm run clean",
     "prepare": "husky install",
-    "prepublish": "npm-run-all clean lint test build",
+    "prepublish": "npm-run-all lint test build",
     "start": "ts-node src/bin.ts",
     "test": "jest --passWithNoTests"
   },
@@ -35,13 +36,13 @@
     "@types/node": "12.20.15",
     "@types/parse-github-url": "1.0.0",
     "@types/semver": "7.3.9",
-    "@typescript-eslint/eslint-plugin": "5.4.0",
+    "@typescript-eslint/eslint-plugin": "5.5.0",
     "eslint": "8.3.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.1.1",
+    "eslint-plugin-promise": "5.2.0",
     "eslint-plugin-tsdoc": "0.2.14",
     "husky": "7.0.4",
     "jest": "27.0.6",

package/dist/git/Committer.js

@@ -1,31 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Committer = void 0;
-// TODO: add test
-class Committer {
-    constructor({ git, user }) {
-        this.git = git;
-        this.user = user;
-    }
-    async commit(message) {
-        var _a, _b;
-        let name;
-        if (((_a = this.user) === null || _a === void 0 ? void 0 : _a.name) !== undefined) {
-            name = await this.git.getConfig('user.name');
-            await this.git.setConfig('user.name', this.user.name);
-        }
-        let email;
-        if (((_b = this.user) === null || _b === void 0 ? void 0 : _b.email) !== undefined) {
-            email = await this.git.getConfig('user.email');
-            await this.git.setConfig('user.email', this.user.email);
-        }
-        await this.git.commit(message);
-        if (name !== undefined) {
-            await this.git.setConfig('user.name', name);
-        }
-        if (email !== undefined) {
-            await this.git.setConfig('user.email', email);
-        }
-    }
-}
-exports.Committer = Committer;