npm-update-package 0.1.0

package/.eslintignore

@@ -0,0 +1,3 @@
+/coverage
+/dist
+/node_modules

package/.eslintrc.js

@@ -0,0 +1,23 @@
+module.exports = {
+  extends: [
+    'standard-with-typescript',
+    'plugin:jest/recommended'
+  ],
+  plugins: [
+    'eslint-plugin-tsdoc'
+  ],
+  parserOptions: {
+    project: './tsconfig.json'
+  },
+  rules: {
+    'import/order': ['error', {
+      alphabetize: {
+        order: 'asc',
+        caseInsensitive: true
+      }
+    }],
+    'no-console': 'error',
+    'sort-imports': 'off',
+    'tsdoc/syntax': 'warn'
+  }
+}

package/.github/renovate.json

@@ -0,0 +1,15 @@
+{
+  "extends": [
+    "config:base"
+  ],
+  "packageRules": [
+    {
+      "matchPackageNames": ["@types/node"],
+      "allowedVersions": "<13"
+    },
+    {
+      "matchPackageNames": ["node"],
+      "allowedVersions": "<13"
+    }
+  ]
+}

package/.github/workflows/eslint.yml

@@ -0,0 +1,14 @@
+name: eslint
+on:
+  pull_request:
+    branches: [ master ]
+jobs:
+  eslint:
+    name: runner / eslint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: eslint
+        uses: reviewdog/action-eslint@v1
+        with:
+          reporter: github-pr-check

package/.github/workflows/test.yml

@@ -0,0 +1,19 @@
+name: test
+on:
+  pull_request:
+    branches: [ master ]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [14.17.1]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v2
+      with:
+        node-version: ${{ matrix.node-version }}
+    - run: npm ci
+    - run: npm run build --if-present
+    - run: npm test

package/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx lint-staged

package/.nvmrc

