@oneblink/release-cli 2.1.0 → 2.1.1

package/dist/package-diff-summary/diff.js

@@ -0,0 +1,78 @@
+import os from 'os';
+import depDiff from 'dependency-diff';
+import semver from 'semver';
+import * as npm from './npm.js';
+// http://semver.org/#spec-item-9
+// 1.0.0, 1.0.0-foo1, 1.0.0-foo1.blah2, 1.0.0-foo1.blah2.abc3, ...
+const VERSION_REGEXP = /\d+\.\d+\.\d+(?:-[0-9A-Za-z-]+(?:\.[0-9A-Za-z-]+)*)?/;
+function lineForDelete(nameMd) {
+    return `-   no longer depend upon ${nameMd}`;
+}
+function lineForNew(nameMd, versionMd) {
+    return `-   depend upon ${nameMd} ${versionMd}`;
+}
+function lineForRollback(nameMd, versionMd, oldVersionMd) {
+    return `-   rollback ${nameMd} to ${versionMd} (from ${oldVersionMd})`;
+}
+function lineForUpdate(nameMd, versionMd, oldVersionMd) {
+    return `-   update ${nameMd} to ${versionMd} (from ${oldVersionMd})`;
+}
+// strips any sloppy / range characters, e.g. ^ or >=
+function strictVersion(version) {
+    const [versionNumbers] = version.match(VERSION_REGEXP) || [];
+    return versionNumbers || '';
+}
+function versionToMarkdown(version, // assumed strict, no sloppy / range, etc
+changelogUrl) {
+    if (changelogUrl) {
+        return `[${version}](${changelogUrl})`;
+    }
+    return version;
+}
+function wrapWithEol(text) {
+    return os.EOL + text + os.EOL;
+}
+function deltaToMarkdown(diff, oldPkg, cwd) {
+    const oldDependencies = oldPkg.dependencies || {};
+    const depDeltas = diff.dependencies || [];
+    // serial iteration with Promises
+    return depDeltas.reduce((promise, depDelta) => {
+        const { name, operation, version: versionRange } = depDelta;
+        const version = strictVersion(versionRange);
+        let oldVersionRange, oldVersion;
+        if (operation === 'edit') {
+            oldVersionRange = oldDependencies[name];
+            oldVersion = strictVersion(oldVersionRange);
+        }
+        return Promise.all([
+            npm.nameToMarkdown(name),
+            npm.changelogUrlFor(name, cwd),
+            npm.releaseUrlFor(name, version, cwd),
+            oldVersion && npm.releaseUrlFor(name, oldVersion, cwd),
+            promise, // -> result
+        ]).then(([nameMd, changelogUrl, releaseUrl, oldReleaseUrl, result]) => {
+            const versionMd = versionToMarkdown(version, releaseUrl || changelogUrl);
+            if (operation === 'delete') {
+                return result + wrapWithEol(lineForDelete(nameMd));
+            }
+            if (operation === 'new') {
+                return result + wrapWithEol(lineForNew(nameMd, versionMd));
+            }
+            if (operation === 'edit' && oldVersion) {
+                const oldVersionMd = versionToMarkdown(oldVersion, oldReleaseUrl || changelogUrl);
+                if (oldVersion && semver.lt(oldVersion, version)) {
+                    return (result + wrapWithEol(lineForUpdate(nameMd, versionMd, oldVersionMd)));
+                }
+                if (oldVersion && semver.gt(oldVersion, version)) {
+                    return (result +
+                        wrapWithEol(lineForRollback(nameMd, versionMd, oldVersionMd)));
+                }
+            }
+            return result;
+        });
+    }, Promise.resolve(os.EOL));
+}
+function diffPackages(oldPkg, pkg) {
+    return depDiff().left(oldPkg).right(pkg).toObject();
+}
+export { deltaToMarkdown, diffPackages, versionToMarkdown };

package/dist/package-diff-summary/git.js

@@ -0,0 +1,7 @@
+import { execa } from 'execa';
+function gitShow(revision, filePath, cwd) {
+    return execa('git', ['show', `${revision}:${filePath}`], {
+        cwd,
+    }).then(({ stdout }) => stdout);
+}
+export { gitShow };

package/dist/package-diff-summary/github.js

@@ -0,0 +1,37 @@
+import { Octokit } from '@octokit/rest';
+import githubUrlFrom from 'github-url-from-git';
+import * as http from './http.js';
+import * as npm from './npm.js';
+const octokit = new Octokit({
+    auth: process.env.GITHUB_OAUTH_TOKEN,
+});
+function changelogUrlAt(projectUrl) {
+    const changelogUrl = projectUrl + '/blob/master/CHANGELOG.md';
+    return http
+        .isUrlHealthy(changelogUrl)
+        .then((yes) => (yes ? changelogUrl : ''));
+}
+function projectUrlFor(name, cwd) {
+    return npm.repositoryUrlFor(name, cwd).then(githubUrlFrom);
+}
+function releaseUrlFor(projectUrl, version) {
+    const [owner, repo] = projectUrl.split('/').slice(-2);
+    const variations = [version, 'v' + version];
+    // iterate serially to be friendlier to the GitHub API
+    return variations
+        .reduce((promise, variation) => {
+        return promise.then((results) => {
+            return (octokit.rest.repos
+                .getReleaseByTag({ owner, repo, tag: variation })
+                .then((release) => {
+                // add this result to the array we're accumulating
+                return results.concat([release]);
+            })
+                // no result, just return the accumulated array so far
+                .catch(() => results));
+        });
+    }, Promise.resolve([]))
+        .then((results) => results.filter((result) => !!result)[0])
+        .then((release) => release && release.data && release.data.html_url);
+}
+export { changelogUrlAt, projectUrlFor, releaseUrlFor };

