jvm-upgrade 0.2.0 → 0.3.1

package/README.md

@@ -40,12 +40,14 @@ Or run it once with `npx jvm-upgrade`. Needs Node.js 22.13 or newer.
 ## Usage
 
 ```sh
-jvm-upgrade                 # list available upgrades (nothing is changed)
-jvm-upgrade -u              # apply the latest major versions
-jvm-upgrade -u -t minor     # apply the latest minor versions only
-jvm-upgrade -i              # pick versions and read changelogs interactively
-jvm-upgrade -l              # print the changelogs of the selected upgrades
-jvm-upgrade -c 7            # ignore versions published in the last 7 days
+jvm-upgrade                     # list available upgrades (nothing is changed)
+jvm-upgrade -u                  # apply the latest major versions
+jvm-upgrade -u -t minor         # apply the latest minor versions only
+jvm-upgrade -i                  # pick versions and read changelogs interactively
+jvm-upgrade -l                  # print a changelog link for each upgrade
+jvm-upgrade --changelog-latest  # print the release notes of each new version
+jvm-upgrade --changelog-diff    # print the release notes of every version in between
+jvm-upgrade -c 7                # ignore versions published in the last 7 days
 jvm-upgrade path/to/project
 ```
 
@@ -70,7 +72,9 @@ jvm-upgrade path/to/project
 | `[directory]` | `.` | Project root to scan |
 | `-u, --upgrade` | | Write the upgrades to the build files |
 | `-i, --interactive` | | Pick upgrades in a terminal UI |
-| `-l, --changelog` | | Print the changelog of each selected upgrade |
+| `-l, --changelog` | | Print a changelog link for each selected upgrade |
+| `--changelog-latest` | | Print the release notes of the new version only |
+| `--changelog-diff` | | Print the release notes of every version between the old and the new one |
 | `-t, --target <level>` | `major` | Highest jump allowed: `major`, `minor` or `patch` |
 | `-c, --cooldown <days>` | `0` | Skip versions published less than N days ago |
 | `--allow-downgrade` | | With `--cooldown`, roll back versions that are too new |
@@ -132,6 +136,8 @@ For each upgrade, jvm-upgrade finds the source repository:
 
 It then reads the GitHub releases between your version and the new one. Prereleases are skipped unless you upgrade to one. If there are no releases, it reads `CHANGELOG.md` (and similar files) and cuts out the right sections. Tags without the major version (protobuf-java `4.36.2` is tag `v36.2`) are matched too.
 
+Notes are cleaned up for the terminal: headings, bullets and code are styled, links and HTML are removed, pull request and commit links become `#123` and short hashes, and Renovate/Dependabot bumps are hidden. Each version shows at most 40 lines, followed by a link to the rest. In the interactive picker (`c`), you see the full notes.
+
 If it finds nothing, it gives you a link: the release notes page for androidx, Google Play services, Firebase and Gradle, or the project's releases page.
 
 Set `GITHUB_TOKEN` (or `GH_TOKEN`) to avoid GitHub rate limits.

package/dist/format.js

@@ -51,37 +51,120 @@ export function toJson(rows, root) {
         };
     });
 }
