npm-update-package 0.17.2 → 0.19.2

package/README.md

@@ -11,35 +11,6 @@ CLI tool for creating pull request to update npm packages
 npx npm-update-package --github-token $GITHUB_TOKEN
 ```
 
-## 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 }}
-```
-
-Actual working examples can be seen in these repositories.
-
-- [npm-update-package/example-npm](https://github.com/npm-update-package/example-npm)
-
 ## Options
 
 You can customize behavior via command-line options.  
@@ -149,8 +120,79 @@ Pull request title template
 - required: false
 - default: `chore(deps): {{updateType}} update {{{packageName}}} to v{{newVersion}}`
 
+## 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 }}
+```
+
+Actual working examples can be seen in these repositories.
+
+- [npm-update-package/example-npm](https://github.com/npm-update-package/example-npm)
+
+## Flow
+
+The following shows the process flow of npm-update-package:
+
+[![](http://www.plantuml.com/plantuml/svg/RKyxKiCm5EpVARPqYbmWRi9Gq4666GuWx4tiGPQ4z0JXzaIn70D38wsUzkrddzH4pPELAv1Jz3bWCgEJtGCLFcjlb3s2wTxCYQaL6OzexgozZM0YaSDM_RPmDz213iqNqqO0kbve4z4ulv7BQpnAjNcgueSgT8Y-Oqe-IcIWKG7-9Quye8HvvkILU8t6TGDu7fEcFodM102mkuyqjursdhs4uh6qQdyHGxOMaU-PIUjFCVtuAN6jDjzpxDe2dyDeYUQHPrtKbv2oabTOaEmlHvxiDm00)](http://www.plantuml.com/plantuml/uml/RKyxKiCm5EpVARPqYbmWRi9Gq4666GuWx4tiGPQ4z0JXzaIn70D38wsUzkrddzH4pPELAv1Jz3bWCgEJtGCLFcjlb3s2wTxCYQaL6OzexgozZM0YaSDM_RPmDz213iqNqqO0kbve4z4ulv7BQpnAjNcgueSgT8Y-Oqe-IcIWKG7-9Quye8HvvkILU8t6TGDu7fEcFodM102mkuyqjursdhs4uh6qQdyHGxOMaU-PIUjFCVtuAN6jDjzpxDe2dyDeYUQHPrtKbv2oabTOaEmlHvxiDm00)
+
+<!--
+```plantuml
+@startuml
+start
+group main
+:Get outdated packages;
+
+if (All packages are up-to-date) then (yes)
+  end
+else (no)
+endif
+
+group OutdatedPackagesProcessor
+repeat
+  group OutdatedPackageProcessor
+  if (Remote branch exists) then (yes)
+  else (no)
+    :Create branch;
+    :Update package;
+    :Create pull request;
+    :Remove branch;
+  endif
+  end group
+repeat while (Next package exists)
+end group
+
+end group
+end
+@enduml
+```
+-->
+
 ## FAQ
 
+### What is the purpose of npm-update-package?
+
+npm-update-package can be used in environments where Renovate cannot be used for some reason.
+
 ### 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.17.2',
+    version: '0.19.0',
     web: 'https://github.com/npm-update-package/npm-update-package'
 };

package/dist/file/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readFile = void 0;
+var readFile_1 = require("./readFile");
+Object.defineProperty(exports, "readFile", { enumerable: true, get: function () { return readFile_1.readFile; } });

package/dist/file/readFile.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readFile = void 0;
+const promises_1 = require("fs/promises");
+// TODO: add test
+const readFile = async (path) => {
+    const data = await (0, promises_1.readFile)(path, 'utf8');
+    return data;
+};
+exports.readFile = readFile;

package/dist/main.js

@@ -16,11 +16,7 @@ const main = async ({ options, logger }) => {
         githubToken: options.githubToken !== '' ? '***' : ''
     })}`);
     const packageJsonParser = new package_json_1.PackageJsonParser(logger);
