diff-lockfiles 1.0.2 → 1.1.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Change Log
 
+## 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
+  Vergenz)
+
 ## 1.0.2 - 2023-09-07
 
 - Default to table layout rather than text

package/README.md

@@ -29,6 +29,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

@@ -8,19 +8,15 @@ import { diff, print } from '../lib/index.js';
 const execPromise = promisify(exec);
 const version = '1.0.2';
 
-const lockFiles = async function getLockChangedLockFiles(a, b) {
-    const output = await execPromise(`git diff ${a} ${b} --name-only | grep package-lock.json`);
+async function lockFiles(a, b) {
+    const output = await execPromise(`git diff ${a} ${b} --name-only | grep 'package-lock.json$'`);
     const lines = output.stdout;
     const list = lines.trim().split(/\r\n|\r|\n/);
 
-    if (output.stderr.trim !== '') {
-        // console.error(output.stderr.trim);
-    }
-
     return list;
 };
 
-const lockFileString = async function getLockFileString(maxBuffer, branch, filename) {
+async function lockFileString(maxBuffer, branch, filename) {
     const output = await execPromise(`git show ${branch}:${filename}`, { maxBuffer: maxBuffer });
     const lines = output.stdout.trim();
 
@@ -40,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

@@ -3,14 +3,27 @@ import chalk from 'chalk';
 import semver from 'semver';
 import { table } from 'table';
 
-export function diff(oldLock, newLock) {
+export function diff(oldLock, newLock, shallow) {
   const changes = {};
+  
+  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;
+  }
 
-  Object.entries(oldLock.packages).forEach(([name, { version }]) => {
+  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];

package/package.json

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