@oneblink/release-cli 1.2.0 → 2.0.0-beta.1

package/dist/bin.js

@@ -1,22 +1,23 @@
 #!/usr/bin/env node
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const path_1 = __importDefault(require("path"));
-const update_notifier_1 = __importDefault(require("update-notifier"));
-const meow_1 = __importDefault(require("meow"));
-const enquirer_1 = __importDefault(require("enquirer"));
-const startReleaseProcess_1 = __importDefault(require("./startReleaseProcess"));
-const cli = meow_1.default(`
-oneblink-release [next-version] [--no-git] [--cwd path]
+import path from 'path';
+import updateNotifier from 'update-notifier';
+import meow from 'meow';
+import enquirer from 'enquirer';
+import startReleaseProcess from './startReleaseProcess.js';
+const cli = meow(`
+oneblink-release [next-version] [--no-git] [--name] [--no-name] [--cwd path]
 
   next-version ..... The next version, will prompt for this if not supplied,
                      must be a valid semver number.
 
     --no-git ....... Skip committing changes and creating an annotated git tag.
 
+    --name ......... Skip the question to enter a name for the release by passing
+                     a release name as a flag.
+
+    --no-name ...... Skip the question to enter a name for the release. Use
+                     option when running a release for an open source repository.
+
     --cwd .......... Directory of the code base to release relative to the
                      current working directory, defaults to the current
                      working directory.
@@ -24,10 +25,13 @@ oneblink-release [next-version] [--no-git] [--cwd path]
 Examples
 
   oneblink-release
+  oneblink-release --no-name
+  oneblink-release --name="Inappropriate Release Name"
   oneblink-release 1.1.1
   oneblink-release 1.1.1 --cwd ../path/to/code
   oneblink-release 1.1.1-uat.1 --no-git
 `, {
+    importMeta: import.meta,
     flags: {
         help: {
             type: 'boolean',
@@ -43,13 +47,32 @@ Examples
             type: 'boolean',
             default: true,
         },
+        name: {
+            type: 'string',
+        },
         cwd: {
             type: 'string',
             default: process.cwd(),
         },
     },
 });
-update_notifier_1.default({
+async function getReleaseName(name) {
+    if (typeof name === 'string' && name) {
+        return name;
+    }
+    if (typeof name === 'boolean' && !name) {
+        return undefined;
+    }
+    const { releaseName } = await enquirer.prompt([
+        {
+            type: 'input',
+            message: 'Release name? i.e. JIRA release',
+            name: 'releaseName',
+        },
+    ]);
+    return releaseName;
+}
+updateNotifier({
     // @ts-expect-error difference in types between packages
     pkg: cli.pkg,
 }).notify();
@@ -60,7 +83,7 @@ run().catch((error) => {
 async function run() {
     let input = cli.input[0];
     if (!input) {
-        const { nextVersion } = await enquirer_1.default.prompt([
+        const { nextVersion } = await enquirer.prompt([
             {
                 type: 'input',
                 message: 'Next version? e.g. "1.2.3" or "1.2.3-beta.1"',
@@ -69,9 +92,11 @@ async function run() {
         ]);
         input = nextVersion;
     }
-    await startReleaseProcess_1.default({
+    const releaseName = await getReleaseName(cli.flags.name);
+    await startReleaseProcess({
         nextVersion: input,
         git: cli.flags.git,
-        cwd: path_1.default.resolve(process.cwd(), cli.flags.cwd),
+        releaseName,
+        cwd: path.resolve(process.cwd(), cli.flags.cwd),
     });
 }

package/dist/startReleaseProcess.js

@@ -1,24 +1,19 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
-const util_1 = __importDefault(require("util"));
-const execa_1 = __importDefault(require("execa"));
-const prettier_1 = __importDefault(require("prettier"));
-const changelog_parser_1 = __importDefault(require("changelog-parser"));
-const package_diff_summary_1 = require("package-diff-summary");
-const semver_1 = __importDefault(require("semver"));
-const ora_1 = __importDefault(require("ora"));
-const read_pkg_up_1 = __importDefault(require("read-pkg-up"));
-const readFileAsync = util_1.default.promisify(fs_1.default.readFile);
-const writeFileAsync = util_1.default.promisify(fs_1.default.writeFile);
+import fs from 'fs';
+import path from 'path';
+import util from 'util';
+import { execa } from 'execa';
+import prettier from 'prettier';
+import parseChangelog from 'changelog-parser';
+import { main as packageDiffSummary } from 'package-diff-summary';
+import semver from 'semver';
+import ora from 'ora';
+import { readPackageUp } from 'read-pkg-up';
+const readFileAsync = util.promisify(fs.readFile);
+const writeFileAsync = util.promisify(fs.writeFile);
 const UNRELEASED_VERSION_INDEX = 0;
 const GIT_TAG_PREFIX = 'v';
 async function wrapWithLoading({ startText, failText }, fn) {
-    const spinner = ora_1.default(startText).start();
+    const spinner = ora(startText).start();
     try {
         const t = await fn(spinner);
         if (spinner.isSpinning) {
@@ -31,13 +26,13 @@ async function wrapWithLoading({ startText, failText }, fn) {
         throw error;
     }
 }
-async function updateChangelog({ nextSemverVersion, cwd, }) {
-    const changelogPath = path_1.default.join(cwd, 'CHANGELOG.md');
+async function updateChangelog({ nextSemverVersion, cwd, releaseName, }) {
+    const changelogPath = path.join(cwd, 'CHANGELOG.md');
     const parsedChangelog = await wrapWithLoading({
         startText: `Parsing ${changelogPath}`,
         failText: `Failed to parsed ${changelogPath}`,
     }, async (spinner) => {
-        const parsedChangelog = (await changelog_parser_1.default(changelogPath));
+        const parsedChangelog = (await parseChangelog(changelogPath));
         spinner.succeed(`Parsed ${changelogPath}`);
         return parsedChangelog;
     });
@@ -63,7 +58,7 @@ async function updateChangelog({ nextSemverVersion, cwd, }) {
         let dependenciesChangelogEntries = '';
         const lastGitTag = `${GIT_TAG_PREFIX}${lastVersion.version}`;
         try {
-            const result = await package_diff_summary_1.main({
+            const result = await packageDiffSummary({
                 cwd,
                 previousVersion: lastGitTag,
             });
@@ -87,22 +82,22 @@ ${dependenciesChangelogHeading}
 ${dependenciesChangelogEntries}
 `;
     });