-export function formatChangelog(log, width) {
+export function formatChangelog(log, width, opts = {}) {
     if (!log.entries.length) {
-        return log.source ? `No release notes found here. Read them at:\n${log.source}` : 'No release notes found.';
+        return log.source ? `  No release notes found here. Read them at:\n  ${styleText('cyan', log.source)}` : '  No release notes found.';
     }
     const out = [];
     for (const entry of log.entries) {
-        const date = entry.date ? styleText('gray', `  ${entry.date.slice(0, 10)}`) : '';
-        out.push(styleText(['bold', 'cyan'], entry.title && entry.title !== entry.version ? `${entry.version}  ${entry.title}` : entry.version) + date);
+        const title = entry.title && !isJustVersion(entry.title, entry.version) ? styleText('gray', `  ${entry.title}`) : '';
+        const date = entry.date ? styleText('gray', `  ·  ${entry.date.slice(0, 10)}`) : '';
+        out.push(`  ${styleText(['bold', 'green'], `● ${entry.version}`)}${title}${date}`);
         if (entry.url)
-            out.push(styleText('gray', entry.url));
-        out.push('');
-        for (const line of entry.body.replace(/\r/g, '').trim().split('\n'))
-            out.push(...wrap(line, width));
+            out.push(`    ${styleText('gray', entry.url)}`);
+        const body = renderMarkdown(entry.body, width - 4);
+        const shown = opts.maxLines && body.length > opts.maxLines ? body.slice(0, opts.maxLines) : body;
+        if (shown.length)
+            out.push('', ...shown.map((line) => (line ? `    ${line}` : '')));
+        if (shown.length < body.length) {
+            out.push(styleText('gray', `    … ${body.length - shown.length} more lines${entry.url ? ` at ${entry.url}` : ''}`));
+        }
         out.push('');
     }
-    if (log.source)
-        out.push(styleText('gray', `Source: ${log.source}`));
-    return out.join('\n');
+    if (log.source && log.entries.some((e) => !e.url))
+        out.push(styleText('gray', `  Source: ${log.source}`));
+    return out.join('\n').trimEnd();
+}
+export function formatChangelogHeader(name, from, to, width) {
+    const title = ` ${name}  ${from} → ${to.version} `;
+    const rule = '━'.repeat(Math.max(3, Math.min(width, 100) - title.length - 3));
+    return `${styleText('gray', '━━')}${styleText('bold', ` ${name}  `)}${from} → ${styleText(['bold', levelColor(to.level)], to.version)} ${styleText('gray', rule)}`;
+}
+export function formatChangelogLinks(links) {
+    const nameWidth = Math.max(...links.map((l) => l.name.length));
+    const jumpWidth = Math.max(...links.map((l) => `${l.from} → ${l.to.version}`.length));
+    const lines = links.map((l) => {
+        const jump = `${l.from} → ${l.to.version}`;
+        const colored = `${l.from} → ${styleText(levelColor(l.to.level), l.to.version)}${' '.repeat(jumpWidth - jump.length)}`;
+        return `${l.name.padEnd(nameWidth)}  ${colored}  ${l.url ? styleText('cyan', l.url) : styleText('gray', 'no release notes found')}`;
+    });
+    return [styleText('bold', 'Changelogs'), ...lines].join('\n');
+}
+/** Link to the notes of the target version when found, else to the general notes page. */
+export function changelogUrl(log) {
+    return log.entries[0]?.url ?? log.source;
+}
+function isJustVersion(title, version) {
+    return title.replace(/^v/i, '') === version || !title.replace(new RegExp(version.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'), 'g'), '').replace(/[\sv]/gi, '');
+}
+/** Turns release-note markdown into short, styled terminal lines. */
+export function renderMarkdown(markdown, width) {
+    const text = markdown
+        .replace(/\r/g, '')
+        .replace(/<!--[\s\S]*?-->/g, '')
+        .replace(/<\/?[a-z][^>]*>/gi, '')
+        .replace(/!\[[^\]]*\]\([^)]*\)/g, '')
+        .replace(/\[([^\]]+)\]\((?:https?:[^)\s]+)\)/g, '$1')
+        .replace(/https:\/\/github\.com\/[^/\s]+\/[^/\s]+\/(?:pull|issues)\/(\d+)/g, '#$1')
+        .replace(/\(?https:\/\/github\.com\/[^/\s]+\/[^/\s]+\/commit\/([0-9a-f]{8})[0-9a-f]*\)?/g, '($1)')
+        .replace(/^\s*(?:\*\*|__)([^*_\n]+)(?:\*\*|__):?\s*$/gm, '### $1')
+        .replace(/^\s*[-*+]\s.*@(?:renovate|dependabot)\[bot\].*$\n?/gim, '')
+        .replace(/\*\*|__/g, '');
+    const out = [];
+    let fence = false;
+    let afterHeading = false;
+    for (const raw of text.split('\n')) {
+        const line = raw.trimEnd();
+        const wasHeading = afterHeading;
+        afterHeading = false;
+        if (/^\s*```/.test(line)) {
+            fence = !fence;
+            continue;
+        }
+        if (fence) {
+            out.push(styleText('cyan', line));
+            continue;
+        }
+        if (/^\s*\[[^\]]+\]:\s*\S+$/.test(line) || /^\s*([-*_])(\s*\1){2,}\s*$/.test(line))
+            continue;
+        const heading = /^#{1,6}\s+(.*?)\s*#*$/.exec(line);
+        if (heading) {
+            if (out.length && out.at(-1) !== '')
+                out.push('');
+            out.push(styleText(['bold', 'yellow'], heading[1]));
+            afterHeading = true;
+            continue;
+        }
+        if (!line.trim()) {
+            if (out.length && out.at(-1) !== '' && !wasHeading)
+                out.push('');
+            afterHeading = wasHeading;
+            continue;
+        }
+        const bullet = /^(\s*)[-*+]\s+(.*)$/.exec(line);
+        if (bullet) {
+            const indent = '  '.repeat(Math.min(Math.floor(bullet[1].length / 2), 3));
+            out.push(...wrap(bullet[2], width - indent.length - 2).map((l, i) => `${indent}${i ? '  ' : '• '}${code(l)}`));
+            continue;
+        }
+        out.push(...wrap(line.trim(), width).map(code));
+    }
+    while (out.at(-1) === '')
+        out.pop();
+    return out;
+}
+function code(line) {
+    return line.replace(/`([^`]+)`/g, (_, c) => styleText('cyan', c));
 }
-function wrap(line, width) {
-    if (line.length <= width || width < 20)
-        return [line];
-    const indent = /^\s*([-*+]\s+|\d+\.\s+)?/.exec(line)[0].length;
-    const pad = ' '.repeat(Math.min(indent, 8));
-    const words = line.split(' ');
+function wrap(text, width) {
+    if (text.length <= width || width < 20)
+        return [text];
     const lines = [];
     let current = '';
-    for (const word of words) {
+    for (const word of text.split(' ')) {
         if (current && current.length + word.length + 1 > width) {
             lines.push(current);
-            current = pad + word;
+            current = word;
         }
         else {
             current = current ? `${current} ${word}` : word;

package/dist/main.js

@@ -5,7 +5,7 @@ import { parseArgs, styleText } from 'node:util';
 import { applyEdits, EditConflictError } from './apply.js';
 import { getChangelog } from './changelog.js';
 import { ConfigError, loadCredentials, loadUserConfig, projectConfigResolver, splitPatterns } from './config.js';
-import { formatChangelog, renderTable, toJson } from './format.js';
+import { changelogUrl, formatChangelog, formatChangelogHeader, formatChangelogLinks, renderTable, toJson } from './format.js';
 import { clearCache, createHttp, defaultCacheDir } from './http.js';
 import { createProgress } from './progress.js';
 import { buildRows } from './rows.js';
@@ -20,7 +20,9 @@ Find outdated libraries in Gradle and Maven projects and upgrade them.
 Actions
   -u, --upgrade            Write the selected upgrades to the build files
   -i, --interactive        Pick upgrades (and read changelogs) in a terminal UI
-  -l, --changelog          Print the changelog of every selected upgrade
+  -l, --changelog          Print a changelog link for every selected upgrade
+      --changelog-latest   Print the release notes of the new version only
+      --changelog-diff     Print the release notes of every version between old and new
 
 Policy
   -t, --target <level>     Highest jump allowed: major, minor or patch (default: major)
@@ -59,6 +61,8 @@ function parseCli(argv) {
                 upgrade: { type: 'boolean', short: 'u' },
                 interactive: { type: 'boolean', short: 'i' },
                 changelog: { type: 'boolean', short: 'l' },
+                'changelog-latest': { type: 'boolean' },
+                'changelog-diff': { type: 'boolean' },
                 target: { type: 'string', short: 't' },
                 cooldown: { type: 'string', short: 'c' },
                 'allow-downgrade': { type: 'boolean' },
@@ -229,8 +233,9 @@ export async function main(argv = process.argv.slice(2)) {
                     chosen.set(row, choice);
             }
         }
-        if (flags.changelog && !json)
-            await printChangelogs(http, chosen, showProgress);
+        const changelogMode = flags['changelog-diff'] ? 'diff' : flags['changelog-latest'] ? 'latest' : flags.changelog ? 'links' : undefined;
+        if (changelogMode && !json)
+            await printChangelogs(http, chosen, changelogMode, showProgress);
         const writable = [...chosen].filter(([row]) => row.location);
         if (flags.upgrade || flags.interactive) {
             if (!writable.length) {
@@ -265,17 +270,27 @@ function loadChangelog(http, row, choice) {
     const dep = row.deps[0];
     return getChangelog(http, dep, row.current, choice.version, row.repoOf.get(choice.version), compareVersions);
 }
-async function printChangelogs(http, chosen, showProgress) {
+const MAX_NOTE_LINES = 40;
+async function printChangelogs(http, chosen, mode, showProgress) {
     const entries = [...chosen];
+    if (!entries.length)
+        return;
     const progress = createProgress('Loading changelogs', process.stderr, showProgress);
     progress.total(entries.length);
     const logs = await Promise.all(entries.map(([row, choice]) => loadChangelog(http, row, choice)
-        .catch((e) => ({ entries: [], source: `could not load: ${e.message}` }))
+        .catch(() => ({ entries: [] }))
         .finally(() => progress.tick())));
     progress.done();
+    if (mode === 'links') {
+        const links = entries.map(([row, choice], i) => ({ name: row.name, from: row.current, to: choice, url: changelogUrl(logs[i]) }));
+        process.stdout.write(`\n${formatChangelogLinks(links)}\n`);
+        return;
+    }
     const width = Math.min(process.stdout.columns ?? 100, 120) - 2;
     entries.forEach(([row, choice], i) => {
-        process.stdout.write(`\n${styleText(['bold', 'underline'], `${row.name}  ${row.current} → ${choice.version}`)}\n\n`);
-        process.stdout.write(`${formatChangelog(logs[i], width)}\n`);
+        const log = logs[i];
+        const shown = mode === 'latest' ? { ...log, entries: log.entries.slice(0, 1) } : log;
+        process.stdout.write(`\n${formatChangelogHeader(row.name, row.current, choice, width)}\n\n`);
+        process.stdout.write(`${formatChangelog(shown, width, { maxLines: MAX_NOTE_LINES })}\n`);
     });
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jvm-upgrade",
-  "version": "0.2.0",
+  "version": "0.3.1",
   "description": "Find and apply library upgrades in Java, Kotlin and Android projects (Gradle and Maven), with changelogs.",
   "type": "module",
   "bin": {