[WIP] rules: add rule to check for jira id (not on by default)

rules/common/__tests__/hasJiraID.test.ts

@@ -0,0 +1,47 @@
+jest.mock("danger", () => jest.fn())
+import * as danger from "danger"
+const dm = danger as any
+
+import hasJiraID from "../hasJiraID"
+
+const errorMessage =
+  "The title of this PR does not contain a JIRA ID. Please consider including one so that this work is linked to the correct JIRA ticket. Expected format: ABC-123"
+
+beforeEach(() => {
+  dm.warn = jest.fn()
+})
+
+it("warns when PR title has no JIRA ID", () => {
+  dm.danger = { github: { pr: { title: "My awesome PR title" } } }
+
+  hasJiraID()
+  expect(dm.warn).toHaveBeenLastCalledWith(errorMessage)
+})
+
+describe("warns if PR title has jira id in the wrong format", () => {
+  it("[ABC-1234] ...", () => {
+    dm.danger = { github: { pr: { title: "[ABC-1234] My awesome PR title" } } }
+    hasJiraID()
+    expect(dm.warn).toHaveBeenLastCalledWith(errorMessage)
+  })
+
+  it("... (ABC-123)", () => {
+    dm.danger = { github: { pr: { title: "Awesome PR (ABC-123)" } } }
+    hasJiraID()
+    expect(dm.warn).toHaveBeenLastCalledWith(errorMessage)
+  })
+})
+
+describe("does not warn if title does have a JIRA ID in the correct format", () => {
+  it("ABC-123 ...", () => {
+    dm.danger = { github: { pr: { title: "ABC-123 - My awesome PR title" } } }
+    hasJiraID()
+    expect(dm.warn).not.toHaveBeenCalled()
+  })
+
+  it("AB-123 ...", () => {
+    dm.danger = { github: { pr: { title: "AB-123 - My awesome PR title" } } }
+    hasJiraID()
+    expect(dm.warn).not.toHaveBeenCalled()
+  })
+})

rules/common/hasJiraID.ts

@@ -0,0 +1,15 @@
+import { danger, warn } from "danger"
+
+const hasJiraID = () => {
+  const pr = danger.github.pr
+  const pattern = /^\w{2,4}-\d+/g
+  const found = pattern.test(pr.title)
+
+  if (!found) {
+    warn(
+      "The title of this PR does not contain a JIRA ID. Please consider including one so that this work is linked to the correct JIRA ticket. Expected format: ABC-123"
+    )
+  }
+}
+
+export default hasJiraID