-    const nextReleaseTitle = `[${nextSemverVersion}] - ${new Date()
+    const nextReleaseTitle = `[${nextSemverVersion}] (${new Date()
         .toISOString()
-        .substring(0, 10)}`;
+        .substring(0, 10)})${releaseName ? ` ${releaseName}` : ''}`;
     await wrapWithLoading({
         startText: `Updating CHANGELOG.md with next release (${nextReleaseTitle})`,
         failText: `Failed to update CHANGELOG.md with next release (${nextReleaseTitle})`,
     }, async (spinner) => {
         let prettierOptions = {};
         try {
-            const s = await readFileAsync(path_1.default.join(cwd, '.prettierrc'), 'UTF-8');
+            const s = await readFileAsync(path.join(cwd, '.prettierrc'), 'utf-8');
             prettierOptions = JSON.parse(s);
         }
         catch (error) {
             // ignore errors attempting to find prettier configuration
         }
-        const changelog = prettier_1.default.format(`
+        const changelog = prettier.format(`
 # ${parsedChangelog.title}
 
 ${parsedChangelog.description || ''}
@@ -130,12 +125,12 @@ ${body}
             ...prettierOptions,
             parser: 'markdown',
         });
-        await writeFileAsync(changelogPath, changelog, 'UTF-8');
+        await writeFileAsync(changelogPath, changelog, 'utf-8');
         spinner.succeed(`Updated CHANGELOG.md with next release (${nextReleaseTitle})`);
     });
 }
 async function checkIfNPMPackageVersionShouldBeUpdated(cwd) {
-    const result = await read_pkg_up_1.default({
+    const result = await readPackageUp({
         cwd,
     });
     return !!result?.packageJson;
@@ -145,27 +140,28 @@ async function executeCommand(command, args, cwd) {
         startText: `Running "${command} ${args.join(' ')}"`,
         failText: `Failed to run "${command} ${args.join(' ')}"`,
     }, async (spinner) => {
-        await execa_1.default(command, args, {
+        await execa(command, args, {
             cwd,
         });
         spinner.succeed(`Ran "${command} ${args.join(' ')}"`);
     });
 }
-async function startReleaseProcess({ nextVersion, cwd, git, }) {
-    const nextSemverVersion = semver_1.default.valid(nextVersion);
+export default async function startReleaseProcess({ nextVersion, cwd, git, releaseName, }) {
+    const nextSemverVersion = semver.valid(nextVersion);
     if (!nextSemverVersion) {
         throw new Error('Next version is not valid semver');
     }
     const npm = await checkIfNPMPackageVersionShouldBeUpdated(cwd);
-    const preReleaseComponents = semver_1.default.prerelease(nextSemverVersion);
+    const preReleaseComponents = semver.prerelease(nextSemverVersion);
     if (preReleaseComponents && preReleaseComponents[0]) {
         const text = `Skipping changelog updates for "${preReleaseComponents[0]}" release`;
-        ora_1.default(text).start().info(text);
+        ora(text).start().info(text);
     }
     else {
         await updateChangelog({
             nextSemverVersion,
             cwd,
+            releaseName,
         });
     }
     if (npm) {
@@ -173,7 +169,7 @@ async function startReleaseProcess({ nextVersion, cwd, git, }) {
     }
     if (!git) {
         const text = `Skipping committing release changes using git`;
-        ora_1.default(text).start().info(text);
+        ora(text).start().info(text);
         return;
     }
     await executeCommand('git', ['add', '-A'], cwd);
@@ -188,4 +184,3 @@ async function startReleaseProcess({ nextVersion, cwd, git, }) {
     ], cwd);
     await executeCommand('git', ['push', '--tags'], cwd);
 }
-exports.default = startReleaseProcess;

package/node_modules/changelog-parser/package.json

@@ -47,8 +47,4 @@
     "release": "gh-release && npm publish",
     "test": "standard && node test | tap-spec"
   }
-
-,"_resolved": "https://registry.npmjs.org/changelog-parser/-/changelog-parser-2.8.0.tgz"
-,"_integrity": "sha512-ZtSwN0hY7t+WpvaXqqXz98RHCNhWX9HsvCRAv1aBLlqJ7BpKtqdM6Nu6JOiUhRAWR7Gov0aN0fUnmflTz0WgZg=="
-,"_from": "changelog-parser@2.8.0"
-}
+}

package/node_modules/line-reader/package.json

@@ -11,8 +11,4 @@
     "type": "git",
     "url": "https://nickewing@github.com/nickewing/line-reader.git"
   }
