feat: clarify Pkg.version type (undefined instead of null)

Author: Konstantin Yegupov

README.md

@@ -49,21 +49,21 @@ export interface DepGraph {
   };
   readonly rootPkg: {
     name: string;
-    version: string | null;
+    version?: string;
   };
   // all unique packages in the graph (including root package)
   getPkgs(): Array<{
     name: string;
-    version: string | null;
+    version?: string;
   }>;
   // all unique packages in the graph, except the root package
   getDepPkgs(): Array<{
     name: string;
-    version: string | null;
+    version?: string;
   }>;
   pkgPathsToRoot(pkg: Pkg): Array<Array<{
     name: string;
-    version: string | null;
+    version?: string;
   }>>;
   countPathsToRoot(pkg: Pkg): number;
   toJSON(): DepGraphData;
@@ -89,7 +89,7 @@ export interface DepGraphData {
     id: string;
     info: {
       name: string;
-      version: string | null;
+      version?: string;
     };
   }>;
   graph: {

src/core/create-from-json.ts

@@ -22,8 +22,7 @@ export function createFromJSON(depGraphData: DepGraphData): DepGraph {
   const pkgNodes: {[pkgId: string]: Set<string>} = {};
 
   for (const { id, info } of depGraphData.pkgs) {
-    // TODO: avoid this, instead just use `info` as is
-    pkgs[id] = info.version ? info : { ...info, version: null } as any;
+    pkgs[id] = info;
   }
 
   for (const node of depGraphData.graph.nodes) {

src/core/dep-graph.ts

@@ -161,6 +161,10 @@ class DepGraphImpl implements types.DepGraphInternal {
       otherDepGraph = createFromJSON(other.toJSON()) as types.DepGraphInternal;
     }
 
+    // In theory, for the graphs created by standard means, `_.isEquals(this._data, otherDepGraph._data)`
+    // should suffice, since node IDs will be generated in a predictable way.
+    // However, to support unconventional node IDs, we run our own deep
+    // comparison.
     return this.nodeEquals(this, this.rootNodeId, otherDepGraph, otherDepGraph.rootNodeId, compareRoot);
   }
 

test/core/create-from-json.test.ts

@@ -759,10 +759,10 @@ test('fromJSON a pkg missing version field', () => {
   const depGraph = depGraphLib.createFromJSON(graphJson as any);
   expect(depGraph.getPkgs().sort()).toEqual([
     { name: 'toor', version: '1.0.0' },
-    { name: 'foo', version: null },
+    { name: 'foo' },
   ]);
   expect(depGraph.getDepPkgs().sort()).toEqual([
-    { name: 'foo', version: null },
+    { name: 'foo' },
   ]);
 });