feat(options): add location to options (#44)

- location can be either the PR title or the git branch name

README.md

@@ -26,7 +26,8 @@ jiraIssue({
   format(emoji, jiraUrls) {
     // Optional Formatter
     return "Some Custom Message";
-  }
+  },
+  location: "title" // Optional location, either 'title' or 'branch'
 });
 ```
 

src/index.test.ts

@@ -125,4 +125,17 @@ describe("jiraIssue()", () => {
       ':link: JIRA Tickets: <a href="https://jira.net/browse/ABC-123">ABC-123</a>, <a href="https://jira.net/browse/DEF-456">DEF-456</a>'
     );
   });
+  it("supports JIRA key in the git branch", () => {
+    global.danger = {
+      github: { pr: { head: { ref: "ABC-808/some-things" } } }
+    };
+    jiraIssue({
+      key: "ABC",
+      location: "branch",
+      url: "https://jira.net/browse"
+    });
+    expect(global.message).toHaveBeenCalledWith(
+      ':link: <a href="https://jira.net/browse/ABC-808">ABC-808</a>'
+    );
+  });
 });

src/index.ts

@@ -22,6 +22,11 @@ export interface Options {
    * @returns {string}
    */
   format?: (emoji: string, jiraUrls: string[]) => string;
+  /**
+   * The location of the JIRA issue, either the PR title, or the git branch
+   * Defaults to `title`
+   */
+  location?: "title" | "branch";
 }
 
 const link = (href: string, text: string): string =>
@@ -41,7 +46,8 @@ const ensureUrlEndsWithSlash = (url: string) => {
  * to include the JIRA issue identifier in the pull request title.
  */
 export default function jiraIssue(options: Options) {
-  const { key = "", url = "", emoji = ":link:" } = options || {};
+  const { key = "", url = "", emoji = ":link:", location = "title" } =
+    options || {};
   if (!url) {
     throw Error(`'url' missing - must supply JIRA installation URL`);
   }
@@ -56,8 +62,26 @@ export default function jiraIssue(options: Options) {
   let match;
   const jiraIssues = [];
   // tslint:disable-next-line:no-conditional-assignment
-  while ((match = jiraKeyRegex.exec(danger.github.pr.title)) != null) {
+  let jiraLocation;
+  switch (location) {
+    case "title": {
+      jiraLocation = danger.github.pr.title;
+      break;
+    }
+    case "branch": {
+      jiraLocation = danger.github.pr.head.ref;
+      break;
+    }
+    default: {
+      throw Error(
+        `Invalid value for 'location', must be either "title" or "branch"`
+      );
+    }
+  }
+  match = jiraKeyRegex.exec(jiraLocation);
+  while (match != null) {
     jiraIssues.push(match[0]);
+    match = jiraKeyRegex.exec(jiraLocation);
   }
   if (jiraIssues.length > 0) {
     const jiraUrls = jiraIssues.map(issue =>
@@ -71,6 +95,8 @@ export default function jiraIssue(options: Options) {
       message(`${emoji} ${jiraUrls.join(", ")}`);
     }
   } else {
-    warn(`Please add the JIRA issue key to the PR title (e.g. ${key}-123)`);
+    warn(
+      `Please add the JIRA issue key to the PR ${location} (e.g. ${key}-123)`
+    );
   }
 }