@oneblink/release-cli 1.0.0-beta.2 → 1.1.1

package/dist/bin.js

@@ -1,10 +1,15 @@
-#!/usr/bin/env node
-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(`
+#!/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]
 
   next-version ..... The next version, will prompt for this if not supplied,
@@ -22,51 +27,51 @@ Examples
   oneblink-release 1.1.1
   oneblink-release 1.1.1 --cwd ../path/to/code
   oneblink-release 1.1.1-uat.1 --no-git
-`, {
-    flags: {
-        help: {
-            type: 'boolean',
-            default: false,
-            alias: 'h',
-        },
-        version: {
-            type: 'boolean',
-            default: false,
-            alias: 'v',
-        },
-        git: {
-            type: 'boolean',
-            default: true,
-        },
-        cwd: {
-            type: 'string',
-            default: process.cwd(),
-        },
-    },
-});
-updateNotifier({
-    // @ts-expect-error difference in types between packages
-    pkg: cli.pkg,
-}).notify();
-run().catch((error) => {
-    process.exitCode = 1;
-    console.error(error);
-});
-async function run() {
-    let input = cli.input[0];
-    if (!input) {
-        const { nextVersion } = await enquirer.prompt([
-            {
-                type: 'input',
-                message: 'Next version? e.g. "1.2.3" or "1.2.3-beta.1"',
-                name: 'nextVersion',
-            },
-        ]);
-        input = nextVersion;
-    }
-    await startReleaseProcess({
-        nextVersion: input,
-        git: cli.flags.git,
-        cwd: path.resolve(process.cwd(), cli.flags.cwd),
-    });
-}
+`, {
+    flags: {
+        help: {
+            type: 'boolean',
+            default: false,
+            alias: 'h',
+        },
+        version: {
+            type: 'boolean',
+            default: false,
+            alias: 'v',
+        },
+        git: {
+            type: 'boolean',
+            default: true,
+        },
+        cwd: {
+            type: 'string',
+            default: process.cwd(),
+        },
+    },
+});
+update_notifier_1.default({
+    // @ts-expect-error difference in types between packages
+    pkg: cli.pkg,
+}).notify();
+run().catch((error) => {
+    process.exitCode = 1;
+    console.error(error);
+});
+async function run() {
+    let input = cli.input[0];
+    if (!input) {
+        const { nextVersion } = await enquirer_1.default.prompt([
+            {
+                type: 'input',
+                message: 'Next version? e.g. "1.2.3" or "1.2.3-beta.1"',
+                name: 'nextVersion',
+            },
+        ]);
+        input = nextVersion;
+    }
+    await startReleaseProcess_1.default({
+        nextVersion: input,
+        git: cli.flags.git,
+        cwd: path_1.default.resolve(process.cwd(), cli.flags.cwd),
+    });
+}

package/dist/startReleaseProcess.js

@@ -1,110 +1,115 @@
-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 { readPackageUpAsync } 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(startText).start();
-    try {
-        const t = await fn(spinner);
-        if (spinner.isSpinning) {
-            spinner.stop();
-        }
-        return t;
-    }
-    catch (error) {
-        spinner.fail(failText);
-        throw error;
-    }
-}
-async function updateChangelog({ nextSemverVersion, cwd, }) {
-    const changelogPath = path.join(cwd, 'CHANGELOG.md');
-    const parsedChangelog = await wrapWithLoading({
-        startText: `Parsing ${changelogPath}`,
-        failText: `Failed to parsed ${changelogPath}`,
-    }, async (spinner) => {
-        const parsedChangelog = (await parseChangelog(changelogPath));
-        spinner.succeed(`Parsed ${changelogPath}`);
-        return parsedChangelog;
-    });
-    const dependenciesChangelogEntry = await wrapWithLoading({
-        startText: 'Checking if the "Dependencies" heading should be added to CHANGELOG.md',
-        failText: 'Failed to check if the "Dependencies" heading should be added to CHANGELOG.md',
-    }, async (spinner) => {
-        const unreleasedVersion = parsedChangelog.versions[UNRELEASED_VERSION_INDEX];
-        if (!unreleasedVersion ||
-            !unreleasedVersion.title.toLowerCase().includes('unreleased')) {
-            throw new Error('"Unreleased" heading in CHANGELOG.md does not exist');
-        }
-        const dependenciesChangelogHeading = '### Dependencies';
-        if (unreleasedVersion.body.includes(dependenciesChangelogHeading)) {
-            spinner.warn('Skipping inserting the "Dependencies" heading in CHANGELOG.md as it already exists under the "Unreleased" heading. It is recommended to allow this release process to insert instead of adding them as dependencies change.');
-            return '';
-        }
-        const lastVersion = parsedChangelog.versions[1];
-        if (!lastVersion) {
-            spinner.info('Skipping inserting the "Dependencies" heading in CHANGELOG.md as this is the first release according to the CHANGELOG.md.');
-            return '';
-        }
-        let dependenciesChangelogEntries = '';
-        const lastGitTag = `${GIT_TAG_PREFIX}${lastVersion.version}`;
-        try {
-            const result = await packageDiffSummary({
-                cwd,
-                previousVersion: lastGitTag,
-            });
-            dependenciesChangelogEntries = result.trim();
-        }
-        catch (error) {
-            if (error.message.includes(`git show ${lastGitTag}:package.json`)) {
-                spinner.warn(`Skipping inserting the "Dependencies" heading in CHANGELOG.md as it relies on the last release's git tag having a "v" prefix (i.e. "${lastGitTag}")`);
-                return '';
-            }
-            throw error;
-        }
-        if (!dependenciesChangelogEntries) {
-            spinner.info(`Skipping inserting the "Dependencies" heading in CHANGELOG.md as there were no dependency changes since the last release (${lastVersion.version})`);
-            return '';
-        }
-        spinner.succeed('"Dependencies" heading will be added to CHANGELOG.md');
+"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);
+const UNRELEASED_VERSION_INDEX = 0;
+const GIT_TAG_PREFIX = 'v';
+async function wrapWithLoading({ startText, failText }, fn) {
+    const spinner = ora_1.default(startText).start();
+    try {
+        const t = await fn(spinner);
+        if (spinner.isSpinning) {
+            spinner.stop();
+        }
+        return t;
+    }
+    catch (error) {
+        spinner.fail(failText);
+        throw error;
+    }
+}
+async function updateChangelog({ nextSemverVersion, cwd, }) {
+    const changelogPath = path_1.default.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));
+        spinner.succeed(`Parsed ${changelogPath}`);
+        return parsedChangelog;
+    });
+    const dependenciesChangelogEntry = await wrapWithLoading({
+        startText: 'Checking if the "Dependencies" heading should be added to CHANGELOG.md',
+        failText: 'Failed to check if the "Dependencies" heading should be added to CHANGELOG.md',
+    }, async (spinner) => {
+        const unreleasedVersion = parsedChangelog.versions[UNRELEASED_VERSION_INDEX];
+        if (!unreleasedVersion ||
+            !unreleasedVersion.title.toLowerCase().includes('unreleased')) {
+            throw new Error('"Unreleased" heading in CHANGELOG.md does not exist');
+        }
+        const dependenciesChangelogHeading = '### Dependencies';
+        if (unreleasedVersion.body.includes(dependenciesChangelogHeading)) {
+            spinner.warn('Skipping inserting the "Dependencies" heading in CHANGELOG.md as it already exists under the "Unreleased" heading. It is recommended to allow this release process to insert instead of adding them as dependencies change.');
+            return '';
+        }
+        const lastVersion = parsedChangelog.versions[1];
+        if (!lastVersion) {
+            spinner.info('Skipping inserting the "Dependencies" heading in CHANGELOG.md as this is the first release according to the CHANGELOG.md.');
+            return '';
+        }
+        let dependenciesChangelogEntries = '';
+        const lastGitTag = `${GIT_TAG_PREFIX}${lastVersion.version}`;
+        try {
+            const result = await package_diff_summary_1.main({
+                cwd,
+                previousVersion: lastGitTag,
+            });
+            dependenciesChangelogEntries = result.trim();
+        }
+        catch (error) {
+            if (error.message.includes(`git show ${lastGitTag}:package.json`)) {
+                spinner.warn(`Skipping inserting the "Dependencies" heading in CHANGELOG.md as it relies on the last release's git tag having a "v" prefix (i.e. "${lastGitTag}")`);
+                return '';
+            }
+            throw error;
+        }
+        if (!dependenciesChangelogEntries) {
+            spinner.info(`Skipping inserting the "Dependencies" heading in CHANGELOG.md as there were no dependency changes since the last release (${lastVersion.version})`);
+            return '';
+        }
+        spinner.succeed('"Dependencies" heading will be added to CHANGELOG.md');
         return `
 ${dependenciesChangelogHeading}
 
 ${dependenciesChangelogEntries}
-`;
-    });
-    const nextReleaseTitle = `[${nextSemverVersion}] - ${new Date()
-        .toISOString()
-        .substring(0, 10)}`;
-    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.join(cwd, '.prettierrc'), 'UTF-8');
-            prettierOptions = JSON.parse(s);
-        }
-        catch (error) {
-            // ignore errors attempting to find prettier configuration
-        }
-        const changelog = prettier.format(`
+`;
+    });
+    const nextReleaseTitle = `[${nextSemverVersion}] - ${new Date()
+        .toISOString()
+        .substring(0, 10)}`;
+    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');
+            prettierOptions = JSON.parse(s);
+        }
+        catch (error) {
+            // ignore errors attempting to find prettier configuration
+        }
+        const changelog = prettier_1.default.format(`
 # ${parsedChangelog.title}
 
 ${parsedChangelog.description || ''}
 
-${parsedChangelog.versions
-            .map(({ title, body }, index) => {
-            if (index === UNRELEASED_VERSION_INDEX) {
+${parsedChangelog.versions
+            .map(({ title, body }, index) => {
+            if (index === UNRELEASED_VERSION_INDEX) {
                 return `
 ## ${title}
 
@@ -113,73 +118,74 @@ ${parsedChangelog.versions
 ${body}
 
 ${dependenciesChangelogEntry}
-`;
-            }
+`;
+            }
             return `
 ## ${title}
 
 ${body}
-`;
-        })
-            .join('')}`, {
-            ...prettierOptions,
-            parser: 'markdown',
-        });
-        await writeFileAsync(changelogPath, changelog, 'UTF-8');
-        spinner.succeed(`Updated CHANGELOG.md with next release (${nextReleaseTitle})`);
-    });
-}
-async function checkIfNPMPackageVersionShouldBeUpdated(cwd) {
-    const result = await readPackageUpAsync({
-        cwd,
-    });
-    return !!result?.packageJson;
-}
-async function executeCommand(command, args, cwd) {
-    await wrapWithLoading({
-        startText: `Running "${command} ${args.join(' ')}"`,
-        failText: `Failed to run "${command} ${args.join(' ')}"`,
-    }, async (spinner) => {
-        await execa(command, args, {
-            cwd,
-        });
-        spinner.succeed(`Ran "${command} ${args.join(' ')}"`);
-    });
-}
-export default async function startReleaseProcess({ nextVersion, cwd, git, }) {
-    const nextSemverVersion = semver.valid(nextVersion);
-    if (!nextSemverVersion) {
-        throw new Error('Next version is not valid semver');
-    }
-    const npm = await checkIfNPMPackageVersionShouldBeUpdated(cwd);
-    const preReleaseComponents = semver.prerelease(nextSemverVersion);
-    if (preReleaseComponents && preReleaseComponents[0]) {
-        const text = `Skipping changelog updates for "${preReleaseComponents[0]}" release`;
-        ora(text).start().info(text);
-    }
-    else {
-        await updateChangelog({
-            nextSemverVersion,
-            cwd,
-        });
-    }
-    if (npm) {
-        await executeCommand('npm', ['version', nextSemverVersion, '--no-git-tag-version'], cwd);
-    }
-    if (!git) {
-        const text = `Skipping committing release changes using git`;
-        ora(text).start().info(text);
-        return;
-    }
-    await executeCommand('git', ['add', '-A'], cwd);
-    await executeCommand('git', ['commit', '--message', `[RELEASE] ${nextSemverVersion}`], cwd);
-    await executeCommand('git', ['push'], cwd);
-    await executeCommand('git', [
-        'tag',
-        '-a',
-        `${GIT_TAG_PREFIX}${nextSemverVersion}`,
-        '-m',
-        `[RELEASE] ${nextSemverVersion}`,
-    ], cwd);
-    await executeCommand('git', ['push', '--tags'], cwd);
-}
+`;
+        })
+            .join('')}`, {
+            ...prettierOptions,
+            parser: 'markdown',
+        });
+        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({
+        cwd,
+    });
+    return !!result?.packageJson;
+}
+async function executeCommand(command, args, cwd) {
+    await wrapWithLoading({
+        startText: `Running "${command} ${args.join(' ')}"`,
+        failText: `Failed to run "${command} ${args.join(' ')}"`,
+    }, async (spinner) => {
+        await execa_1.default(command, args, {
+            cwd,
+        });
+        spinner.succeed(`Ran "${command} ${args.join(' ')}"`);
+    });
+}
+async function startReleaseProcess({ nextVersion, cwd, git, }) {
+    const nextSemverVersion = semver_1.default.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);
+    if (preReleaseComponents && preReleaseComponents[0]) {
+        const text = `Skipping changelog updates for "${preReleaseComponents[0]}" release`;
+        ora_1.default(text).start().info(text);
+    }
+    else {
+        await updateChangelog({
+            nextSemverVersion,
+            cwd,
+        });
+    }
+    if (npm) {
+        await executeCommand('npm', ['version', nextSemverVersion, '--no-git-tag-version'], cwd);
+    }
+    if (!git) {
+        const text = `Skipping committing release changes using git`;
+        ora_1.default(text).start().info(text);
+        return;
+    }
+    await executeCommand('git', ['add', '-A'], cwd);
+    await executeCommand('git', ['commit', '--message', `[RELEASE] ${nextSemverVersion}`], cwd);
+    await executeCommand('git', ['push'], cwd);
+    await executeCommand('git', [
+        'tag',
+        '-a',
+        `${GIT_TAG_PREFIX}${nextSemverVersion}`,
+        '-m',
+        `[RELEASE] ${nextSemverVersion}`,
+    ], cwd);
+    await executeCommand('git', ['push', '--tags'], cwd);
+}
+exports.default = startReleaseProcess;

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.0.0-beta.2",
+  "version": "1.1.1",
   "author": "OneBlink <developers@oneblink> (https://github.com/oneblink)",
   "bin": {
     "oneblink-release": "dist/bin.js"
@@ -17,7 +17,7 @@
     "ora": "^5.4.0",
     "package-diff-summary": "^3.0.1",
     "prettier": "^2.2.1",
-    "read-pkg-up": "^8.0.0",
+    "read-pkg-up": "^7.0.1",
     "semver": "^7.3.5",
     "update-notifier": "^5.1.0"
   },
@@ -33,6 +33,7 @@
     "eslint-config-prettier": "^8.1.0",
     "eslint-plugin-prettier": "^3.3.1",
     "jest": "^26.6.3",
+    "patch-package": "^6.4.7",
     "ts-jest": "^26.5.4",
     "typescript": "^4.2.3"
   },
@@ -43,7 +44,6 @@
     "node": ">=14",
     "npm": ">=6"
   },
-  "exports": "./dist/startReleaseProcess.js",
   "files": [
     "dist"
   ],
@@ -52,6 +52,7 @@
     "release"
   ],
   "license": "GPL-3.0-only",
+  "main": "./dist/startReleaseProcess.js",
   "publishConfig": {
     "access": "public"
   },
@@ -65,7 +66,7 @@
     "jest": "jest --silent",
     "prepare": "npm run build",
     "pretest": "npm run eslint",
-    "test": "npm run jest"
-  },
-  "type": "module"
+    "test": "npm run jest",
+    "postinstall": "patch-package"
+  }
 }

package/CHANGELOG.md

@@ -1,10 +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]
-
-- Initial Release