npm-update-package 0.6.1 → 0.9.1

package/README.md

@@ -5,6 +5,10 @@
 
 CLI tool for creating pull request to update npm packages
 
+## Caution
+
+This package is currently under development, so the major version is 0 yet.
+
 ## Installation
 
 If you are using npm:
@@ -33,30 +37,112 @@ npm-update-package --github-token $GITHUB_TOKEN
 
 ## Options
 
-You can customize behavior via command-line options.
-
-|Option|Description|Required|Value|Default|
-|---|---|---|---|---|
-|`--branch-name`|Branch name template|-|string|`npm-update-package/{{{packageName}}}/v{{newVersion}}`|
-|`--commit-message`|Commit message template|-|string|`chore(deps): {{updateType}} update {{{packageName}}} to v{{newVersion}}`|
-|`--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`|
+You can customize behavior via command-line options.  
+Template strings such as `--branch-name` can embed variables like `{{packageName}}`(HTML-escaped) or `{{{packageName}}}`(not HTML-escaped).
 
-### Templates
+### `--branch-name`
 
-npm-update-package is using [mustache](https://www.npmjs.com/package/mustache) for generating string from templates.
-These variables are available:
+Branch name template
 
-- `--branch-name`
+- value: template string
+- embeddable variables:
+  - `currentVersion`
+  - `newVersion`
   - `packageName`
+  - `updateType`
+- required: false
+- default: `npm-update-package/{{{packageName}}}/v{{newVersion}}`
+
+### `--commit-message`
+
+Commit message template
+
+- value: template string
+- embeddable variables:
   - `currentVersion`
   - `newVersion`
+  - `packageName`
   - `updateType`
-- `--commit-message`
+- 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
+
+- value: string
+- required: true
+
+### `--log-level`
+
+Log level to show
+
+- value: string
+  - `info`
+  - `debug`
+- required: false
+- default: `info`
+
+### `--package-manager`
+
+Package manager of your project
+
+- value: string
+  - `npm`
+  - `yarn`
+- required: false
+- default: `npm`
+
+### `--pull-request-body`
+
+Pull request body template
+
+- value: template string
+- embeddable variables:
+  - `appName`
+  - `appVersion`
+  - `appWeb`
+  - `currentVersion`
+  - `newVersion`
   - `packageName`
+  - `updateType`
+- 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}}
+```
+
+### `--pull-request-title`
+
+Pull request title template
+
+- value: template string
+- embeddable variables:
   - `currentVersion`
   - `newVersion`
+  - `packageName`
   - `updateType`
+- required: false
+- default: `chore(deps): {{updateType}} update {{{packageName}}} to v{{newVersion}}`

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

package/dist/github/PullRequestBodyCreator.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PullRequestBodyCreator = void 0;
+const mustache_1 = require("mustache");
+const app_1 = require("../app");
+class PullRequestBodyCreator {
+    constructor(template) {
+        this.template = template;
+    }
+    create(outdatedPackage) {
+        const appName = app_1.app.name;
+        const appVersion = app_1.app.version;
+        const appWeb = app_1.app.web;
+        const currentVersion = outdatedPackage.currentVersion.version;
+        const newVersion = outdatedPackage.newVersion.version;
+        const packageName = outdatedPackage.name;
+        const updateType = outdatedPackage.type;
+        return (0, mustache_1.render)(this.template, {
+            appName,
+            appVersion,
+            appWeb,
+            currentVersion,
+            newVersion,
+            packageName,
+            updateType
+        });
+    }
+}
+exports.PullRequestBodyCreator = PullRequestBodyCreator;

package/dist/github/PullRequestCreator.js

@@ -1,20 +1,20 @@
 "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 }) {
+    constructor({ github, gitRepo, githubRepo, pullRequestTitleCreator, pullRequestBodyCreator, logger }) {
         this.github = github;
         this.gitRepo = gitRepo;
         this.githubRepo = githubRepo;
+        this.pullRequestTitleCreator = pullRequestTitleCreator;
+        this.pullRequestBodyCreator = pullRequestBodyCreator;
         this.logger = logger;
     }
     async create({ outdatedPackage, branchName }) {
-        const title = (0, createPullRequestTitle_1.createPullRequestTitle)(outdatedPackage);
+        const title = this.pullRequestTitleCreator.create(outdatedPackage);
         this.logger.debug(`title=${title}`);
-        const body = (0, createPullRequestBody_1.createPullRequestBody)(outdatedPackage);
+        const body = this.pullRequestBodyCreator.create(outdatedPackage);
         this.logger.debug(`body=${body}`);
         const createdPullRequest = await this.github.createPullRequest({
             owner: this.gitRepo.owner,

package/dist/github/PullRequestTitleCreator.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PullRequestTitleCreator = void 0;
+const mustache_1 = require("mustache");
+class PullRequestTitleCreator {
+    constructor(template) {
+        this.template = template;
+    }
+    create(outdatedPackage) {
+        const packageName = outdatedPackage.name;
+        const currentVersion = outdatedPackage.currentVersion.version;
+        const newVersion = outdatedPackage.newVersion.version;
+        const updateType = outdatedPackage.type;
+        return (0, mustache_1.render)(this.template, {
+            packageName,
+            currentVersion,
+            newVersion,
+            updateType
+        });
+    }
+}
+exports.PullRequestTitleCreator = PullRequestTitleCreator;

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/github/index.js

@@ -1,11 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RemoteBranchExistenceChecker = exports.PullRequestCreator = exports.GitHub = exports.createGitHub = void 0;
+exports.RemoteBranchExistenceChecker = exports.PullRequestTitleCreator = exports.PullRequestCreator = exports.PullRequestBodyCreator = 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 PullRequestBodyCreator_1 = require("./PullRequestBodyCreator");
+Object.defineProperty(exports, "PullRequestBodyCreator", { enumerable: true, get: function () { return PullRequestBodyCreator_1.PullRequestBodyCreator; } });
 var PullRequestCreator_1 = require("./PullRequestCreator");
 Object.defineProperty(exports, "PullRequestCreator", { enumerable: true, get: function () { return PullRequestCreator_1.PullRequestCreator; } });
+var PullRequestTitleCreator_1 = require("./PullRequestTitleCreator");
+Object.defineProperty(exports, "PullRequestTitleCreator", { enumerable: true, get: function () { return PullRequestTitleCreator_1.PullRequestTitleCreator; } });
 var RemoteBranchExistenceChecker_1 = require("./RemoteBranchExistenceChecker");
 Object.defineProperty(exports, "RemoteBranchExistenceChecker", { enumerable: true, get: function () { return RemoteBranchExistenceChecker_1.RemoteBranchExistenceChecker; } });

package/dist/main.js

@@ -54,10 +54,14 @@ const main = async ({ options, logger }) => {
         terminal,
         packageManager: options.packageManager
     });
+    const pullRequestTitleCreator = new github_1.PullRequestTitleCreator(options.pullRequestTitle);
+    const pullRequestBodyCreator = new github_1.PullRequestBodyCreator(options.pullRequestBody);
     const pullRequestCreator = new github_1.PullRequestCreator({
         github,
         gitRepo,
         githubRepo,
+        pullRequestTitleCreator,
+        pullRequestBodyCreator,
         logger
     });
     const branchNameCreator = new git_1.BranchNameCreator(options.branchName);

package/dist/options/Options.js

@@ -2,13 +2,17 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 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)('info'), (0, io_ts_1.literal)('debug')]),
-        packageManager: (0, io_ts_1.union)([(0, io_ts_1.literal)('npm'), (0, io_ts_1.literal)('yarn')])
+        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,

package/dist/options/initOptions.js

@@ -26,7 +26,16 @@ const initOptions = () => {
         package_manager_1.PackageManagerName.Npm,
         package_manager_1.PackageManagerName.Yarn
     ])
-        .default(package_manager_1.PackageManagerName.Npm));
+        .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.parse(process.argv);
     const options = commander_1.program.opts();
     if (!(0, Options_1.isOptions)(options)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-update-package",
-  "version": "0.6.1",
+  "version": "0.9.1",
   "description": "CLI tool for creating pull request to update npm packages",
   "scripts": {
     "build": "tsc --project tsconfig.build.json",
@@ -11,6 +11,9 @@
     "start": "ts-node src/bin.ts",
     "test": "jest --passWithNoTests"
   },
+  "files": [
+    "dist"
+  ],
   "bin": "dist/bin.js",
   "dependencies": {
     "@octokit/rest": "18.12.0",
@@ -32,7 +35,7 @@
     "@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",
@@ -50,12 +53,13 @@
     "typescript": "4.4.4",
     "utility-types": "3.10.0"
   },
-  "homepage": "https://github.com/npm-update-package/npm-update-package",
-  "bugs": {
-    "url": "https://github.com/npm-update-package/npm-update-package/issues"
-  },
   "repository": {
     "type": "git",
     "url": "https://github.com/npm-update-package/npm-update-package.git"
-  }
+  },
+  "bugs": {
+    "url": "https://github.com/npm-update-package/npm-update-package/issues"
+  },
+  "homepage": "https://github.com/npm-update-package/npm-update-package",
+  "license": "MIT"
 }

package/.eslintignore

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

package/.eslintrc.js

@@ -1,23 +0,0 @@
-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/FUNDING.yml

@@ -1,2 +0,0 @@
-github: munierujp
-custom: ["https://www.paypal.me/munieru"]

package/.github/renovate.json

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

package/.github/workflows/eslint.yml

@@ -1,14 +0,0 @@
-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

@@ -1,19 +0,0 @@
-name: test
-on:
-  pull_request:
-    branches: [ master ]
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node-version: [12.20.2]
-    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

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

package/.nvmrc

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

package/dist/github/createPullRequestBody.js

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

@@ -1,10 +0,0 @@
-"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/jest.config.ts

@@ -1,11 +0,0 @@
-import type { Config } from '@jest/types'
-
-const config: Config.InitialOptions = {
-  preset: 'ts-jest',
-  collectCoverage: true,
-  collectCoverageFrom: [
-    'src/**/*.ts'
-  ]
-}
-
-export default config

package/lint-staged.config.js

@@ -1,4 +0,0 @@
-module.exports = {
-  '*.js': 'eslint',
-  '*.ts': 'eslint'
-}

package/npm-update-package.code-workspace

@@ -1,8 +0,0 @@
-{
-	"folders": [
-		{
-			"path": "."
-		}
-	],
-	"settings": {}
-}

package/src/app.ts

@@ -1,5 +0,0 @@
-export const app = {
-  name: 'npm-update-package',
-  version: '0.6.1',
-  web: 'https://github.com/npm-update-package/npm-update-package'
-} as const

package/src/bin.ts

@@ -1,20 +0,0 @@
-#!/usr/bin/env node
-
-import { app } from './app'
-import { createLogger } from './logger'
-import { main } from './main'
-import { initOptions } from './options'
-
-const options = initOptions()
-const logger = createLogger(options.logLevel)
-logger.info(`Start ${app.name} v${app.version}`)
-
-main({
-  options,
-  logger
-})
-  .then(() => logger.info(`End ${app.name} v${app.version}`))
-  .catch((e: unknown) => {
-    // TODO: improve error handling
-    logger.fatal('Unexpected error has occurred.', e)
-  })

package/src/git/BranchNameCreator.test.ts

@@ -1,17 +0,0 @@
-import { PackageVersion } from '../ncu'
-import { BranchNameCreator } from './BranchNameCreator'
-
-describe('BranchNameCreator', () => {
-  describe('create', () => {
-    it('returns branch name', () => {
-      const branchNameCreator = new BranchNameCreator('npm-update-package/{{{packageName}}}/{{updateType}}/{{currentVersion}}/{{newVersion}}')
-      const actual = branchNameCreator.create({
-        name: '@typescript-eslint/eslint-plugin',
-        currentVersion: PackageVersion.of('1.0.0'),
-        newVersion: PackageVersion.of('1.2.3'),
-        type: 'major'
-      })
-      expect(actual).toBe('npm-update-package/@typescript-eslint/eslint-plugin/major/1.0.0/1.2.3')
-    })
-  })
-})

package/src/git/BranchNameCreator.ts

@@ -1,19 +0,0 @@
-import { render } from 'mustache'
-import type { OutdatedPackage } from '../ncu'
-
-export class BranchNameCreator {
-  constructor (private readonly template: string) {}
-
-  create (outdatedPackage: OutdatedPackage): string {
-    const packageName = outdatedPackage.name
-    const currentVersion = outdatedPackage.currentVersion.version
-    const newVersion = outdatedPackage.newVersion.version
-    const updateType = outdatedPackage.type
-    return render(this.template, {
-      packageName,
-      currentVersion,
-      newVersion,
-      updateType
-    })
-  }
-}

package/src/git/CommitMessageCreator.test.ts

@@ -1,17 +0,0 @@
-import { PackageVersion } from '../ncu'
-import { CommitMessageCreator } from './CommitMessageCreator'
-
-describe('CommitMessageCreator', () => {
-  describe('create', () => {
-    it('returns commit message', () => {
-      const commitMessageCreator = new CommitMessageCreator('chore(deps): {{updateType}} update {{{packageName}}} from {{currentVersion}} to v{{newVersion}}')
-      const actual = commitMessageCreator.create({
-        name: '@typescript-eslint/eslint-plugin',
-        currentVersion: PackageVersion.of('1.0.0'),
-        newVersion: PackageVersion.of('2.0.0'),
-        type: 'major'
-      })
-      expect(actual).toBe('chore(deps): major update @typescript-eslint/eslint-plugin from 1.0.0 to v2.0.0')
-    })
-  })
-})

package/src/git/CommitMessageCreator.ts

@@ -1,19 +0,0 @@
-import { render } from 'mustache'
-import type { OutdatedPackage } from '../ncu'
-
-export class CommitMessageCreator {
-  constructor (private readonly template: string) {}
-
-  create (outdatedPackage: OutdatedPackage): string {
-    const packageName = outdatedPackage.name
-    const currentVersion = outdatedPackage.currentVersion.version
-    const newVersion = outdatedPackage.newVersion.version
-    const updateType = outdatedPackage.type
-    return render(this.template, {
-      packageName,
-      currentVersion,
-      newVersion,
-      updateType
-    })
-  }
-}

package/src/git/Committer.ts

@@ -1,49 +0,0 @@
-import type { Git } from './Git'
-
-export interface User {
-  name?: string
-  email?: string
-}
-
-// TODO: add test
-export class Committer {
-  private readonly git: Git
-  private readonly user: User | undefined
-
-  constructor ({
-    git,
-    user
-  }: {
-    git: Git
-    user?: User
-  }) {
-    this.git = git
-    this.user = user
-  }
-
-  async commit (message: string): Promise<void> {
-    let name: string | undefined
-
-    if (this.user?.name !== undefined) {
-      name = await this.git.getConfig('user.name')
-      await this.git.setConfig('user.name', this.user.name)
-    }
-
-    let email: string | undefined
-
-    if (this.user?.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)
-    }
-  }
-}