Merge pull request #16 from snyk/fix/support-project-name-for-umbrella-projects

fix: support --project-name for umbrella projects

Author: JamesPatrickGill

lib/inspect.ts

@@ -6,6 +6,7 @@ interface Options {
   debug?: boolean;
   dev?: boolean;
   file?: string;
+  'project-name'?: string;
   allProjects?: boolean; // if true, will not resolve apps if tested manifest is an umbrella project
 }
 
@@ -28,18 +29,19 @@ export async function inspect(
   targetFile: string,
   options: Options = {},
 ): Promise<MultiProjectResult> {
-  const { debug, dev, allProjects } = options;
+  const { debug, dev, allProjects, 'project-name': projectName } = options;
 
   const [scanResult, pluginVersion] = await Promise.all([
-    scan({ debug, dev, allProjects, path: root, targetFile }),
+    scan({ debug, dev, allProjects, projectName, path: root, targetFile }),
     getPluginVersion(),
   ]);
 
   const scannedProjects = scanResult.scanResults.map(
-    ({ identity, facts: [{ data: depGraph }] }) => ({
+    ({ identity, facts: [{ data: depGraph }], name }) => ({
       packageManager: 'hex',
       targetFile: identity.targetFile!,
       depGraph,
+      ...(name ? { meta: { projectName: name } } : {}),
     }),
   );
 

lib/scan.ts

@@ -41,23 +41,26 @@ export async function scan(options: Options): Promise<PluginResponse> {
   const scanResults = Object.entries(depGraphMap).map(
     ([name, depGraph], index) => {
       const isRoot = index === 0;
+      const relativePathToManifest = getRelativePathToManifest(
+        options,
+        targetFile,
+        isRoot,
+        name,
+      );
       return {
         identity: {
           type: 'hex',
-          targetFile: normalizePath(
-            path.relative(
-              options.path,
-              path.resolve(targetFile.dir, isRoot ? '' : name, targetFile.base),
-            ),
-          ),
+          targetFile: relativePathToManifest,
         },
         facts: [
           {
             type: 'depGraph',
             data: depGraph,
           },
         ],
-        ...(isRoot && options.projectName ? { name: options.projectName } : {}),
+        ...(options.projectName
+          ? { name: getProjectNamePath(options, relativePathToManifest) }
+          : {}),
       };
     },
   );
@@ -108,3 +111,24 @@ function normalizePath(filePath: string) {
   const parts = filePath.split(path.sep);
   return parts.join(path.posix.sep);
 }
+
+function getRelativePathToManifest(
+  options: Options,
+  targetFile: path.ParsedPath,
+  isRoot: boolean,
+  name: string,
+) {
+  return normalizePath(
+    path.relative(
+      options.path,
+      path.resolve(targetFile.dir, isRoot ? '' : name, targetFile.base),
+    ),
+  );
+}
+
+function getProjectNamePath(options: Options, relativePathToManifest: string) {
+  return [
+    options.projectName,
+    ...relativePathToManifest.split('/').slice(1, -1),
+  ].join('/');
+}