@@ -0,0 +1 @@
+12.20.2

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2020 TS Examples
+Copyright (c) 2021 Munieru
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,43 @@
+[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
+
+# npm-update-package
+
+CLI tool for creating pull request to update npm packages
+
+## Installation
+
+If you are using npm:
+
+```sh
+npm i -g npm-update-package
+```
+
+If you are using Yarn:
+
+```sh
+yarn global add npm-update-package
+```
+
+Or, you can use [npx](https://docs.npmjs.com/cli/v8/commands/npx).
+
+```sh
+npx npm-update-package
+```
+
+## Usage
+
+```sh
+npm-update-package --github-token $GITHUB_TOKEN
+```
+
+## Options
+
+You can customize behavior via command-line options.
+
+|Option|Description|Required|Value|Default|
+|---|---|---|---|---|
+|`--git-user-email`|User email of commit|-|string|-|
+|`--git-user-name`|User name of commit|-|string|-|
+|`--github-token`|GitHub token|✓|string|-|
+|`--log-level`|Log level to show|-|`info`, `debug`|`info`|
+|`--package-manager`|Package manager of your project|-|`npm`, `yarn`|`npm`|

package/dist/app.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.app = void 0;
+exports.app = {
+    name: 'npm-update-package',
+    version: '0.1.0',
+    web: 'https://github.com/munierujp/npm-update-package'
+};

package/dist/bin.js

@@ -0,0 +1,18 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const logger_1 = require("./logger");
+const main_1 = require("./main");
+const options_1 = require("./options");
+const options = (0, options_1.initOptions)();
+const logger = (0, logger_1.createLogger)(options.logLevel);
+logger.info('Start npm-update-package.');
+(0, main_1.main)({
+    options,
+    logger
+})
+    .then(() => logger.info('End npm-update-package'))
+    .catch((e) => {
+    // TODO: improve error handling
+    logger.fatal('Unexpected error has occurred.', e);
+});

package/dist/enums/LogLevel.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isLogLevel = exports.LogLevel = void 0;
+exports.LogLevel = {
+    Info: 'info',
+    Debug: 'debug'
+};
+const logLevels = Object.values(exports.LogLevel);
+const isLogLevel = (value) => logLevels.includes(value);
+exports.isLogLevel = isLogLevel;

package/dist/enums/PackageManagerName.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isPackageManagerName = exports.PackageManagerName = void 0;
+exports.PackageManagerName = {
+    Npm: 'npm',
+    Yarn: 'yarn'
+};
+const packageManagerNames = Object.values(exports.PackageManagerName);
+const isPackageManagerName = (value) => packageManagerNames.includes(value);
+exports.isPackageManagerName = isPackageManagerName;

package/dist/enums/UpdateType.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isUpdateType = exports.UpdateType = void 0;
+exports.UpdateType = {
+    Major: 'major',
+    Minor: 'minor',
+    Patch: 'patch'
+};
+const updateTypes = Object.values(exports.UpdateType);
+const isUpdateType = (value) => updateTypes.includes(value);
+exports.isUpdateType = isUpdateType;

package/dist/enums/index.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UpdateType = exports.isUpdateType = exports.PackageManagerName = exports.isPackageManagerName = exports.LogLevel = exports.isLogLevel = void 0;
+var LogLevel_1 = require("./LogLevel");
+Object.defineProperty(exports, "isLogLevel", { enumerable: true, get: function () { return LogLevel_1.isLogLevel; } });
+Object.defineProperty(exports, "LogLevel", { enumerable: true, get: function () { return LogLevel_1.LogLevel; } });
+var PackageManagerName_1 = require("./PackageManagerName");
+Object.defineProperty(exports, "isPackageManagerName", { enumerable: true, get: function () { return PackageManagerName_1.isPackageManagerName; } });
+Object.defineProperty(exports, "PackageManagerName", { enumerable: true, get: function () { return PackageManagerName_1.PackageManagerName; } });
+var UpdateType_1 = require("./UpdateType");
+Object.defineProperty(exports, "isUpdateType", { enumerable: true, get: function () { return UpdateType_1.isUpdateType; } });
+Object.defineProperty(exports, "UpdateType", { enumerable: true, get: function () { return UpdateType_1.UpdateType; } });

package/dist/git/Committer.js

@@ -0,0 +1,31 @@
+"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;

package/dist/git/Git.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Git = void 0;
+const GitRepository_1 = require("./GitRepository");
+// TODO: add test
+class Git {
+    constructor(terminal) {
+        this.terminal = terminal;
+    }
+    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);
+    }
+    async getConfig(key) {
+        const { stdout } = await this.terminal.run('git', 'config', key);
+        return stdout.trim();
+    }
+    async getCurrentBranch() {
+        const { stdout } = await this.terminal.run('git', 'rev-parse', '--abbrev-ref', 'HEAD');
+        return stdout.trim();
+    }
+    async getRemoteUrl() {
+        const { stdout } = await this.terminal.run('git', 'remote', 'get-url', '--push', 'origin');
+        return stdout.trim();
+    }
+    async getRepository() {
+        const url = await this.getRemoteUrl();
+        return GitRepository_1.GitRepository.of(url);
+    }
+    async push(branchName) {
+        await this.terminal.run('git', 'push', 'origin', branchName);
+    }
+    async removeBranch(branchName) {
+        await this.terminal.run('git', 'branch', '-D', branchName);
+    }
+    async setConfig(key, value) {
+        await this.terminal.run('git', 'config', key, value);
+    }
+}
+exports.Git = Git;

package/dist/git/GitRepository.js

@@ -0,0 +1,41 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GitRepository = void 0;
+const parse_github_url_1 = __importDefault(require("parse-github-url"));
+class GitRepository {
+    constructor({ host, owner, name }) {
+        this.host = host;
+        this.owner = owner;
+        this.name = name;
+    }
+    static of(url) {
+        const parsed = (0, parse_github_url_1.default)(url);
+        if (parsed === null) {
+            throw new Error(`Failed to parse url. url=${url}`);
+        }
+        const { host, owner, name } = parsed;
+        if (host === null || owner === null || name === null) {
+            throw new Error(`Failed to parse url. url=${url}`);
+        }
+        return new GitRepository({
+            host,
+            owner,
+            name
+        });
+    }
+    get apiEndPoint() {
+        if (this.isGitHubDotCom) {
+            return 'https://api.github.com';
+        }
+        else {
+            return `https://${this.host}/api/v3`;
+        }
+    }
+    get isGitHubDotCom() {
+        return this.host === 'github.com';
+    }
+}
+exports.GitRepository = GitRepository;

package/dist/git/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Git = exports.Committer = void 0;
+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/Branch.js

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

