npm-update-package 0.11.0 → 0.13.0

package/README.md

@@ -9,35 +9,40 @@ CLI tool for creating pull request to update npm packages
 
 This package is currently under development, so the major version is 0 yet.
 
-## Requirements
-
-- Git v2.23.0 or higher
-
-## Installation
-
-If you are using npm:
-
-```sh
-npm i -g npm-update-package
-```
-
-If you are using Yarn:
+## 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 (UTC) 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
 

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

package/dist/git/Git.js

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

package/dist/ncu/Ncu.js

@@ -2,8 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Ncu = void 0;
 const npm_check_updates_1 = require("npm-check-updates");
-const isNcuOutdatedPackages_1 = require("./isNcuOutdatedPackages");
-const NcuOutdatedPackagesConverter_1 = require("./NcuOutdatedPackagesConverter");
+const NcuResult_1 = require("./NcuResult");
+const NcuResultConverter_1 = require("./NcuResultConverter");
 // TODO: add test
 class Ncu {
     constructor(packageJsonReader) {
@@ -30,11 +30,11 @@ class Ncu {
             ...pkg.optionalDependencies
         };
         const result = await (0, npm_check_updates_1.run)(options);
-        if (!(0, isNcuOutdatedPackages_1.isNcuOutdatedPackages)(result)) {
-            throw new Error('result is not NcuOutdatedPackages');
+        if (!(0, NcuResult_1.isNcuResult)(result)) {
+            throw new Error('result is not NcuResult');
         }
-        const ncuOutdatedPackagesConverter = new NcuOutdatedPackagesConverter_1.NcuOutdatedPackagesConverter(currentDependencies);
-        return ncuOutdatedPackagesConverter.toOutdatedPackages(result);
+        const ncuResultConverter = new NcuResultConverter_1.NcuResultConverter(currentDependencies);
+        return ncuResultConverter.toOutdatedPackages(result);
     }
 }
 exports.Ncu = Ncu;

package/dist/ncu/NcuResult.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isNcuResult = exports.NcuResult = void 0;
+const io_ts_1 = require("io-ts");
+exports.NcuResult = (0, io_ts_1.record)(io_ts_1.string, io_ts_1.string);
+exports.isNcuResult = exports.NcuResult.is;

package/dist/ncu/{NcuOutdatedPackagesConverter.js → NcuResultConverter.js}

@@ -1,15 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.NcuOutdatedPackagesConverter = void 0;
+exports.NcuResultConverter = void 0;
 const PackageVersion_1 = require("./PackageVersion");
 const toUpdateType_1 = require("./toUpdateType");
 // TODO: add test
-class NcuOutdatedPackagesConverter {
+class NcuResultConverter {
     constructor(currentDependencies) {
         this.currentDependencies = currentDependencies;
     }
-    toOutdatedPackages(outdatedPackages) {
-        return Object.entries(outdatedPackages)
+    toOutdatedPackages(result) {
+        return Object.entries(result)
             .map(([name, newVersion]) => ({
             name,
             currentVersion: PackageVersion_1.PackageVersion.of(this.currentDependencies[name]),
@@ -23,4 +23,4 @@ class NcuOutdatedPackagesConverter {
         }));
     }
 }
-exports.NcuOutdatedPackagesConverter = NcuOutdatedPackagesConverter;
+exports.NcuResultConverter = NcuResultConverter;

package/dist/package-manager/Npm.js

@@ -5,14 +5,12 @@ exports.Npm = void 0;
 class Npm {
     constructor(terminal) {
         this.terminal = terminal;
-        this.packageFiles = [
-            'package.json',
-            'package-lock.json'
-        ];
+        this.packageFile = 'package.json';
+        this.lockFile = 'package-lock.json';
     }
     /**
-    * @see https://docs.npmjs.com/cli/v8/commands/npm-install
-    */
+     * @see https://docs.npmjs.com/cli/v8/commands/npm-install
+     */
     async install() {
         await this.terminal.run('npm', 'install');
     }

package/dist/package-manager/Yarn.js

@@ -5,10 +5,8 @@ exports.Yarn = void 0;
 class Yarn {
     constructor(terminal) {
         this.terminal = terminal;
-        this.packageFiles = [
-            'package.json',
-            'yarn.lock'
-        ];
+        this.packageFile = 'package.json';
+        this.lockFile = 'yarn.lock';
     }
     /**
      * @see https://classic.yarnpkg.com/en/docs/cli/install

package/dist/processors/OutdatedPackageProcessor.js

@@ -45,7 +45,7 @@ class OutdatedPackageProcessor {
                 });
             }
             this.logger.info(`${outdatedPackage.name} has updated from v${outdatedPackage.currentVersion.version} to v${outdatedPackage.newVersion.version}`);
-            await this.git.add(...this.packageManager.packageFiles);
+            await this.git.add(this.packageManager.packageFile, this.packageManager.lockFile);
             const message = this.commitMessageCreator.create(outdatedPackage);
             this.logger.debug(`message=${message}`);
             await this.git.commit(message);
@@ -60,7 +60,7 @@ class OutdatedPackageProcessor {
             });
         }
         finally {
-            await this.git.restore(...this.packageManager.packageFiles);
+            await this.git.restore(this.packageManager.packageFile, this.packageManager.lockFile);
             await this.git.switch('-');
             await this.git.removeBranch(branchName);
             this.logger.info(`${branchName} branch has removed.`);

package/dist/terminal/Terminal.js

@@ -5,25 +5,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Terminal = void 0;
 const execa_1 = __importDefault(require("execa"));
-const isExecaReturnValue_1 = require("./isExecaReturnValue");
 // TODO: add test
 class Terminal {
     async run(command, ...args) {
         return await (0, execa_1.default)(command, args);
     }
-    async runWithErrorHandling(command, ...args) {
-        try {
-            return await this.run(command, ...args);
-        }
-        catch (e) {
-            const value = e instanceof Error ? JSON.parse(JSON.stringify(e)) : e;
-            if ((0, isExecaReturnValue_1.isExecaReturnValue)(value)) {
-                return value;
-            }
-            else {
-                throw e;
-            }
-        }
-    }
 }
 exports.Terminal = Terminal;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-update-package",
-  "version": "0.11.0",
+  "version": "0.13.0",
   "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.2",
+    "npm-check-updates": "12.0.3",
     "parse-github-url": "1.0.2",
     "semver": "7.3.5"
   },
@@ -36,8 +36,8 @@
     "@types/node": "12.20.15",
     "@types/parse-github-url": "1.0.0",
     "@types/semver": "7.3.9",
-    "@typescript-eslint/eslint-plugin": "5.5.0",
-    "eslint": "8.3.0",
+    "@typescript-eslint/eslint-plugin": "5.6.0",
+    "eslint": "8.4.1",
     "eslint-config-standard-with-typescript": "21.0.1",
     "eslint-plugin-import": "2.25.3",
     "eslint-plugin-jest": "25.3.0",
@@ -49,9 +49,9 @@
     "lint-staged": "12.1.2",
     "npm-run-all": "4.1.5",
     "rimraf": "3.0.2",
-    "ts-jest": "27.0.7",
+    "ts-jest": "27.1.1",
     "ts-node": "10.4.0",
-    "typescript": "4.4.4",
+    "typescript": "4.5.3",
     "utility-types": "3.10.0"
   },
   "repository": {

package/dist/ncu/NcuOutdatedPackages.js

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

package/dist/ncu/isNcuOutdatedPackages.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isNcuOutdatedPackages = void 0;
-// TODO: add test
-const isNcuOutdatedPackages = (value) => {
-    return typeof value === 'object' && value !== null && Object.values(value).every(value => typeof value === 'string');
-};
-exports.isNcuOutdatedPackages = isNcuOutdatedPackages;

package/dist/terminal/isExecaReturnValue.js

@@ -1,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isExecaReturnValue = void 0;
-const io_ts_1 = require("io-ts");
-const ExecaReturnValueType = (0, io_ts_1.intersection)([
-    (0, io_ts_1.type)({
-        command: io_ts_1.string,
-        escapedCommand: io_ts_1.string,
-        exitCode: io_ts_1.number,
-        failed: io_ts_1.boolean,
-        timedOut: io_ts_1.boolean,
-        killed: io_ts_1.boolean,
-        isCanceled: io_ts_1.boolean
-    }),
-    (0, io_ts_1.partial)({
-        signal: io_ts_1.string,
-        signalDescription: io_ts_1.string
-    })
-]);
-// TODO: add test
-const isExecaReturnValue = (value) => {
-    return ExecaReturnValueType.is(value);
-};
-exports.isExecaReturnValue = isExecaReturnValue;