package/dist/package-diff-summary/http.js

@@ -0,0 +1,7 @@
+async function isUrlHealthy(testUrl) {
+    const response = await fetch(testUrl, {
+        method: 'HEAD',
+    });
+    return response.ok;
+}
+export { isUrlHealthy };

package/dist/package-diff-summary/index.js

@@ -0,0 +1,13 @@
+import { readPackageUp } from 'read-package-up';
+import * as git from './git.js';
+import * as diff from './diff.js';
+async function main({ previousVersion, cwd, }) {
+    const oldPkg = JSON.parse(await git.gitShow(previousVersion, 'package.json', cwd));
+    const result = await readPackageUp({ cwd });
+    if (result) {
+        const delta = diff.diffPackages(oldPkg, result.packageJson);
+        const text = await diff.deltaToMarkdown(delta, oldPkg, cwd); // CLI tool, relax!
+        return text;
+    }
+}
+export { main };

package/dist/package-diff-summary/npm.js

@@ -0,0 +1,27 @@
+import { execa } from 'execa';
+import * as http from './http.js';
+import * as github from './github.js';
+function changelogUrlFor(name, cwd) {
+    return github
+        .projectUrlFor(name, cwd)
+        .then((projectUrl) => (projectUrl ? github.changelogUrlAt(projectUrl) : ''));
+}
+function nameToMarkdown(name) {
+    const pkgUrl = 'https://www.npmjs.com/package/' + name;
+    return http
+        .isUrlHealthy(pkgUrl)
+        .then((yes) => (yes ? `[${name}](${pkgUrl})` : name));
+}
+function releaseUrlFor(name, version, cwd) {
+    return github
+        .projectUrlFor(name, cwd)
+        .then((projectUrl) => projectUrl ? github.releaseUrlFor(projectUrl, version) : '');
+}
+function repositoryUrlFor(name, cwd) {
+    return execa('npm', ['view', name, 'repository.url'], {
+        cwd,
+    })
+        .then(({ stdout }) => stdout)
+        .catch(() => '');
+}
+export { changelogUrlFor, nameToMarkdown, releaseUrlFor, repositoryUrlFor };

package/dist/startReleaseProcess.js

@@ -4,10 +4,10 @@ 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 { main as packageDiffSummary } from './package-diff-summary/index.js';
 import semver from 'semver';
 import ora from 'ora';
-import { readPackageUp } from 'read-pkg-up';
+import { readPackageUp } from 'read-package-up';
 const readFileAsync = util.promisify(fs.readFile);
 const writeFileAsync = util.promisify(fs.writeFile);
 const UNRELEASED_VERSION_INDEX = 0;
@@ -62,7 +62,9 @@ async function updateChangelog({ nextSemverVersion, cwd, releaseName, }) {
                 cwd,
                 previousVersion: lastGitTag,
             });
-            dependenciesChangelogEntries = result.trim();
+            if (result) {
+                dependenciesChangelogEntries = result.trim();
+            }
         }
         catch (error) {
             if (error.message.includes(`git show ${lastGitTag}:package.json`)) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oneblink/release-cli",
   "description": "Used internally by OneBlink to release code bases quickly and consistently",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "author": "OneBlink <developers@oneblink> (https://github.com/oneblink)",
   "bin": {
     "oneblink-release": "dist/bin.js"
@@ -10,43 +10,46 @@
     "url": "https://github.com/oneblink/release-cli/issues"
   },
   "dependencies": {
+    "@octokit/rest": "^20.0.2",
     "changelog-parser": "^3.0.1",
+    "dependency-diff": "^1.0.4",
     "enquirer": "^2.4.1",
     "execa": "^8.0.1",
+    "github-url-from-git": "^1.5.0",
     "meow": "^12.1.1",
     "ora": "^7.0.1",
-    "package-diff-summary": "^3.0.1",
     "patch-package": "^8.0.0",
     "prettier": "^3.0.3",
-    "read-pkg-up": "^10.1.0",
+    "read-package-up": "^11.0.0",
     "semver": "^7.5.4",
-    "update-notifier": "^6.0.2"
+    "update-notifier": "^7.0.0"
   },
   "bundleDependencies": [
     "changelog-parser"
   ],
   "devDependencies": {
-    "@types/changelog-parser": "^2.8.2",
-    "@types/jest": "^29.5.5",
-    "@types/node": "^18.15.11",
-    "@types/semver": "^7.5.3",
-    "@types/update-notifier": "^6.0.2",
-    "@typescript-eslint/eslint-plugin": "^6.7.5",
-    "@typescript-eslint/parser": "^6.7.5",
+    "@types/changelog-parser": "^2.8.3",
+    "@types/github-url-from-git": "^1.5.2",
+    "@types/jest": "^29.5.7",
+    "@types/node": "^20.8.10",
+    "@types/semver": "^7.5.4",
+    "@types/update-notifier": "^6.0.6",
+    "@typescript-eslint/eslint-plugin": "^6.10.0",
+    "@typescript-eslint/parser": "^6.10.0",
     "cross-env": "^7.0.3",
-    "eslint": "^8.51.0",
+    "eslint": "^8.53.0",
     "eslint-config-prettier": "^9.0.0",
-    "eslint-plugin-prettier": "^5.0.0",
+    "eslint-plugin-prettier": "^5.0.1",
     "jest": "^29.7.0",
     "ts-jest": "^29.1.1",
-    "typescript": "^5.0.3"
+    "typescript": "^5.2.2"
   },
   "directories": {
     "test": "test"
   },
   "engines": {
-    "node": ">=18",
-    "npm": ">=8"
+    "node": ">=20",
+    "npm": ">=10"
   },
   "files": [
     "dist",