npm-update-package 0.1.0 → 0.4.0

package/.github/workflows/test.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [14.17.1]
+        node-version: [12.20.2]
     steps:
     - uses: actions/checkout@v2
     - name: Use Node.js ${{ matrix.node-version }}

package/FUNDING.yml

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

package/README.md

@@ -1,3 +1,4 @@
+[![npm version](https://badge.fury.io/js/npm-update-package.svg)](https://badge.fury.io/js/npm-update-package)
 [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
 
 # npm-update-package
@@ -36,8 +37,20 @@ 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}}`|
 |`--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`|
+
+### Templates
+
+npm-update-package is using [mustache](https://www.npmjs.com/package/mustache) for generating string from templates.
+These variables are available:
+
+- `--branch-name`
+  - `packageName`
+  - `currentVersion`
+  - `newVersion`
+  - `updateType`

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

package/dist/bin.js

@@ -1,17 +1,18 @@
 #!/usr/bin/env node
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const app_1 = require("./app");
 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.');
+logger.info(`Start ${app_1.app.name} v${app_1.app.version}`);
 (0, main_1.main)({
     options,
     logger
 })
-    .then(() => logger.info('End npm-update-package'))
+    .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);

package/dist/branch-name-creator/BranchNameCreator.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BranchNameCreator = void 0;
+const mustache_1 = require("mustache");
+class BranchNameCreator {
+    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.BranchNameCreator = BranchNameCreator;

package/dist/branch-name-creator/index.js

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

package/dist/main.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.main = void 0;
+const branch_name_creator_1 = require("./branch-name-creator");
 const git_1 = require("./git");
 const github_1 = require("./github");
 const ncu_1 = require("./ncu");
@@ -55,6 +56,7 @@ const main = async ({ options, logger }) => {
         githubRepo,
         logger
     });
+    const branchNameCreator = new branch_name_creator_1.BranchNameCreator(options.branchName);
     const outdatedPackageProcessor = new outdated_package_processor_1.OutdatedPackageProcessor({
         committer,
         git,
@@ -62,7 +64,8 @@ const main = async ({ options, logger }) => {
         packageManager,
         pullRequestCreator,
         remoteBranchExistenceChecker,
-        logger
+        logger,
+        branchNameCreator
     });
     const outdatedPackagesProcessor = new outdated_packages_processor_1.OutdatedPackagesProcessor({
         outdatedPackageProcessor,

package/dist/options/Options.js

@@ -4,6 +4,7 @@ exports.isOptions = exports.Options = void 0;
 const io_ts_1 = require("io-ts");
 exports.Options = (0, io_ts_1.intersection)([
     (0, io_ts_1.type)({
+        branchName: 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')])

package/dist/options/initOptions.js

@@ -3,20 +3,28 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.initOptions = void 0;
 const commander_1 = require("commander");
 const app_1 = require("../app");
+const enums_1 = require("../enums");
 const Options_1 = require("./Options");
 // TODO: add test
 const initOptions = () => {
     commander_1.program
         .version(app_1.app.version)
+        .option('--branch-name <value>', 'Branch name template', 'npm-update-package/{{{packageName}}}/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(['info', 'debug'])
-        .default('info'))
+        .choices([
+        enums_1.LogLevel.Info,
+        enums_1.LogLevel.Debug
+    ])
+        .default(enums_1.LogLevel.Info))
         .addOption(new commander_1.Option('--package-manager <value>', 'Package manager of your project')
-        .choices(['npm', 'yarn'])
-        .default('npm'));
+        .choices([
+        enums_1.PackageManagerName.Npm,
+        enums_1.PackageManagerName.Yarn
+    ])
+        .default(enums_1.PackageManagerName.Npm));
     commander_1.program.parse(process.argv);
     const options = commander_1.program.opts();
     if (!(0, Options_1.isOptions)(options)) {

package/dist/outdated-package-processor/OutdatedPackageProcessor.js

@@ -1,11 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OutdatedPackageProcessor = void 0;
-const createBranchName_1 = require("./createBranchName");
 const createCommitMessage_1 = require("./createCommitMessage");
 // TODO: add test
 class OutdatedPackageProcessor {
-    constructor({ committer, git, ncu, packageManager, pullRequestCreator, remoteBranchExistenceChecker, logger }) {
+    constructor({ committer, git, ncu, packageManager, pullRequestCreator, remoteBranchExistenceChecker, logger, branchNameCreator }) {
         this.committer = committer;
         this.git = git;
         this.ncu = ncu;
@@ -13,12 +12,13 @@ class OutdatedPackageProcessor {
         this.pullRequestCreator = pullRequestCreator;
         this.remoteBranchExistenceChecker = remoteBranchExistenceChecker;
         this.logger = logger;
+        this.branchNameCreator = branchNameCreator;
     }
     /**
      * Don't run in parallel because it includes file operations.
      */
     async process(outdatedPackage) {
-        const branchName = (0, createBranchName_1.createBranchName)(outdatedPackage);
+        const branchName = this.branchNameCreator.create(outdatedPackage);
         this.logger.debug(`branchName=${branchName}`);
         if (this.remoteBranchExistenceChecker.check(branchName)) {
             this.logger.info(`Skip ${outdatedPackage.name} because ${branchName} branch already exists on remote.`);

package/npm-update-package.code-workspace

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-update-package",
-  "version": "0.1.0",
+  "version": "0.4.0",
   "description": "CLI tool for creating pull request to update npm packages",
   "scripts": {
     "build": "tsc --project tsconfig.build.json",
@@ -19,6 +19,7 @@
     "fp-ts": "2.11.5",
     "io-ts": "2.2.16",
     "log4js": "6.3.0",
+    "mustache": "4.1.0",
     "npm-check-updates": "12.0.2",
     "parse-github-url": "1.0.2",
     "semver": "7.3.5"
@@ -27,6 +28,7 @@
     "@jest/types": "27.0.6",
     "@tsconfig/node12": "1.0.9",
     "@types/jest": "27.0.3",
+    "@types/mustache": "4.1.2",
     "@types/node": "12.20.15",
     "@types/parse-github-url": "1.0.0",
     "@types/semver": "7.3.9",
@@ -48,12 +50,12 @@
     "typescript": "4.4.4",
     "utility-types": "3.10.0"
   },
-  "homepage": "https://github.com/munierujp/npm-update-package",
+  "homepage": "https://github.com/npm-update-package/npm-update-package",
   "bugs": {
-    "url": "https://github.com/munierujp/npm-update-package/issues"
+    "url": "https://github.com/npm-update-package/npm-update-package/issues"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/munierujp/npm-update-package.git"
+    "url": "https://github.com/npm-update-package/npm-update-package.git"
   }
 }

package/src/app.ts

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

package/src/bin.ts

@@ -1,18 +1,19 @@
 #!/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 npm-update-package.')
+logger.info(`Start ${app.name} v${app.version}`)
 
 main({
   options,
   logger
 })
-  .then(() => logger.info('End npm-update-package'))
+  .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/branch-name-creator/BranchNameCreator.test.ts

@@ -0,0 +1,17 @@
+import { PackageVersion } from '../values'
+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/branch-name-creator/BranchNameCreator.ts

@@ -0,0 +1,19 @@
+import { render } from 'mustache'
+import type { OutdatedPackage } from '../types'
+
+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/branch-name-creator/index.ts

@@ -0,0 +1 @@
+export { BranchNameCreator } from './BranchNameCreator'

package/src/git/GitRepository.test.ts

@@ -4,12 +4,12 @@ describe('GitRepository', () => {
   describe('of', () => {
     describe('if URL is HTTPS', () => {
       describe('if URL is github.com', () => {
-        const url = 'https://github.com/munierujp/npm-update-package.git'
+        const url = 'https://github.com/npm-update-package/npm-update-package.git'
 
         it('returns new GitRepository instance', () => {
           const repo = GitRepository.of(url)
           expect(repo.host).toBe('github.com')
-          expect(repo.owner).toBe('munierujp')
+          expect(repo.owner).toBe('npm-update-package')
           expect(repo.name).toBe('npm-update-package')
           expect(repo.apiEndPoint).toBe('https://api.github.com')
           expect(repo.isGitHubDotCom).toBe(true)
@@ -17,12 +17,12 @@ describe('GitRepository', () => {
       })
 
       describe('if URL is not github.com', () => {
-        const url = 'https://git.example.com/munierujp/npm-update-package.git'
+        const url = 'https://git.example.com/npm-update-package/npm-update-package.git'
 
         it('returns new GitRepository instance', () => {
           const repo = GitRepository.of(url)
           expect(repo.host).toBe('git.example.com')
-          expect(repo.owner).toBe('munierujp')
+          expect(repo.owner).toBe('npm-update-package')
           expect(repo.name).toBe('npm-update-package')
           expect(repo.apiEndPoint).toBe('https://git.example.com/api/v3')
           expect(repo.isGitHubDotCom).toBe(false)
@@ -32,12 +32,12 @@ describe('GitRepository', () => {
 
     describe('if URL is SSH', () => {
       describe('if URL is github.com', () => {
-        const url = 'git@github.com:munierujp/npm-update-package.git'
+        const url = 'git@github.com:npm-update-package/npm-update-package.git'
 
         it('returns new GitRepository instance', () => {
           const repo = GitRepository.of(url)
           expect(repo.host).toBe('github.com')
-          expect(repo.owner).toBe('munierujp')
+          expect(repo.owner).toBe('npm-update-package')
           expect(repo.name).toBe('npm-update-package')
           expect(repo.apiEndPoint).toBe('https://api.github.com')
           expect(repo.isGitHubDotCom).toBe(true)
@@ -45,12 +45,12 @@ describe('GitRepository', () => {
       })
 
       describe('if URL is not github.com', () => {
-        const url = 'git@git.example.com:munierujp/npm-update-package.git'
+        const url = 'git@git.example.com:npm-update-package/npm-update-package.git'
 
         it('returns new GitRepository instance', () => {
           const repo = GitRepository.of(url)
           expect(repo.host).toBe('git.example.com')
-          expect(repo.owner).toBe('munierujp')
+          expect(repo.owner).toBe('npm-update-package')
           expect(repo.name).toBe('npm-update-package')
           expect(repo.apiEndPoint).toBe('https://git.example.com/api/v3')
           expect(repo.isGitHubDotCom).toBe(false)

package/src/github/createPullRequestBody.test.ts

@@ -18,7 +18,7 @@ describe('createPullRequestBody', () => {
 |[@typescript-eslint/eslint-plugin](https://www.npmjs.com/package/@typescript-eslint/eslint-plugin)|patch|\`1.0.0\`|\`1.0.1\`|
 
 ---
-This PR has been generated by [npm-update-package](https://github.com/munierujp/npm-update-package)`)
+This PR has been generated by [npm-update-package](https://github.com/npm-update-package/npm-update-package)`)
     })
   })
 