package/dist/github/GitHub.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GitHub = void 0;
+// TODO: add test
+class GitHub {
+    constructor(octokit) {
+        this.octokit = octokit;
+    }
+    async createPullRequest(params) {
+        const { data } = await this.octokit.pulls.create(params);
+        return data;
+    }
+    async fetchBranches(params) {
+        const { data } = await this.octokit.repos.listBranches(params);
+        return data;
+    }
+    async fetchRepository(params) {
+        const { data } = await this.octokit.repos.get(params);
+        return data;
+    }
+}
+exports.GitHub = GitHub;

package/dist/github/PullRequest.js

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

package/dist/github/PullRequestCreator.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PullRequestCreator = void 0;
+const createPullRequestBody_1 = require("./createPullRequestBody");
+const createPullRequestTitle_1 = require("./createPullRequestTitle");
+// TODO: add test
+class PullRequestCreator {
+    constructor({ github, gitRepo, githubRepo, logger }) {
+        this.github = github;
+        this.gitRepo = gitRepo;
+        this.githubRepo = githubRepo;
+        this.logger = logger;
+    }
+    async create({ outdatedPackage, branchName }) {
+        const title = (0, createPullRequestTitle_1.createPullRequestTitle)(outdatedPackage);
+        this.logger.debug(`title=${title}`);
+        const body = (0, createPullRequestBody_1.createPullRequestBody)(outdatedPackage);
+        this.logger.debug(`body=${body}`);
+        const createdPullRequest = await this.github.createPullRequest({
+            owner: this.gitRepo.owner,
+            repo: this.gitRepo.name,
+            base: this.githubRepo.default_branch,
+            head: branchName,
+            title,
+            body
+        });
+        this.logger.debug(`createdPullRequest=${JSON.stringify(createdPullRequest)}`);
+        this.logger.info(`Pull request for ${outdatedPackage.name} has created. ${createdPullRequest.html_url}`);
+    }
+}
+exports.PullRequestCreator = PullRequestCreator;

package/dist/github/RemoteBranchExistenceChecker.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RemoteBranchExistenceChecker = void 0;
+// TODO: add test
+class RemoteBranchExistenceChecker {
+    constructor(remoteBranchNames) {
+        this.remoteBranchNames = remoteBranchNames;
+    }
+    static of(remoteBranches) {
+        const remoteBranchNames = remoteBranches.map(({ name }) => name);
+        return new RemoteBranchExistenceChecker(remoteBranchNames);
+    }
+    check(branchName) {
+        return this.remoteBranchNames.includes(branchName);
+    }
+}
+exports.RemoteBranchExistenceChecker = RemoteBranchExistenceChecker;

package/dist/github/Repository.js

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

package/dist/github/createGitHub.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createGitHub = void 0;
+const createOctokit_1 = require("./createOctokit");
+const GitHub_1 = require("./GitHub");
+// TODO: add test
+const createGitHub = ({ repository, token }) => {
+    const octokit = (0, createOctokit_1.createOctokit)({
+        repository,
+        token
+    });
+    return new GitHub_1.GitHub(octokit);
+};
+exports.createGitHub = createGitHub;

package/dist/github/createOctokit.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createOctokit = void 0;
+const rest_1 = require("@octokit/rest");
+const app_1 = require("../app");
+// TODO: add test
+const createOctokit = ({ repository, token }) => {
+    const auth = `token ${token}`;
+    const userAgent = `${app_1.app.name}/${app_1.app.version}`;
+    if (repository.isGitHubDotCom) {
+        return new rest_1.Octokit({
+            auth,
+            userAgent
+        });
+    }
+    else {
+        return new rest_1.Octokit({
+            auth,
+            userAgent,
+            baseUrl: repository.apiEndPoint
+        });
+    }
+};
+exports.createOctokit = createOctokit;

package/dist/github/createPullRequestBody.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createPullRequestBody = void 0;
+const app_1 = require("../app");
+const createPullRequestBody = (outdatedPackage) => {
+    const packageName = outdatedPackage.name;
+    const currentVersion = outdatedPackage.currentVersion.version;
+    const newVersion = outdatedPackage.newVersion.version;
+    const updateType = outdatedPackage.type;
+    return `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 [${app_1.app.name}](${app_1.app.web})`;
+};
+exports.createPullRequestBody = createPullRequestBody;

package/dist/github/createPullRequestTitle.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createPullRequestTitle = void 0;
+const createPullRequestTitle = (outdatedPackage) => {
+    const packageName = outdatedPackage.name;
+    const newVersion = outdatedPackage.newVersion.version;
+    const updateType = outdatedPackage.type;
+    return `chore(deps): ${updateType} update ${packageName} to v${newVersion}`;
+};
+exports.createPullRequestTitle = createPullRequestTitle;

