Ignore invalid ranges for external packages (#68)

* Ignore invalid ranges on external packates

* Finish things

* Update changeset

* Words

* Update ten-pens-fry.md

* docs

Author: emmatown

.changeset/ten-pens-fry.md

@@ -0,0 +1,5 @@
+---
+"@manypkg/cli": minor
+---
+
+Ignore invalid ranges on external dependencies to allow git and other types of dependencies and allow people to ignore the external mismatch rule for certain dependencies by making dependencies `npm:^1.0.0` instead of `^1.0.0`.

README.md

@@ -159,6 +159,12 @@ This example will not cause an error because the range `1.0.0` for `some-externa
 
 </details>
 
+### Ignoring this rule
+
+There are some cases where you might want to intentionally have conflicts between versions. To do this, you can use something that isn't a valid semver range instead of a range such as a git url or etc. If you'd like a conflicting version of an npm package, you can use `npm:your-range-here`.
+
+> Note: Do this with care, having different versions of the same package can lead to strange bugs
+
 ## Internal mismatch
 
 The ranges for all regular dependencies and optionalDependencies(not peerDependencies or devDependencies) on internal packages should include the version of the internal package.

package.json

@@ -14,12 +14,12 @@
     "@changesets/changelog-github": "^0.2.1",
     "@changesets/cli": "^2.5.0",
     "@types/fs-extra": "^8.0.1",
-    "@types/jest": "^24.0.17",
+    "@types/jest": "^26.0.4",
     "@types/normalize-path": "^3.0.0",
     "@types/parse-github-url": "^1.0.0",
     "@types/semver": "^6.0.1",
-    "jest": "^24.8.0",
-    "jest-watch-typeahead": "^0.4.2",
+    "jest": "^26.1.0",
+    "jest-watch-typeahead": "^0.6.0",
     "preconstruct": "^0.0.89",
     "typescript": "^3.5.3"
   },

packages/cli/src/checks/EXTERNAL_MISMATCH.ts

@@ -4,6 +4,7 @@ import {
   NORMAL_DEPENDENCY_TYPES
 } from "./utils";
 import { Package } from "@manypkg/get-packages";
+import { validRange } from "semver";
 
 type ErrorType = {
   type: "EXTERNAL_MISMATCH";
@@ -19,11 +20,16 @@ export default makeCheck<ErrorType>({
     let highestExternalRanges = getHighestExternalRanges(allWorkspace);
     for (let depType of NORMAL_DEPENDENCY_TYPES) {
       let deps = workspace.packageJson[depType];
+
       if (deps) {
         for (let depName in deps) {
           let range = deps[depName];
           let highestRange = highestExternalRanges.get(depName);
-          if (highestRange !== undefined && highestRange !== range) {
+          if (
+            highestRange !== undefined &&
+            highestRange !== range &&
+            validRange(range)
+          ) {
             errors.push({
               type: "EXTERNAL_MISMATCH",
               workspace,

packages/cli/src/checks/INVALID_DEV_AND_PEER_DEPENDENCY_RELATIONSHIP.ts

@@ -1,6 +1,7 @@
 import { makeCheck, getHighestExternalRanges } from "./utils";
 import { Package } from "@manypkg/get-packages";
 import { upperBoundOfRangeAWithinBoundsOfB } from "sembear";
+import semver from "semver";
 
 type ErrorType = {
   type: "INVALID_DEV_AND_PEER_DEPENDENCY_RELATIONSHIP";
@@ -38,6 +39,10 @@ export default makeCheck<ErrorType>({
             idealDevVersion
           });
         } else if (
+          semver.validRange(devDeps[depName]) &&
+          // TODO: we should probably error when a peer dep has an invalid range (in a seperate rule)
+          // (also would be good to do a bit more validation instead of just ignoring invalid ranges for normal dep types)
+          semver.validRange(peerDeps[depName]) &&
           !upperBoundOfRangeAWithinBoundsOfB(
             devDeps[depName],
             peerDeps[depName]

packages/cli/src/checks/__tests__/EXTERNAL_MISMATCH.ts

@@ -0,0 +1,60 @@
+import internalMismatch from "../EXTERNAL_MISMATCH";
+import { getWS, getFakeWS } from "../../test-helpers";
+
+let rootWorkspace = getFakeWS("root");
+
+it("should error if the ranges are valid and they are not equal", () => {
+  let ws = getWS();
+
+  ws.get("pkg-1")!.packageJson.dependencies = { something: "1.0.0" };
+
+  let pkg2 = getFakeWS("pkg-2");
+  pkg2.packageJson.dependencies = {
+    something: "2.0.0"
+  };
+  ws.set("pkg-2", pkg2);
+
+  let errors = internalMismatch.validate(pkg2, ws, rootWorkspace, {});
+  expect(errors.length).toEqual(0);
+
+  errors = internalMismatch.validate(ws.get("pkg-1")!, ws, rootWorkspace, {});
+  expect(errors.length).toEqual(1);
+  expect(errors).toMatchInlineSnapshot(`
+    Array [
+      Object {
+        "dependencyName": "something",
+        "dependencyRange": "1.0.0",
+        "highestDependencyRange": "2.0.0",
+        "type": "EXTERNAL_MISMATCH",
+        "workspace": Object {
+          "dir": "some/fake/dir/pkg-1",
+          "packageJson": Object {
+            "dependencies": Object {
+              "something": "1.0.0",
+            },
+            "name": "pkg-1",
+            "version": "1.0.0",
+          },
+        },
+      },
+    ]
+  `);
+});
+
+it("should not error if the value is not a valid semver range", () => {
+  let ws = getWS();
+
+  ws.get("pkg-1")!.packageJson.dependencies = { something: "1.0.0" };
+
+  let pkg2 = getFakeWS("pkg-2");
+  pkg2.packageJson.dependencies = {
+    something: "git:x"
+  };
+  ws.set("pkg-2", pkg2);
+
+  let errors = internalMismatch.validate(pkg2, ws, rootWorkspace, {});
+  expect(errors.length).toEqual(0);
+
+  errors = internalMismatch.validate(ws.get("pkg-1")!, ws, rootWorkspace, {});
+  expect(errors.length).toEqual(0);
+});

packages/cli/src/checks/__tests__/INVALID_DEV_AND_PEER_DEPENDENCY.ts

@@ -153,4 +153,32 @@ describe("invalid dev and peer dependency", () => {
     let errors = makeCheck.validate(pkg1, ws, rootWorkspace, {});
     expect(errors).toHaveLength(0);
   });
+
+  it("invalid range on peerDependencies", () => {
+    let ws = getWS();
+    let pkg1 = ws.get("pkg-1")!;
+
+    pkg1.packageJson.peerDependencies = {
+      "external-dep": "not a range"
+    };
+    pkg1.packageJson.devDependencies = {
+      "external-dep": "^1.1.0"
+    };
+    let errors = makeCheck.validate(pkg1, ws, rootWorkspace, {});
+    expect(errors).toHaveLength(0);
+  });
+
+  it("invalid range on devDependencies", () => {
+    let ws = getWS();
+    let pkg1 = ws.get("pkg-1")!;
+
+    pkg1.packageJson.peerDependencies = {
+      "external-dep": "^1.0.0"
+    };
+    pkg1.packageJson.devDependencies = {
+      "external-dep": "not a range"
+    };
+    let errors = makeCheck.validate(pkg1, ws, rootWorkspace, {});
+    expect(errors).toHaveLength(0);
+  });
 });

packages/cli/src/checks/utils.ts

@@ -1,4 +1,5 @@
 import { Package } from "@manypkg/get-packages";
+import * as semver from "semver";
 import { highest } from "sembear";
 
 export const NORMAL_DEPENDENCY_TYPES = [
@@ -126,6 +127,9 @@ export let getHighestExternalRanges = weakMemoize(function getHighestVersions(
       if (deps) {
         for (let depName in deps) {
           if (!allPackages.has(depName)) {
+            if (!semver.validRange(deps[depName])) {
+              continue;
+            }
             let highestExternalRange = highestExternalRanges.get(depName);
             if (
               !highestExternalRange ||