@@ -37,7 +37,7 @@ This PR has been generated by [npm-update-package](https://github.com/munierujp/
 |[@typescript-eslint/eslint-plugin](https://www.npmjs.com/package/@typescript-eslint/eslint-plugin)|minor|\`1.0.0\`|\`1.1.0\`|
 
 ---
-This PR has been generated by [npm-update-package](https://github.com/munierujp/npm-update-package)`)
+This PR has been generated by [npm-update-package](https://github.com/npm-update-package/npm-update-package)`)
     })
   })
 
@@ -56,7 +56,7 @@ This PR has been generated by [npm-update-package](https://github.com/munierujp/
 |[@typescript-eslint/eslint-plugin](https://www.npmjs.com/package/@typescript-eslint/eslint-plugin)|major|\`1.0.0\`|\`2.0.0\`|
 
 ---
-This PR has been generated by [npm-update-package](https://github.com/munierujp/npm-update-package)`)
+This PR has been generated by [npm-update-package](https://github.com/npm-update-package/npm-update-package)`)
     })
   })
 })

package/src/main.ts

@@ -1,3 +1,4 @@
+import { BranchNameCreator } from './branch-name-creator'
 import {
   Committer,
   Git
@@ -75,6 +76,7 @@ export const main = async ({
     githubRepo,
     logger
   })
+  const branchNameCreator = new BranchNameCreator(options.branchName)
   const outdatedPackageProcessor = new OutdatedPackageProcessor({
     committer,
     git,
@@ -82,7 +84,8 @@ export const main = async ({
     packageManager,
     pullRequestCreator,
     remoteBranchExistenceChecker,
-    logger
+    logger,
+    branchNameCreator
   })
   const outdatedPackagesProcessor = new OutdatedPackagesProcessor({
     outdatedPackageProcessor,

package/src/options/Options.ts

@@ -10,6 +10,7 @@ import type { TypeOf } from 'io-ts'
 
 export const Options = intersection([
   type({
+    branchName: string,
     githubToken: string,
     logLevel: union([literal('info'), literal('debug')]),
     packageManager: union([literal('npm'), literal('yarn')])

package/src/options/initOptions.ts

@@ -3,6 +3,10 @@ import {
   program
 } from 'commander'
 import { app } from '../app'
+import {
+  LogLevel,
+  PackageManagerName
+} from '../enums'
 import { isOptions } from './Options'
 import type { Options } from './Options'
 
@@ -10,18 +14,25 @@ import type { Options } from './Options'
 export const initOptions = (): Options => {
   program
     .version(app.version)
+    .option('--branch-name <value>', 'Branch name template', 'npm-update-package/{{{packageName}}}/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 Option('--log-level <value>', 'Log level to show')
-        .choices(['info', 'debug'])
-        .default('info')
+        .choices([
+          LogLevel.Info,
+          LogLevel.Debug
+        ])
+        .default(LogLevel.Info)
     )
     .addOption(
       new Option('--package-manager <value>', 'Package manager of your project')
-        .choices(['npm', 'yarn'])
-        .default('npm')
+        .choices([
+          PackageManagerName.Npm,
+          PackageManagerName.Yarn
+        ])
+        .default(PackageManagerName.Npm)
     )
   program.parse(process.argv)
   const options = program.opts()

package/src/outdated-package-processor/OutdatedPackageProcessor.ts

@@ -1,3 +1,4 @@
+import type { BranchNameCreator } from '../branch-name-creator'
 import type {
   Committer,
   Git
@@ -13,7 +14,6 @@ import type {
   OutdatedPackage,
   Result
 } from '../types'
-import { createBranchName } from './createBranchName'
 import { createCommitMessage } from './createCommitMessage'
 
 // TODO: add test
@@ -25,6 +25,7 @@ export class OutdatedPackageProcessor {
   private readonly pullRequestCreator: PullRequestCreator
   private readonly remoteBranchExistenceChecker: RemoteBranchExistenceChecker
   private readonly logger: Logger
+  private readonly branchNameCreator: BranchNameCreator
 
   constructor ({
     committer,
@@ -33,7 +34,8 @@ export class OutdatedPackageProcessor {
     packageManager,
     pullRequestCreator,
     remoteBranchExistenceChecker,
-    logger
+    logger,
+    branchNameCreator
   }: {
     committer: Committer
     git: Git
@@ -42,6 +44,7 @@ export class OutdatedPackageProcessor {
     pullRequestCreator: PullRequestCreator
     remoteBranchExistenceChecker: RemoteBranchExistenceChecker
     logger: Logger
+    branchNameCreator: BranchNameCreator
   }) {
     this.committer = committer
     this.git = git
@@ -50,13 +53,14 @@ export class OutdatedPackageProcessor {
     this.pullRequestCreator = pullRequestCreator
     this.remoteBranchExistenceChecker = remoteBranchExistenceChecker
     this.logger = logger
+    this.branchNameCreator = branchNameCreator
   }
 
   /**
    * Don't run in parallel because it includes file operations.
    */
   async process (outdatedPackage: OutdatedPackage): Promise<Result> {
-    const branchName = createBranchName(outdatedPackage)
+    const branchName = this.branchNameCreator.create(outdatedPackage)
     this.logger.debug(`branchName=${branchName}`)
 
     if (this.remoteBranchExistenceChecker.check(branchName)) {

package/dist/outdated-package-processor/createBranchName.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createBranchName = void 0;
-const createBranchName = (outdatedPackage) => {
-    const packageName = outdatedPackage.name;
-    const newVersion = outdatedPackage.newVersion.version;
-    return `npm-update-package/${packageName}/v${newVersion}`;
-};
-exports.createBranchName = createBranchName;

package/src/outdated-package-processor/createBranchName.test.ts

@@ -1,14 +0,0 @@
-import { PackageVersion } from '../values'
-import { createBranchName } from './createBranchName'
-
-describe('createBranchName', () => {
-  it('returns branch name', () => {
-    const actual = createBranchName({
-      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/v1.2.3')
-  })
-})

package/src/outdated-package-processor/createBranchName.ts

@@ -1,7 +0,0 @@
-import type { OutdatedPackage } from '../types'
-
-export const createBranchName = (outdatedPackage: OutdatedPackage): string => {
-  const packageName = outdatedPackage.name
-  const newVersion = outdatedPackage.newVersion.version
-  return `npm-update-package/${packageName}/v${newVersion}`
-}