lockfile-hasher 1.0.1 → 1.1.0

package/README.md

@@ -15,5 +15,13 @@ npm install lockfile-hasher
 ```js
 import { generateCombinedLockFileHash } from 'lockfile-hasher';
 
-const combinedHash = generateCombinedLockfileHash(pathToRepositoryRoot);
+const combinedHash = generateCombinedLockFileHash(pathToRepositoryRoot);
+```
+
+Alternatively, you can use the default export. This allows for easier mocking, since hashing lockfiles is an expensive operation that you really don't want to do during unit tests:
+
+```js
+import lockfileHasher from 'lockfile-hasher';
+
+const combinedHash = lockfileHasher.generateCombinedLockFileHash(pathToRepositoryRoot);
 ```

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Generate a combined hash of all lock files in a repo.
+ * @param {string} rootPath - Root path of the repository
+ * @returns {Promise<string>} - Combined hash string
+ */
+export declare function generateCombinedLockFileHash(rootPath: string): Promise<string>;
+declare const _default: {
+    generateCombinedLockFileHash: typeof generateCombinedLockFileHash;
+};
+export default _default;

package/dist/index.js

@@ -0,0 +1,35 @@
+import crypto from 'node:crypto';
+import { readFile } from 'node:fs/promises';
+import path from 'node:path';
+import { glob } from 'glob';
+const GLOB_PATTERNS = ['**/package-lock.json', '**/yarn.lock', '**/pnpm-lock.yaml'];
+const GLOB_OPTIONS = { ignore: '**/node_modules/**' };
+/**
+ * Generate a combined hash of all lock files in a repo.
+ * @param {string} rootPath - Root path of the repository
+ * @returns {Promise<string>} - Combined hash string
+ */
+export async function generateCombinedLockFileHash(rootPath) {
+    const files = await Promise.all(GLOB_PATTERNS.map((pattern) => glob(path.join(rootPath, pattern), GLOB_OPTIONS))).then((results) => results.flat());
+    const fileContents = await Promise.all(files.map((file) => readFile(file)));
+    // Generate hash for each file
+    const hashesMap = {};
+    files.forEach((file, i) => {
+        const relativePath = path.relative(rootPath, file);
+        const fileContent = fileContents[i];
+        const hash = crypto.createHash('sha256').update(fileContent).digest('hex');
+        hashesMap[relativePath] = hash;
+    });
+    // Sort the entries to ensure consistent hash
+    const sortedEntries = Object.entries(hashesMap).sort(([pathA], [pathB]) => {
+        return pathA.localeCompare(pathB);
+    });
+    // Create a string representation of all hashes
+    const combinedString = sortedEntries.map(([relPath, hash]) => `${relPath}:${hash}`).join('|');
+    // Generate a new hash from the combined string
+    return crypto.createHash('sha256').update(combinedString).digest('hex');
+}
+export default {
+    generateCombinedLockFileHash,
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAE5B,MAAM,aAAa,GAAG,CAAC,sBAAsB,EAAE,cAAc,EAAE,mBAAmB,CAAC,CAAC;AACpF,MAAM,YAAY,GAAG,EAAE,MAAM,EAAE,oBAAoB,EAAE,CAAC;AAEtD;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,4BAA4B,CAAC,QAAgB;IACjE,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,GAAG,CAC7B,aAAa,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,OAAO,CAAC,EAAE,YAAY,CAAC,CAAC,CACjF,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IACpC,MAAM,YAAY,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAE5E,8BAA8B;IAC9B,MAAM,SAAS,GAA2B,EAAE,CAAC;IAE7C,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE;QACxB,MAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QACnD,MAAM,WAAW,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;QACpC,MAAM,IAAI,GAAG,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC3E,SAAS,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC;IACjC,CAAC,CAAC,CAAC;IAEH,6CAA6C;IAC7C,MAAM,aAAa,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,EAAE;QACxE,OAAO,KAAK,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;IAEH,+CAA+C;IAC/C,MAAM,cAAc,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,GAAG,OAAO,IAAI,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAE9F,+CAA+C;IAC/C,OAAO,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAC1E,CAAC;AAED,eAAe;IACb,4BAA4B;CAC7B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lockfile-hasher",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "Generates a combined hash of all the lockfiles in a repository",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -33,7 +33,7 @@
   "scripts": {
     "build": "rm -rf dist && tsc",
     "check-format": "biome check .",
-    "ci": "pnpm run test && pnpm run check-format",
+    "ci": "pnpm run test && pnpm run check-format && pnpm run build",
     "format": "biome check --write .",
     "test": "node --experimental-strip-types --test"
   }