refactor(mama): enhance scanLockFiles implementation

Author: fraxken

.changeset/hip-cases-learn.md

@@ -0,0 +1,5 @@
+---
+"@nodesecure/mama": patch
+---
+
+Refactor scanLockFiles

workspaces/mama/README.md

@@ -38,7 +38,7 @@ This package exports a set of standalone utilities that are internally used by t
 - [packageJSONIntegrityHash](./docs/packageJSONIntegrityHash.md)
 - [parseNpmSpec](./docs/parseNpmSpec.md)
 - [inspectModuleType](./docs/inspectModuleType.md)
-- [scanLockFiles](./docs/scan-lockfiles.md)
+- [scanLockFiles](./docs/scanLockFiles.md)
 
 ## ManifestManager API
 

workspaces/mama/docs/scan-lockfiles.md

@@ -0,0 +1,24 @@
+# scanLockFiles
+
+Scans for lock files in the given path.
+
+This function searches for common package manager lock files
+such as package-lock.json, yarn.lock, pnpm-lock.yaml, etc.
+returns an Object of found lock file with their paths
+
+## Function Signature
+
+```ts
+export const LOCK_FILES = {
+  npm: "package-lock.json",
+  bun: "bun.lockb",
+  pnpm: "pnpm-lock.yaml",
+  yarn: "yarn.lock",
+  deno: "deno.lock"
+} as const;
+
+export type LockFileProvider = keyof typeof LOCK_FILES;
+export type LockFileName = typeof LOCK_FILES[LockFileProvider];
+
+export function scanLockFiles(dirPath: string): Partial<Record<LockFileProvider, LockFileName>>;
+```

workspaces/mama/docs/scanLockFiles.md

@@ -1,4 +1,4 @@
 export * from "./integrity-hash.ts";
 export * from "./inspectModuleType.ts";
 export * from "./parseNpmSpec.ts";
-export * from "./scan-lockfiles.ts";
+export * from "./scanLockFiles.ts";

workspaces/mama/src/utils/index.ts

@@ -0,0 +1,28 @@
+// Import Node.js Dependencies
+import fs from "node:fs";
+
+export const LOCK_FILES = {
+  npm: "package-lock.json",
+  bun: "bun.lockb",
+  pnpm: "pnpm-lock.yaml",
+  yarn: "yarn.lock",
+  deno: "deno.lock"
+} as const;
+
+export type LockFileProvider = keyof typeof LOCK_FILES;
+export type LockFileName = typeof LOCK_FILES[LockFileProvider];
+
+export function scanLockFiles(
+  dirPath: string
+): Partial<Record<LockFileProvider, LockFileName>> {
+  const dir = fs.readdirSync(dirPath);
+  if (dir.length === 0) {
+    return {};
+  }
+
+  const filteredEntries = Object
+    .entries(LOCK_FILES)
+    .flatMap(([providerName, fileName]) => (dir.includes(fileName) ? [[providerName, fileName]] : []));
+
+  return Object.fromEntries(filteredEntries);
+}

workspaces/mama/src/utils/scan-lockfiles.ts

@@ -0,0 +1,42 @@
+// Import Node.js Dependencies
+import { describe, test, beforeEach, afterEach } from "node:test";
+import assert from "node:assert";
+import fs from "node:fs";
+import os from "node:os";
+import path from "node:path";
+
+// Import Internal Dependencies
+import { scanLockFiles, LOCK_FILES } from "../src/index.ts";
+
+describe("scanLockFiles", () => {
+  let tmpDir: string;
+
+  beforeEach(() => {
+    tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "/"));
+  });
+
+  afterEach(() => {
+    fs.rmSync(tmpDir, { recursive: true, force: true });
+  });
+
+  test("should scan lock files", () => {
+    const output = Array.from(createFile(tmpDir));
+    assert.deepEqual(
+      scanLockFiles(tmpDir),
+      Object.fromEntries(output)
+    );
+  });
+
+  test("should return null no lockfiles", () => {
+    assert.deepEqual(scanLockFiles(tmpDir), {});
+  });
+});
+
+function* createFile(tempDir: string): IterableIterator<[string, string]> {
+  for (const [providerName, fileName] of Object.entries(LOCK_FILES)) {
+    const filepath = path.join(tempDir, fileName);
+
+    fs.writeFileSync(filepath, "");
+    yield [providerName, fileName];
+  }
+}