feat: export file and parsing interface + readibility improvements

Author: Mila Votradovec

lib/index.ts

@@ -3,29 +3,7 @@ import * as fs from 'fs';
 import * as path from 'path';
 import * as _ from 'lodash';
 
-export default function parseLockFile(root, targetFilePath, lockFilePath, options) {
-  if (!root || !lockFilePath || !lockFilePath) {
-    throw new Error('Missing required parameters for parseLockFile()');
-  }
-  // TODO: validate only valid options were passed in
-
-  const targetFileFullPath = path.resolve(root, targetFilePath);
-  const lockFileFullPath = path.resolve(root, lockFilePath);
-
-  if (!fs.existsSync(targetFilePath)) {
-    throw new Error(`Target file package.json not found at location: ${targetFileFullPath}`);
-  }
-  if (!fs.existsSync(lockFilePath)) {
-    throw new Error(`LockFile package-lock.json not found at location: ${lockFileFullPath}`);
-  }
-
-  const targetFile = fs.readFileSync(targetFileFullPath);
-  const lockFile = fs.readFileSync(lockFileFullPath);
-
-  return buildDepTree(targetFile, lockFile, options);
-}
-
-async function buildDepTree(targetFileRaw, lockFileRaw, options) {
+export async function buildDepTree(targetFileRaw, lockFileRaw, options) {
 
   const lockFile = JSON.parse(lockFileRaw);
   const targetFile = JSON.parse(targetFileRaw);
@@ -43,49 +21,48 @@ async function buildDepTree(targetFileRaw, lockFileRaw, options) {
     version: targetFile.version || undefined,
   };
 
-  const fullDepList = lockFile.dependencies;
   const topLevelDeps = Object.keys(targetFile.dependencies);
 
   await Promise.all(topLevelDeps.map(async (dep) => {
-    depTree.dependencies[dep] = await buildSubTreeRecursive(dep, []);
+    depTree.dependencies[dep] = await buildSubTreeRecursive(dep, [], lockFile);
   }));
 
   return depTree;
+}
+
+async function buildSubTreeRecursive(dep: string, depKeys: string[], lockFile: object) {
 
-  async function buildSubTreeRecursive(dep: string, depKeys: string[]) {
-
-    const depSubTree = {
-      dependencies: {},
-      name: dep,
-      version: undefined,
-    };
-
-    // Get path to the nested dependencies from list ['package1', 'package2']
-    // to ['dependencies', 'package1', 'dependencies', 'package2', 'dependencies']
-    const depPath = getDepPath(depKeys);
-    // try to get list of deps on the path
-    const deps = _.get(lockFile, depPath);
-
-    // If exists and looked-up dep is there
-    if (deps && deps[dep]) {
-      // update the tree
-      depSubTree.version = deps[dep].version;
-      // repeat the process for dependencies of looked-up dep
-      const newDeps = deps[dep].requires && Object.keys(deps[dep].requires) || [];
-      await Promise.all(newDeps.map(async (subDep) => {
-        depSubTree.dependencies[subDep] = await buildSubTreeRecursive(subDep, [...depKeys, dep]);
-      }));
-      return depSubTree;
-    } else {
-      // tree was walked to the root and dependency was not found
-      if (!depKeys.length) {
-        throw new Error(`Dependency ${dep} was not found in package-lock.json.
-          Your package.json and package-lock.json are probably out of sync.
-          Please run npm install and try to parse the log again.`);
-      }
-      // dependency was not found on a current path, remove last key (move closer to the root) and try again
-      return buildSubTreeRecursive(dep, depKeys.slice(0, -1));
+  const depSubTree = {
+    dependencies: {},
+    name: dep,
+    version: undefined,
+  };
+
+  // Get path to the nested dependencies from list ['package1', 'package2']
+  // to ['dependencies', 'package1', 'dependencies', 'package2', 'dependencies']
+  const depPath = getDepPath(depKeys);
+  // try to get list of deps on the path
+  const deps = _.get(lockFile, depPath);
+
+  // If exists and looked-up dep is there
+  if (deps && deps[dep]) {
+    // update the tree
+    depSubTree.version = deps[dep].version;
+    // repeat the process for dependencies of looked-up dep
+    const newDeps = deps[dep].requires ? Object.keys(deps[dep].requires) : [];
+    await Promise.all(newDeps.map(async (subDep) => {
+      depSubTree.dependencies[subDep] = await buildSubTreeRecursive(subDep, [...depKeys, dep], lockFile);
+    }));
+    return depSubTree;
+  } else {
+    // tree was walked to the root and dependency was not found
+    if (!depKeys.length) {
+      throw new Error(`Dependency ${dep} was not found in package-lock.json.
+        Your package.json and package-lock.json are probably out of sync.
+        Please run npm install and try to parse the log again.`);
     }
+    // dependency was not found on a current path, remove last key (move closer to the root) and try again
+    return buildSubTreeRecursive(dep, depKeys.slice(0, -1), lockFile);
   }
 }
 
@@ -96,3 +73,25 @@ function getDepPath(depKeys: string[]) {
 
   return depPath;
 }
+
+export function buildDepTreeFromFiles(root, targetFilePath, lockFilePath, options) {
+  if (!root || !lockFilePath || !lockFilePath) {
+    throw new Error('Missing required parameters for parseLockFile()');
+  }
+  // TODO: validate only valid options were passed in
+
+  const targetFileFullPath = path.resolve(root, targetFilePath);
+  const lockFileFullPath = path.resolve(root, lockFilePath);
+
+  if (!fs.existsSync(targetFilePath)) {
+    throw new Error(`Target file package.json not found at location: ${targetFileFullPath}`);
+  }
+  if (!fs.existsSync(lockFilePath)) {
+    throw new Error(`LockFile package-lock.json not found at location: ${lockFileFullPath}`);
+  }
+
+  const targetFile = fs.readFileSync(targetFileFullPath);
+  const lockFile = fs.readFileSync(lockFileFullPath);
+
+  return buildDepTree(targetFile, lockFile, options);
+}