-    const packageJsonReader = new package_json_1.PackageJsonReader({
-        packageJsonParser,
-        logger
-    });
-    const ncu = new ncu_1.Ncu(packageJsonReader);
+    const ncu = new ncu_1.Ncu(packageJsonParser);
     const outdatedPackages = await ncu.check();
     logger.debug(`outdatedPackages=${JSON.stringify(outdatedPackages)}`);
     if (outdatedPackages.length === 0) {

package/dist/ncu/Ncu.js

@@ -2,12 +2,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Ncu = void 0;
 const npm_check_updates_1 = require("npm-check-updates");
+const file_1 = require("../file");
 const NcuResult_1 = require("./NcuResult");
 const NcuResultConverter_1 = require("./NcuResultConverter");
 // TODO: add test
 class Ncu {
-    constructor(packageJsonReader) {
-        this.packageJsonReader = packageJsonReader;
+    constructor(packageJsonParser) {
+        this.packageJsonParser = packageJsonParser;
     }
     async check() {
         return await this.run({
@@ -22,7 +23,8 @@ class Ncu {
         });
     }
     async run(options) {
-        const pkg = await this.packageJsonReader.read('./package.json');
+        const packageJson = await (0, file_1.readFile)('./package.json');
+        const pkg = this.packageJsonParser.parse(packageJson);
         const currentDependencies = {
             ...pkg.dependencies,
             ...pkg.devDependencies,

package/dist/package-json/index.js

@@ -1,7 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PackageJsonReader = exports.PackageJsonParser = void 0;
+exports.PackageJsonParser = void 0;
 var PackageJsonParser_1 = require("./PackageJsonParser");
 Object.defineProperty(exports, "PackageJsonParser", { enumerable: true, get: function () { return PackageJsonParser_1.PackageJsonParser; } });
-var PackageJsonReader_1 = require("./PackageJsonReader");
-Object.defineProperty(exports, "PackageJsonReader", { enumerable: true, get: function () { return PackageJsonReader_1.PackageJsonReader; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-update-package",
-  "version": "0.17.2",
+  "version": "0.19.2",
   "description": "CLI tool for creating pull request to update npm packages",
   "scripts": {
     "build": "tsc --project tsconfig.build.json",
@@ -31,17 +31,17 @@
   },
   "devDependencies": {
     "@jest/types": "27.0.6",
-    "@tsconfig/node12": "1.0.9",
+    "@tsconfig/node16": "1.0.2",
     "@types/jest": "27.0.3",
     "@types/mustache": "4.1.2",
-    "@types/node": "12.20.15",
+    "@types/node": "16.11.17",
     "@types/parse-github-url": "1.0.0",
     "@types/semver": "7.3.9",
     "@typescript-eslint/eslint-plugin": "5.8.1",
     "eslint": "8.5.0",
     "eslint-config-standard-with-typescript": "21.0.1",
     "eslint-plugin-import": "2.25.3",
-    "eslint-plugin-jest": "25.3.2",
+    "eslint-plugin-jest": "25.3.3",
     "eslint-plugin-node": "11.1.0",
     "eslint-plugin-promise": "6.0.0",
     "eslint-plugin-tsdoc": "0.2.14",

package/dist/package-json/PackageJsonReader.js

@@ -1,20 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PackageJsonReader = void 0;
-const fs_1 = __importDefault(require("fs"));
-// TODO: add test
-class PackageJsonReader {
-    constructor({ packageJsonParser, logger }) {
-        this.packageJsonParser = packageJsonParser;
-        this.logger = logger;
-    }
-    async read(filePath) {
-        const json = await fs_1.default.promises.readFile(filePath, 'utf8');
-        this.logger.debug(`json=${json}`);
-        return this.packageJsonParser.parse(json);
-    }
-}
-exports.PackageJsonReader = PackageJsonReader;