-
-,"_resolved": "https://registry.npmjs.org/line-reader/-/line-reader-0.2.4.tgz"
-,"_integrity": "sha1-xDkrWH3qOFgMlnhXDm6OSfzlJiI="
-,"_from": "line-reader@0.2.4"
-}
+}

package/node_modules/remove-markdown/package.json

@@ -24,8 +24,4 @@
     "mocha": "^2.1.0",
     "should": "^5.0.0"
   }
-
-,"_resolved": "https://registry.npmjs.org/remove-markdown/-/remove-markdown-0.2.2.tgz"
-,"_integrity": "sha1-ZrDO66n7d8qWNrsbAwfOIaMqEqY="
-,"_from": "remove-markdown@0.2.2"
-}
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oneblink/release-cli",
   "description": "Used internally by OneBlink to release code bases quickly and consistently",
-  "version": "1.2.0",
+  "version": "2.0.0-beta.1",
   "author": "OneBlink <developers@oneblink> (https://github.com/oneblink)",
   "bin": {
     "oneblink-release": "dist/bin.js"
@@ -12,40 +12,41 @@
   "dependencies": {
     "changelog-parser": "^2.8.0",
     "enquirer": "^2.3.6",
-    "execa": "^5.0.0",
-    "meow": "^9.0.0",
-    "ora": "^5.4.0",
+    "execa": "^7.1.1",
+    "meow": "^11.0.0",
+    "ora": "^6.3.0",
     "package-diff-summary": "^3.0.1",
-    "patch-package": "^6.4.7",
-    "prettier": "^2.2.1",
-    "read-pkg-up": "^7.0.1",
-    "semver": "^7.3.5",
-    "update-notifier": "^5.1.0"
+    "patch-package": "^6.5.1",
+    "prettier": "^2.8.7",
+    "read-pkg-up": "^9.1.0",
+    "semver": "^7.3.8",
+    "update-notifier": "^6.0.2"
   },
   "bundleDependencies": [
     "changelog-parser"
   ],
   "devDependencies": {
-    "@types/changelog-parser": "^2.7.1",
-    "@types/jest": "^26.0.22",
-    "@types/node": "^14.14.41",
-    "@types/semver": "^7.3.4",
-    "@types/update-notifier": "^5.0.0",
-    "@typescript-eslint/eslint-plugin": "^4.22.0",
-    "@typescript-eslint/parser": "^4.22.0",
-    "eslint": "^7.23.0",
-    "eslint-config-prettier": "^8.1.0",
-    "eslint-plugin-prettier": "^3.3.1",
-    "jest": "^26.6.3",
-    "ts-jest": "^26.5.4",
-    "typescript": "^4.2.3"
+    "@types/changelog-parser": "^2.8.1",
+    "@types/jest": "^29.5.0",
+    "@types/node": "^18.15.11",
+    "@types/semver": "^7.3.13",
+    "@types/update-notifier": "^6.0.2",
+    "@typescript-eslint/eslint-plugin": "^5.57.0",
+    "@typescript-eslint/parser": "^5.57.0",
+    "cross-env": "^7.0.3",
+    "eslint": "^8.37.0",
+    "eslint-config-prettier": "^8.8.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "jest": "^29.5.0",
+    "ts-jest": "^29.1.0",
+    "typescript": "^5.0.3"
   },
   "directories": {
     "test": "test"
   },
   "engines": {
-    "node": ">=14",
-    "npm": ">=6"
+    "node": ">=18",
+    "npm": ">=8"
   },
   "files": [
     "dist",
@@ -67,10 +68,11 @@
   "scripts": {
     "build": "tsc --build",
     "eslint": "eslint --fix --cache --quiet ./src",
-    "jest": "jest --silent",
+    "jest": "cross-env NODE_OPTIONS=--experimental-vm-modules jest --silent",
     "prepare": "npm run build",
     "pretest": "npm run eslint",
     "test": "npm run jest",
     "postinstall": "patch-package"
-  }
+  },
+  "type": "module"
 }

package/CHANGELOG.md

@@ -1,28 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [Unreleased]
-
-### Moved
-
-`patch-package` to deps
-
-### Added
-
-`patches` dir to `files` in `package.json` file
-
-## [1.1.0] - 2022-08-26
-
-### Patched
-
-- `changelog-parser` to use `\n` as line endings instead of detecting based on platform
-
-## [1.0.0] - 2021-04-21
-
-### Added
-
-- Initial Release