diff-lockfiles 1.1.0 → 1.2.1

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+## 1.2.1 - 2025-09-25
+
+- Add markdown to --help output
+
+## 1.2.0 - 2025-09-25
+
+- Added markdown as a table format
+
 ## 1.1.0 - 2024-06-28
 
 - Added --shallow to only handle direct dependencies (GH #31) (Jussi Kosunen)

package/README.md

@@ -7,12 +7,17 @@ operates on Git commit ranges rather than on files.
 
 ## Example
 
+Install `diff-lockfiles` globally:
+
 ```sh
-npm install diff-lockfiles
-diff-lockfiles --color origin/main dependabot/branch
+npm install -g diff-lockfiles
 ```
 
+Try it out:
+
 ```ssh
+diff-lockfiles --color origin/main dependabot/branch
+
 diff-lockfiles --color HEAD~1 HEAD
 ```
 
@@ -35,7 +40,7 @@ Options:
 
 ### `--format=table` (default)
 
-```texst
+```text
 $ diff-lockfiles HEAD~1 HEAD
 ╔═══════════════════════════════════════════════════════════════════╤═════════════╤═════════════╗
 ║ package-lock.json                                                 │             │             ║
@@ -423,6 +428,67 @@ node_modules/resolve 1.22.2 -> 1.22.4
 node_modules/@jest/reporters/node_modules/istanbul-lib-instrument added
 ```
 
+### `--format=markdown`
+
+```shell
+$ diff-lockfiles --format markdown HEAD~1 HEAD
+```
+
+| package | old version | new version |
+| --- | --- | --- |
+| node_modules/@jest/console | 29.6.2 | 29.6.3 |
+| node_modules/@jest/core | 29.6.2 | 29.6.3 |
+| node_modules/@jest/environment | 29.6.2 | 29.6.3 |
+| node_modules/@jest/expect | 29.6.2 | 29.6.3 |
+| node_modules/@jest/expect-utils | 29.6.2 | 29.6.3 |
+| node_modules/@jest/fake-timers | 29.6.2 | 29.6.3 |
+| node_modules/@jest/globals | 29.6.2 | 29.6.3 |
+| node_modules/@jest/reporters | 29.6.2 | 29.6.3 |
+| node_modules/@jest/schemas | 29.6.0 | 29.6.3 |
+| node_modules/@jest/source-map | 29.6.0 | 29.6.3 |
+| node_modules/@jest/test-result | 29.6.2 | 29.6.3 |
+| node_modules/@jest/test-sequencer | 29.6.2 | 29.6.3 |
+| node_modules/@jest/transform | 29.6.2 | 29.6.3 |
+| node_modules/@jest/types | 29.6.1 | 29.6.3 |
+| node_modules/@types/babel__core | 7.20.0 | 7.20.1 |
+| node_modules/@types/babel__traverse | 7.18.2 | 7.20.1 |
+| node_modules/babel-jest | 29.6.2 | 29.6.3 |
+| node_modules/babel-plugin-jest-hoist | 29.5.0 | 29.6.3 |
+| node_modules/babel-preset-jest | 29.5.0 | 29.6.3 |
+| node_modules/dedent | 1.3.0 | 1.5.1 |
+| node_modules/diff-sequences | 29.4.3 | 29.6.3 |
+| node_modules/expect | 29.6.2 | 29.6.3 |
+| node_modules/fsevents | 2.3.2 | 2.3.3 |
+| node_modules/is-core-module | 2.12.1 | 2.13.0 |
+| node_modules/jest | 29.6.2 | 29.6.3 |
+| node_modules/jest-changed-files | 29.5.0 | 29.6.3 |
+| node_modules/jest-circus | 29.6.2 | 29.6.3 |
+| node_modules/jest-cli | 29.6.2 | 29.6.3 |
+| node_modules/jest-config | 29.6.2 | 29.6.3 |
+| node_modules/jest-diff | 29.6.2 | 29.6.3 |
+| node_modules/jest-docblock | 29.4.3 | 29.6.3 |
+| node_modules/jest-each | 29.6.2 | 29.6.3 |
+| node_modules/jest-environment-node | 29.6.2 | 29.6.3 |
+| node_modules/jest-get-type | 29.4.3 | 29.6.3 |
+| node_modules/jest-haste-map | 29.6.2 | 29.6.3 |
+| node_modules/jest-leak-detector | 29.6.2 | 29.6.3 |
+| node_modules/jest-matcher-utils | 29.6.2 | 29.6.3 |
+| node_modules/jest-message-util | 29.6.2 | 29.6.3 |
+| node_modules/jest-mock | 29.6.2 | 29.6.3 |
+| node_modules/jest-regex-util | 29.4.3 | 29.6.3 |
+| node_modules/jest-resolve | 29.6.2 | 29.6.3 |
+| node_modules/jest-resolve-dependencies | 29.6.2 | 29.6.3 |
+| node_modules/jest-runner | 29.6.2 | 29.6.3 |
+| node_modules/jest-runtime | 29.6.2 | 29.6.3 |
+| node_modules/jest-snapshot | 29.6.2 | 29.6.3 |
+| node_modules/jest-util | 29.6.2 | 29.6.3 |
+| node_modules/jest-validate | 29.6.2 | 29.6.3 |
+| node_modules/jest-watcher | 29.6.2 | 29.6.3 |
+| node_modules/jest-worker | 29.6.2 | 29.6.3 |
+| node_modules/pretty-format | 29.6.2 | 29.6.3 |
+| node_modules/resolve | 1.22.2 | 1.22.4 |
+| node_modules/@jest/reporters/node_modules/istanbul-lib-instrument | | 6.0.0 |
+
 ## Testing
 
 ```bash

package/bin/diff-lockfiles.js

@@ -33,7 +33,7 @@ cli
     .description('diff all changed package-lock.json files in repo')
     .version(version)
     .arguments('<from> <to>')
-    .option('-f, --format <format>', 'changes the output format (table|json|text)', 'table')
+    .option('-f, --format <format>', 'changes the output format (table|json|markdown|text)', 'table')
     .option('-m, --max-buffer', 'maximum read buffer size', 1024 * 10000)
     .option('-c, --color', 'colorizes certain output formats', false)
     .option('-s, --shallow', 'only include direct dependencies of the project', false)

package/lib/index.js

@@ -2,10 +2,11 @@
 import chalk from 'chalk';
 import semver from 'semver';
 import { table } from 'table';
+import { markdownTable } from 'markdown-table';
 
 export function diff(oldLock, newLock, shallow) {
   const changes = {};
-  
+
   function filterPackages(packages) {
     let entries = Object.entries(packages);
     if (shallow) {
@@ -114,6 +115,45 @@ function printTable(changes, options) {
   /* eslint-disable no-console */
 }
 
+function printMarkdown(changes, options) {
+  /* eslint-disable no-console */
+
+  // Helper function to format version changes with markdown emphasis
+  function formatVersionChange(oldVersion, newVersion) {
+    if (!oldVersion) return `**${newVersion}** (added)`;
+    if (!newVersion) return `~~${oldVersion}~~ (removed)`;
+
+    if (semver.valid(oldVersion) && semver.valid(newVersion)) {
+      if (semver.lt(oldVersion, newVersion)) {
+        return `${oldVersion} → **${newVersion}**`;
+      } else if (semver.gt(oldVersion, newVersion)) {
+        return `**${oldVersion}** → ${newVersion}`;
+      }
+    }
+
+    return `${oldVersion} → ${newVersion}`;
+  }
+
+  const tableData = [
+    ['Package', 'Old Version', 'New Version', 'Change'],
+    ...Object.entries(changes).map(([name, [oldVersion, newVersion]]) => [
+      name,
+      oldVersion || '—',
+      newVersion || '—',
+      formatVersionChange(oldVersion, newVersion)
+    ])
+  ];
+
+  // Add title if provided
+  if (options.title && options.title !== '') {
+    console.log(`## ${options.title}\n`);
+  }
+
+  console.log(markdownTable(tableData));
+
+  /* eslint-enable no-console */
+}
+
 export function print(changes, options) {
   switch (options.format) {
     case 'json':
@@ -122,6 +162,9 @@ export function print(changes, options) {
     case 'table':
       printTable(changes, options);
       break;
+    case 'markdown':
+      printMarkdown(changes, options);
+      break;
     case 'text':
     default:
       printText(changes, options);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "diff-lockfiles",
-  "version": "1.1.0",
+  "version": "1.2.1",
   "description": "a diff for package-lock.json files",
   "repository": {
     "type": "git",
@@ -20,12 +20,13 @@
   },
   "dependencies": {
     "chalk": "^5.3.0",
-    "commander": "^12.0.0",
+    "commander": "^14.0.0",
+    "markdown-table": "^3.0.4",
     "semver": "^7.5.4",
     "table": "^6.8.1"
   },
   "devDependencies": {
     "eslint": "^9.0.0",
-    "jest": "^29.6.2"
+    "jest": "^30.0.0"
   }
 }