Merge pull request #331 from orta/no_dt

Don't automatically recommend creating an issue on DefinitelyTyped

Author: orta

integration-tests/nested-scoped-packages/__snapshots__/nested-scoped-packages.test.ts.snap

@@ -8,10 +8,6 @@ patch-package 0.0.0
 • Diffing your files with clean files
 ✔ Created file patches/@microsoft+mezzurite-core++@types+angular+1.6.53.patch
 
-💡 @types/angular is on GitHub! To draft an issue based on your patch run
-
-    yarn patch-package @microsoft/mezzurite-core/@types/angular --create-issue
-
 END SNAPSHOT"
 `;
 

src/createIssue.test.ts

@@ -0,0 +1,28 @@
+import { shouldRecommendIssue } from "./createIssue"
+
+describe(shouldRecommendIssue, () => {
+  it("Allows most repos", () => {
+    const eigen = shouldRecommendIssue({
+      org: "artsy",
+      repo: "eigen",
+      provider: "GitHub",
+    })
+    expect(eigen).toBeTruthy()
+
+    const typescript = shouldRecommendIssue({
+      org: "Microsoft",
+      repo: "TypeScript",
+      provider: "GitHub",
+    })
+    expect(typescript).toBeTruthy()
+  })
+
+  it("does not recommend DefinitelyTyped", () => {
+    const typescript = shouldRecommendIssue({
+      org: "DefinitelyTyped",
+      repo: "DefinitelyTyped",
+      provider: "GitHub",
+    })
+    expect(typescript).toBeFalsy()
+  })
+})

src/createIssue.ts

@@ -46,12 +46,26 @@ function getPackageVCSDetails(packageDetails: PackageDetails) {
   }
 }
 
+export function shouldRecommendIssue(
+  vcsDetails: ReturnType<typeof getPackageVCSDetails>,
+) {
+  if (!vcsDetails) {
+    return true
+  }
+
+  const { repo, org } = vcsDetails
+  if (repo === "DefinitelyTyped" && org === "DefinitelyTyped") {
+    return false
+  }
+  return true
+}
+
 export function maybePrintIssueCreationPrompt(
   packageDetails: PackageDetails,
   packageManager: PackageManager,
 ) {
   const vcs = getPackageVCSDetails(packageDetails)
-  if (vcs) {
+  if (vcs && shouldRecommendIssue(vcs)) {
     console.log(`💡 ${chalk.bold(packageDetails.name)} is on ${
       vcs.provider
     }! To draft an issue based on your patch run