feat: add alias support - wip

Author: aarlaud

lib/dep-graph-builders/npm-lock-v2/index.ts

@@ -34,6 +34,7 @@ export const parseNpmLockV2Project = async (
     strictOutOfSync,
     includeOptionalDeps,
     pruneNpmStrictOutOfSync,
+    honorAliases,
   } = options;
 
   const pkgJson: PackageJsonBase = parsePkgJson(pkgJsonContent);
@@ -44,6 +45,7 @@ export const parseNpmLockV2Project = async (
     includeOptionalDeps,
     strictOutOfSync,
     pruneNpmStrictOutOfSync,
+    honorAliases,
   });
 
   return depgraph;
@@ -59,6 +61,7 @@ export const buildDepGraphNpmLockV2 = async (
     strictOutOfSync,
     includeOptionalDeps,
     pruneNpmStrictOutOfSync,
+    honorAliases,
   } = options;
   const depGraphBuilder = new DepGraphBuilder(
     { name: 'npm' },
@@ -69,6 +72,7 @@ export const buildDepGraphNpmLockV2 = async (
     includeDevDeps,
     includeOptionalDeps,
     includePeerDeps: true,
+    honorAliases,
   });
 
   const rootNode: PkgNode = {
@@ -83,11 +87,14 @@ export const buildDepGraphNpmLockV2 = async (
 
   const pkgKeysByName: Map<string, string[]> = Object.keys(npmLockPkgs).reduce(
     (acc, key) => {
-      const name = key.replace(/.*node_modules\//, '');
+      let name = key.replace(/.*node_modules\//, '');
       if (!name) {
         return acc;
       }
 
+      if (npmLockPkgs[key].name && options.honorAliases) {
+        name = npmLockPkgs[key].name;
+      }
       if (!acc.has(name)) {
         acc.set(name, []);
       }
@@ -112,6 +119,7 @@ export const buildDepGraphNpmLockV2 = async (
     pkgKeysByName,
     pkgJson.overrides,
     pruneNpmStrictOutOfSync,
+    options.honorAliases,
   );
   return depGraphBuilder.build();
 };
@@ -135,6 +143,7 @@ const dfsVisit = async (
   pkgKeysByName: Map<string, string[]>,
   overrides: Overrides | undefined,
   pruneNpmStrictOutOfSync?: boolean,
+  honorAliases?: boolean,
 ): Promise<void> => {
   visitedMap.add(node.id);
 
@@ -162,6 +171,7 @@ const dfsVisit = async (
       pkgKeysByName,
       overrides,
       pruneNpmStrictOutOfSync,
+      honorAliases ?? false,
     );
 
     if (!visitedMap.has(childNode.id)) {
@@ -203,6 +213,7 @@ const getChildNode = (
   pkgKeysByName: Map<string, string[]>,
   overrides?: Overrides,
   pruneNpmStrictOutOfSync?: boolean,
+  honorAliases?: boolean,
 ) => {
   let version = depInfo.version;
 
@@ -276,14 +287,23 @@ const getChildNode = (
   const dependencies = getGraphDependencies(
     depData.dependencies || {},
     depInfo.isDev,
+    honorAliases ?? false,
   );
 
   const devDependencies = includeDevDeps
-    ? getGraphDependencies(depData.devDependencies || {}, depInfo.isDev)
+    ? getGraphDependencies(
+        depData.devDependencies || {},
+        depInfo.isDev,
+        honorAliases ?? false,
+      )
     : {};
 
   const optionalDependencies = includeOptionalDeps
-    ? getGraphDependencies(depData.optionalDependencies || {}, depInfo.isDev)
+    ? getGraphDependencies(
+        depData.optionalDependencies || {},
+        depInfo.isDev,
+        honorAliases ?? false,
+      )
     : {};
 
   return {

lib/dep-graph-builders/types.ts

@@ -35,6 +35,7 @@ export type DepGraphBuildOptions = {
   strictOutOfSync: boolean;
   includePeerDeps?: boolean;
   pruneNpmStrictOutOfSync?: boolean;
+  honorAliases?: boolean;
 };
 
 export type LockFileParseOptions = {
@@ -50,13 +51,15 @@ export type YarnLockV2WorkspaceArgs = {
   isWorkspacePkg: boolean;
   isRoot: boolean;
   rootResolutions: Record<string, string>;
+  honorAliases?: boolean;
 };
 
 export type YarnLockV2ProjectParseOptions = {
   includeDevDeps: boolean;
   includeOptionalDeps: boolean;
   strictOutOfSync: boolean;
   pruneWithinTopLevelDeps: boolean;
+  honorAliases?: boolean;
 };
 
 /*
@@ -73,6 +76,7 @@ export type YarnLockV1ProjectParseOptions = {
   includePeerDeps: boolean;
   strictOutOfSync: boolean;
   pruneLevel: PruneLevel;
+  honorAliases?: boolean;
 };
 
 export type Yarn1DepGraphBuildOptions = {
@@ -81,6 +85,7 @@ export type Yarn1DepGraphBuildOptions = {
   includePeerDeps: boolean;
   strictOutOfSync: boolean;
   pruneWithinTopLevelDeps: boolean;
+  honorAliases?: boolean;
 };
 
 export type PnpmWorkspaceArgs = {

lib/dep-graph-builders/util.ts

@@ -50,18 +50,32 @@ export const getTopLevelDeps = (
     includeDevDeps: boolean;
     includeOptionalDeps?: boolean;
     includePeerDeps?: boolean;
+    honorAliases?: boolean;
   },
 ): Dependencies => {
-  const prodDeps = getGraphDependencies(pkgJson.dependencies || {}, false);
+  const { honorAliases = false } = options;
+  const prodDeps = getGraphDependencies(
+    pkgJson.dependencies || {},
+    false,
+    honorAliases,
+  );
 
-  const devDeps = getGraphDependencies(pkgJson.devDependencies || {}, true);
+  const devDeps = getGraphDependencies(
+    pkgJson.devDependencies || {},
+    true,
+    honorAliases,
+  );
 
   const optionalDeps = options.includeOptionalDeps
-    ? getGraphDependencies(pkgJson.optionalDependencies || {}, false)
+    ? getGraphDependencies(
+        pkgJson.optionalDependencies || {},
+        false,
+        honorAliases,
+      )
     : {};
 
   const peerDeps = options.includePeerDeps
-    ? getGraphDependencies(pkgJson.peerDependencies || {}, false)
+    ? getGraphDependencies(pkgJson.peerDependencies || {}, false, honorAliases)
     : {};
 
   const deps = { ...prodDeps, ...optionalDeps, ...peerDeps };
@@ -91,10 +105,24 @@ export const getTopLevelDeps = (
 export const getGraphDependencies = (
   dependencies: Record<string, string>,
   isDev,
+  isAliasSupportEnabled = false,
 ): Dependencies => {
   return Object.entries(dependencies).reduce(
     (pnpmDeps: Dependencies, [name, semver]) => {
-      pnpmDeps[name] = { version: semver, isDev: isDev };
+      const isAlias = semver.startsWith('npm:') && isAliasSupportEnabled;
+      if (isAlias) {
+        const aliasedName = semver.substring(4, semver.lastIndexOf('@'));
+
+        const aliasedVersion = semver.substring(
+          semver.lastIndexOf('@') + 1,
+          semver.length,
+        );
+
+        pnpmDeps[aliasedName] = { version: aliasedVersion, isDev: isDev };
+      } else {
+        pnpmDeps[name] = { version: semver, isDev: isDev };
+      }
+
       return pnpmDeps;
     },
     {},
@@ -121,6 +149,7 @@ export const getChildNode = (
   pkgs: NormalisedPkgs,
   strictOutOfSync: boolean,
   includeOptionalDeps: boolean,
+  honorAliases: boolean = false,
 ) => {
   const childNodeKey = `${name}@${depInfo.version}`;
   let childNode: PkgNode;
@@ -143,9 +172,14 @@ export const getChildNode = (
     const dependencies = getGraphDependencies(
       depData.dependencies || {},
       depInfo.isDev,
+      honorAliases,
     );
     const optionalDependencies = includeOptionalDeps
-      ? getGraphDependencies(depData.optionalDependencies || {}, depInfo.isDev)
+      ? getGraphDependencies(
+          depData.optionalDependencies || {},
+          depInfo.isDev,
+          honorAliases,
+        )
       : {};
     childNode = {
       id: `${name}@${depData.version}`,

lib/dep-graph-builders/yarn-lock-v1/build-depgraph-simple-pruned.ts

@@ -45,6 +45,7 @@ export const buildDepGraphYarnLockV1SimpleCyclesPruned = async (
     extractedYarnLockV1Pkgs,
     strictOutOfSync,
     includeOptionalDeps,
+    options.honorAliases ?? false,
   );
 
   return depGraphBuilder.build();
@@ -66,6 +67,7 @@ const dfsVisit = async (
   extractedYarnLockV1Pkgs: NormalisedPkgs,
   strictOutOfSync: boolean,
   includeOptionalDeps: boolean,
+  honorAliases: boolean = false,
 ): Promise<void> => {
   colorMap[node.id] = Color.GRAY;
 
@@ -81,6 +83,7 @@ const dfsVisit = async (
       strictOutOfSync,
 
       includeOptionalDeps,
+      honorAliases,
     );
 
     if (!colorMap.hasOwnProperty(childNode.id)) {

lib/dep-graph-builders/yarn-lock-v1/build-depgraph-simple.ts

@@ -15,6 +15,7 @@ export const buildDepGraphYarnLockV1Simple = async (
     includePeerDeps,
     strictOutOfSync,
     pruneWithinTopLevelDeps,
+    honorAliases = false,
   } = options;
 
   const depGraphBuilder = new DepGraphBuilder(
@@ -26,6 +27,7 @@ export const buildDepGraphYarnLockV1Simple = async (
     includeDevDeps,
     includePeerDeps,
     includeOptionalDeps,
+    honorAliases,
   });
 
   const rootNode: PkgNode = {
@@ -43,6 +45,7 @@ export const buildDepGraphYarnLockV1Simple = async (
     strictOutOfSync,
     includeOptionalDeps,
     pruneWithinTopLevelDeps,
+    honorAliases ?? false,
   );
 
   return depGraphBuilder.build();
@@ -61,6 +64,7 @@ const dfsVisit = async (
   strictOutOfSync: boolean,
   includeOptionalDeps: boolean,
   pruneWithinTopLevel: boolean,
+  honorAliases: boolean,
   visited?: Set<string>,
 ): Promise<void> => {
   for (const [name, depInfo] of Object.entries(node.dependencies || {})) {
@@ -74,6 +78,7 @@ const dfsVisit = async (
       extractedYarnLockV1Pkgs,
       strictOutOfSync,
       includeOptionalDeps,
+      honorAliases,
     );
 
     if (localVisited.has(childNode.id)) {
@@ -120,6 +125,7 @@ const dfsVisit = async (
       strictOutOfSync,
       includeOptionalDeps,
       pruneWithinTopLevel,
+      honorAliases,
       localVisited,
     );
   }

lib/dep-graph-builders/yarn-lock-v1/simple.ts

@@ -15,6 +15,7 @@ export const parseYarnLockV1Project = async (
     includePeerDeps,
     pruneLevel,
     strictOutOfSync,
+    honorAliases,
   } = options;
 
   const pkgs = extractPkgsFromYarnLockV1(yarnLockContent);
@@ -27,13 +28,15 @@ export const parseYarnLockV1Project = async (
           includeDevDeps,
           strictOutOfSync,
           includeOptionalDeps,
+          honorAliases,
         })
       : await buildDepGraphYarnLockV1Simple(pkgs, pkgJson, {
           includeDevDeps,
           includeOptionalDeps,
           includePeerDeps,
           strictOutOfSync,
           pruneWithinTopLevelDeps: pruneLevel === 'withinTopLevelDeps',
+          honorAliases,
         });
 
   return depGraph;

lib/dep-graph-builders/yarn-lock-v2/simple.ts

@@ -19,6 +19,7 @@ export const parseYarnLockV2Project = async (
     includeOptionalDeps,
     strictOutOfSync,
     pruneWithinTopLevelDeps,
+    honorAliases,
   } = options;
 
   const pkgs = extractPkgsFromYarnLockV2(yarnLockContent);
@@ -33,6 +34,7 @@ export const parseYarnLockV2Project = async (
       strictOutOfSync,
       includeOptionalDeps,
       pruneWithinTopLevelDeps,
+      honorAliases,
     },
     workspaceArgs,
   );

lib/index.ts

@@ -107,6 +107,7 @@ async function buildDepTree(
   lockfileType?: LockfileType,
   strictOutOfSync: boolean = true,
   defaultManifestFileName: string = 'package.json',
+  honorAliases?: boolean,
 ): Promise<PkgTree> {
   if (!lockfileType) {
     lockfileType = LockfileType.npm;
@@ -147,6 +148,7 @@ async function buildDepTree(
     lockFile,
     includeDev,
     strictOutOfSync,
+    honorAliases ?? false,
   );
 }
 
@@ -156,6 +158,7 @@ async function buildDepTreeFromFiles(
   lockFilePath: string,
   includeDev = false,
   strictOutOfSync = true,
+  honorAliases?: boolean,
 ): Promise<PkgTree> {
   if (!root || !manifestFilePath || !lockFilePath) {
     throw new Error('Missing required parameters for buildDepTreeFromFiles()');
@@ -198,6 +201,7 @@ async function buildDepTreeFromFiles(
     lockFileType,
     strictOutOfSync,
     manifestFilePath,
+    honorAliases ?? false,
   );
 }