package/dist/github/index.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RemoteBranchExistenceChecker = exports.PullRequestCreator = exports.GitHub = exports.createGitHub = void 0;
+var createGitHub_1 = require("./createGitHub");
+Object.defineProperty(exports, "createGitHub", { enumerable: true, get: function () { return createGitHub_1.createGitHub; } });
+var GitHub_1 = require("./GitHub");
+Object.defineProperty(exports, "GitHub", { enumerable: true, get: function () { return GitHub_1.GitHub; } });
+var PullRequestCreator_1 = require("./PullRequestCreator");
+Object.defineProperty(exports, "PullRequestCreator", { enumerable: true, get: function () { return PullRequestCreator_1.PullRequestCreator; } });
+var RemoteBranchExistenceChecker_1 = require("./RemoteBranchExistenceChecker");
+Object.defineProperty(exports, "RemoteBranchExistenceChecker", { enumerable: true, get: function () { return RemoteBranchExistenceChecker_1.RemoteBranchExistenceChecker; } });

package/dist/logger/Logger.js

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

package/dist/logger/createLogger.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createLogger = void 0;
+const log4js_1 = require("log4js");
+// TODO: add test
+const createLogger = (logLevel) => {
+    const logger = (0, log4js_1.getLogger)();
+    logger.level = logLevel;
+    return logger;
+};
+exports.createLogger = createLogger;

package/dist/logger/index.js

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

package/dist/main.js

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.main = void 0;
+const git_1 = require("./git");
+const github_1 = require("./github");
+const ncu_1 = require("./ncu");
+const outdated_package_processor_1 = require("./outdated-package-processor");
+const outdated_packages_processor_1 = require("./outdated-packages-processor");
+const package_manager_1 = require("./package-manager");
+const terminal_1 = require("./terminal");
+// TODO: add test
+const main = async ({ options, logger }) => {
+    logger.debug(`options=${JSON.stringify(options)}`);
+    const ncu = new ncu_1.Ncu();
+    const outdatedPackages = await ncu.check();
+    logger.debug(`outdatedPackages=${JSON.stringify(outdatedPackages)}`);
+    if (outdatedPackages.length === 0) {
+        logger.info('All packages are up-to-date.');
+        return;
+    }
+    logger.info(`There are ${outdatedPackages.length} outdated packages.`);
+    const terminal = new terminal_1.Terminal();
+    const git = new git_1.Git(terminal);
+    const gitRepo = await git.getRepository();
+    logger.debug(`gitRepo=${JSON.stringify(gitRepo)}`);
+    const github = (0, github_1.createGitHub)({
+        repository: gitRepo,
+        token: options.githubToken
+    });
+    const githubRepo = await github.fetchRepository({
+        owner: gitRepo.owner,
+        repo: gitRepo.name
+    });
+    logger.debug(`githubRepo=${JSON.stringify(githubRepo)}`);
+    const remoteBranches = await github.fetchBranches({
+        owner: gitRepo.owner,
+        repo: gitRepo.name
+    });
+    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
+    });
+    const pullRequestCreator = new github_1.PullRequestCreator({
+        github,
+        gitRepo,
+        githubRepo,
+        logger
+    });
+    const outdatedPackageProcessor = new outdated_package_processor_1.OutdatedPackageProcessor({
+        committer,
+        git,
+        ncu,
+        packageManager,
+        pullRequestCreator,
+        remoteBranchExistenceChecker,
+        logger
+    });
+    const outdatedPackagesProcessor = new outdated_packages_processor_1.OutdatedPackagesProcessor({
+        outdatedPackageProcessor,
+        logger
+    });
+    const results = await outdatedPackagesProcessor.process(outdatedPackages);
+    logger.debug(`results=${JSON.stringify(results)}`);
+    const updatedPackages = results
+        .filter(({ updated }) => updated)
+        .map(({ outdatedPackage }) => outdatedPackage);
+    logger.debug(`updatedPackages=${JSON.stringify(updatedPackages)}`);
+    const skippedPackages = results
+        .filter(({ skipped }) => skipped)
+        .map(({ outdatedPackage }) => outdatedPackage);
+    logger.debug(`skippedPackages=${JSON.stringify(skippedPackages)}`);
+    logger.info(`${updatedPackages.length} packages has updated. ${skippedPackages.length} packages has skipped.`);
+};
+exports.main = main;