diff-lockfiles 1.0.3 → 1.2.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+## 1.2.0 - 2025-09-25
+
+- Added --format markdown
+
+## 1.1.0 - 2024-06-28
+
+- Added --shallow to only handle direct dependencies (GH #31) (Jussi Kosunen)
+
 ## 1.0.3 - 2024-06-06
 
 - Only diff files whose string *ends* with package-lock.json (GH #24 Tim

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
 ```
 
@@ -29,6 +34,7 @@ Options:
   -f, --format <format>  changes the output format (default: "table")
   -m, --max-buffer       maximum read buffer size
   -c, --color            colorizes certain output formats (default: false)
+  -s, --shallow          only include direct dependencies of the project (default: false)
   -h, --help             display help for command
 ```
 

package/bin/diff-lockfiles.js

@@ -36,13 +36,14 @@ cli
     .option('-f, --format <format>', 'changes the output format (table|json|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)
     .action((from, to, options) => {
         lockFiles(from, to).then((v) => {
             for (let filename of v) {
                 const a = lockFileString(options.maxBuffer, from, filename).then((s) => { return JSON.parse(s); });
                 const b = lockFileString(options.maxBuffer, to, filename).then((s) => { return JSON.parse(s); });
                 Promise.all([a, b]).then((values) => {
-                    const changes = diff(values[0], values[1]);
+                    const changes = diff(values[0], values[1], options.shallow);
                     print(changes, {
                         color: options.color,
                         format: options.format,

package/lib/index.js

@@ -2,15 +2,29 @@
 import chalk from 'chalk';
 import semver from 'semver';
 import { table } from 'table';
+import { markdownTable } from 'markdown-table';
 
-export function diff(oldLock, newLock) {
+export function diff(oldLock, newLock, shallow) {
   const changes = {};
 
-  Object.entries(oldLock.packages).forEach(([name, { version }]) => {
+  function filterPackages(packages) {
+    let entries = Object.entries(packages);
+    if (shallow) {
+      const selfPackage = packages[''];
+      const directDeps = new Set(
+          ['dependencies', 'devDependencies', 'optionalDependencies', 'peerDependencies']
+              .flatMap(key => Object.keys(selfPackage[key] ?? {}))
+              .map(pkg => `node_modules/${pkg}`));
+      entries = entries.filter(([name]) => directDeps.has(name) || name === ''); // include self for compatibility
+    }
+    return entries;
+  }
+
+  filterPackages(oldLock.packages).forEach(([name, { version }]) => {
     changes[name] = [version, null];
   });
 
-  Object.entries(newLock.packages).forEach(([name, { version }]) => {
+  filterPackages(newLock.packages).forEach(([name, { version }]) => {
     if (changes[name] && changes[name][0]) {
       if (semver.eq(changes[name][0], version)) {
         delete changes[name];
@@ -101,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':
@@ -109,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.0.3",
+  "version": "1.2.0",
   "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"
   }
 }