Merge pull request #660 from TobyAndToby/tb/ignore-dotprefixed-dirs

Ignore dot-prefixed directories in node_modules

Author: tobysmith568

src/packages/generate-license-file/src/lib/internal/resolveDependencies/resolveNpmDependencies.ts

@@ -26,7 +26,7 @@ export const resolveDependenciesForNpmProject = async (
   const topNode = await arborist.loadActual();
 
   const parseNode = async (node: Node | Link) => {
-    if (node.dev || node.peer) {
+    if (node.dev || node.peer || node.name.startsWith(".")) {
       return;
     }
 

src/packages/generate-license-file/test/internal/resolveDependencies/resolveNpmDependencies.spec.ts

@@ -81,13 +81,15 @@ describe("resolveNpmDependencies", () => {
           pkgid: `${child1Name}@${child1Version}`,
           realpath: child1Realpath,
           package: { name: child1Name, version: child1Version },
+          name: child1Name,
           children: new Map([
             [
               child1_1Name,
               {
                 pkgid: `${child1_1Name}@${child1_1Version}`,
                 realpath: child1_1Realpath,
                 package: { name: child1_1Name, version: child1_1Version },
+                name: child1_1Name,
                 children: new Map(),
                 dev: false,
                 peer: false,
@@ -99,6 +101,7 @@ describe("resolveNpmDependencies", () => {
                 pkgid: `${child1_2Name}@${child1_2Version}`,
                 realpath: child1_2Realpath,
                 package: { name: child1_2Name, version: child1_2Version },
+                name: child1_2Name,
                 children: new Map(),
                 dev: false,
                 peer: false,
@@ -115,13 +118,15 @@ describe("resolveNpmDependencies", () => {
           pkgid: `${child2Name}@${child2Version}`,
           realpath: child2Realpath,
           package: { name: child2Name, version: child2Version },
+          name: child2Name,
           children: new Map([
             [
               child2_1Name,
               {
                 pkgid: `${child2_1Name}@${child2_1Version}`,
                 realpath: child2_1Realpath,
                 package: { name: child2_1Name, version: child2_1Version },
+                name: child2_1Name,
                 children: new Map(),
                 dev: false,
                 peer: false,
@@ -138,13 +143,15 @@ describe("resolveNpmDependencies", () => {
           pkgid: `${child3Name}@${child3Version}`,
           realpath: child3Realpath,
           package: { name: child3Name, version: child3Version },
+          name: child3Name,
           children: new Map([
             [
               child3_1Name,
               {
                 pkgid: `${child3_1Name}@${child3_1Version}`,
                 realpath: child3_1Realpath,
                 package: { name: child3_1Name, version: child3_1Version },
+                name: child3_1Name,
                 children: new Map(),
                 dev: false,
                 peer: false,
@@ -340,6 +347,7 @@ describe("resolveNpmDependencies", () => {
         pkgid: `${optionalName}@${optionalVersion}`,
         realpath: optionalRealpath,
         package: { name: optionalName, version: optionalVersion },
+        name: optionalName,
         children: new Map(),
         dev: false,
         peer: false,
@@ -382,6 +390,7 @@ describe("resolveNpmDependencies", () => {
         pkgid: `${missingName}@${missingVersion}`,
         realpath: missingRealpath,
         package: { name: missingName, version: missingVersion },
+        name: missingName,
         children: new Map(),
         dev: false,
         peer: false,
@@ -448,6 +457,49 @@ describe("resolveNpmDependencies", () => {
       ).toBeDefined();
     });
   });
+  describe("when a directory inside node_modules starts with '.'", () => {
+    const dotDirName = ".dotdir";
+    const dotDirVersion = "0.0.0";
+    const dotDirRealpath = "/some/path/.dotdir";
+
+    it("should skip it without attempting to read its package.json", async () => {
+      const licensesMap = new Map<LicenseNoticeKey, ResolvedLicense>();
+
+      const dotDirNode = {
+        pkgid: `${dotDirName}@${dotDirVersion}`,
+        realpath: dotDirRealpath,
+        package: { name: dotDirName, version: dotDirVersion },
+        name: dotDirName,
+        children: new Map(),
+        dev: false,
+        peer: false,
+        optional: true,
+      } as unknown as Arborist.Node;
+
+      const topNodeWithDotName: Arborist.Node = {
+        children: new Map([
+          ...Array.from(topNode.children.entries()),
+          [dotDirName, dotDirNode as unknown as Arborist.Node],
+        ]),
+      } as Arborist.Node;
+
+      mockedArborist.mockImplementationOnce(
+        () => ({ loadActual: async () => topNodeWithDotName }) as Arborist,
+      );
+
+      await resolveDependenciesForNpmProject("/some/path/package.json", licensesMap);
+
+      const keys = Array.from(licensesMap.keys());
+      expect(keys.some(k => k.includes(dotDirName))).toBe(false);
+      expect(
+        mockedDoesFileExist.mock.calls.some(call => (call[0] as string).includes(dotDirRealpath)),
+      ).toBe(false);
+      expect(
+        mockedReadFile.mock.calls.some(call => (call[0] as string).includes(dotDirRealpath)),
+      ).toBe(false);
+      expect(mockedLogger.warn).not.toHaveBeenCalled();
+    });
+  });
 
   const setUpPackageJson = (directory: string, name: string, version: string): void => {
     const fullPackageJsonPath = join(directory, "package.json");