fix: allow peer dep of a dep to be in devdep

fixes #323
christophehurpeau · Jul 7, 2022 · 4e36aa8 · 4e36aa8
1 parent 2ec0e5b
commit 4e36aa8
Show file tree

Hide file tree

Showing 2 changed files with 66 additions and 2 deletions.
diff --git a/src/checks/checkDirectPeerDependencies.test.ts b/src/checks/checkDirectPeerDependencies.test.ts
@@ -1,3 +1,4 @@
+/* eslint-disable max-lines */
 import { createReportError } from '../utils/createReportError';
 import { createOnlyWarnsForMappingCheck } from '../utils/warnForUtils';
 import { checkDirectPeerDependencies } from './checkDirectPeerDependencies';
@@ -182,4 +183,64 @@ describe('checkDirectPeerDependencies', () => {
     );
     expect(mockReportError).not.toHaveBeenCalled();
   });
+
+  it('should not report error when @types is in dev dependency of an app', () => {
+    checkDirectPeerDependencies(
+      false,
+      {
+        name: 'test',
+        dependencies: {
+          'some-lib-using-types': '1.0.0',
+        },
+        devDependencies: {
+          '@types/a': '1.0.0',
+        },
+      },
+      'path',
+      jest
+        .fn()
+        .mockImplementationOnce(() => ({
+          name: '@types/a',
+        }))
+        .mockImplementationOnce(() => ({
+          name: 'some-lib-using-types',
+          peerDependencies: { '@types/a': '^1.0.0' },
+        })),
+      createOnlyWarnsForMappingCheck('test', []),
+      createOnlyWarnsForMappingCheck('test', []),
+    );
+    expect(mockReportError).not.toHaveBeenCalled();
+  });
+
+  it('should not report error when @types is missing in dependencies/peerDependency of a library', () => {
+    checkDirectPeerDependencies(
+      true,
+      {
+        name: 'test',
+        dependencies: {
+          'some-lib-using-types': '1.0.0',
+        },
+        devDependencies: {
+          '@types/a': '1.0.0',
+        },
+      },
+      'path',
+      jest
+        .fn()
+        .mockImplementationOnce(() => ({
+          name: '@types/a',
+        }))
+        .mockImplementationOnce(() => ({
+          name: 'some-lib-using-types',
+          peerDependencies: { '@types/a': '^1.0.0' },
+        })),
+      createOnlyWarnsForMappingCheck('test', []),
+      createOnlyWarnsForMappingCheck('test', []),
+    );
+    expect(mockReportError).toHaveBeenCalledWith(
+      'Missing "@types/a" peer dependency from "some-lib-using-types" in dependencies',
+      'it should satisfies "^1.0.0" and be in dependencies or peerDependencies',
+      false,
+    );
+  });
 });
diff --git a/src/checks/checkDirectPeerDependencies.ts b/src/checks/checkDirectPeerDependencies.ts
@@ -26,10 +26,13 @@ const getAllowedPeerInFromType = (
     case 'devDependencies':
       return ['devDependencies', 'dependencies'];
     case 'dependencies':
-    case 'optionalDependencies':
       return isLibrary
         ? ['dependencies', 'peerDependencies']
-        : ['dependencies'];
+        : ['devDependencies', 'dependencies'];
+    case 'optionalDependencies':
+      return isLibrary
+        ? ['dependencies', 'optionalDependencies', 'peerDependencies']
+        : ['devDependencies', 'dependencies'];
   }
 };