feat: support multiple JIRA projects (#26)

resolves #24

Author: macklinu

.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "prettier.trailingComma": "es5",
+  "prettier.semi": false,
+  "prettier.singleQuote": true
+}

README.md

@@ -49,6 +49,17 @@ With JIRA-123 in the PR title, Danger will comment with:
   Generated by :no_entry_sign: <a href="http://github.com/danger/danger-js/">dangerJS</a>
 </p>
 
+If you work with multiple JIRA project boards, you can supply multiple project keys:
+
+```js
+jiraIssue({
+  key: ['ABC', 'DEF'],
+  url: 'https://myjira.atlassian.net/browse',
+})
+```
+
+This plugin will recognize issues starting with those keys (e.g. `ABC-123` and `DEF-234`).
+
 See the [documentation](http://macklinu.github.io/danger-plugin-jira-issue) for detailed information.
 
 ## Changelog

package.json

@@ -4,9 +4,7 @@
   "description": "Danger plugin to link JIRA issue in pull request",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
+  "files": ["dist"],
   "scripts": {
     "precommit": "lint-staged",
     "commit": "git-cz",
@@ -19,17 +17,14 @@
     "test": "jest --env=node",
     "predocs": "rm -rf docs/",
     "prepublish": "npm run build",
-    "semantic-release": "semantic-release pre && npm publish && semantic-release post"
+    "semantic-release":
+      "semantic-release pre && npm publish && semantic-release post"
   },
   "repository": {
     "type": "git",
     "url": "https://github.com/macklinu/danger-plugin-jira-issue.git"
   },
-  "keywords": [
-    "danger",
-    "danger-plugin",
-    "jira"
-  ],
+  "keywords": ["danger", "danger-plugin", "jira"],
   "author": "Macklin Underdown <macklinu@gmail.com>",
   "license": "MIT",
   "bugs": {
@@ -48,9 +43,11 @@
     "husky": "^0.14.1",
     "jest": "^20.0.4",
     "lint-staged": "^4.0.0",
+    "prettier": "^1.7.0",
     "semantic-release": "^6.3.6",
     "ts-jest": "^20.0.5",
     "tslint": "^5.4.2",
+    "tslint-config-prettier": "^1.5.0",
     "typedoc": "^0.7.1",
     "typescript": "^2.5.2",
     "validate-commit-msg": "^2.12.1"
@@ -63,21 +60,14 @@
       ".(ts|tsx)": "<rootDir>/node_modules/ts-jest/preprocessor.js"
     },
     "testRegex": "(/__tests__/.*|\\.(test|spec))\\.(ts|tsx|js)$",
-    "moduleFileExtensions": [
-      "ts",
-      "tsx",
-      "js"
-    ]
+    "moduleFileExtensions": ["ts", "tsx", "js"]
   },
   "config": {
     "commitizen": {
       "path": "cz-conventional-changelog"
     }
   },
   "lint-staged": {
-    "*.ts": [
-      "tslint --fix",
-      "git add"
-    ]
+    "*.ts": ["tslint --fix", "git add"]
   }
 }

src/index.test.ts

@@ -26,7 +26,7 @@ describe('jiraIssue()', () => {
       url: 'https://jira.net/browse',
     })
     expect(global.warn).toHaveBeenCalledWith(
-      'Please add the JIRA issue key to the PR title (e.g. ABC-123)',
+      'Please add the JIRA issue key to the PR title (e.g. ABC-123)'
     )
   })
   it('adds the JIRA issue link to the messages table', () => {
@@ -38,7 +38,7 @@ describe('jiraIssue()', () => {
       url: 'https://jira.net/browse',
     })
     expect(global.message).toHaveBeenCalledWith(
-      ':link: <a href="https://jira.net/browse/ABC-808">ABC-808</a>',
+      ':link: <a href="https://jira.net/browse/ABC-808">ABC-808</a>'
     )
   })
   it('properly concatenates URL parts (trailing slash in url)', () => {
@@ -50,7 +50,7 @@ describe('jiraIssue()', () => {
       url: 'https://jira.net/browse/',
     })
     expect(global.message).toHaveBeenCalledWith(
-      ':link: <a href="https://jira.net/browse/ABC-808">ABC-808</a>',
+      ':link: <a href="https://jira.net/browse/ABC-808">ABC-808</a>'
     )
   })
   it('matches JIRA issue anywhere in title', () => {
@@ -60,7 +60,7 @@ describe('jiraIssue()', () => {
       url: 'https://jira.net/browse',
     })
     expect(global.message).toHaveBeenCalledWith(
-      ':link: <a href="https://jira.net/browse/ABC-123">ABC-123</a>',
+      ':link: <a href="https://jira.net/browse/ABC-123">ABC-123</a>'
     )
   })
   it('does not match lowercase JIRA key in PR title', () => {
@@ -81,7 +81,7 @@ describe('jiraIssue()', () => {
       url: 'https://jira.net/browse',
     })
     expect(global.message).toHaveBeenCalledWith(
-      ':paperclip: <a href="https://jira.net/browse/ABC-123">ABC-123</a>',
+      ':paperclip: <a href="https://jira.net/browse/ABC-123">ABC-123</a>'
     )
   })
   it('supports multiple JIRA keys in PR title', () => {
@@ -93,8 +93,19 @@ describe('jiraIssue()', () => {
       url: 'https://jira.net/browse',
     })
     expect(global.message).toHaveBeenCalledWith(
-      // tslint:disable-next-line:max-line-length
-      ':link: <a href="https://jira.net/browse/ABC-123">ABC-123</a>, <a href="https://jira.net/browse/ABC-456">ABC-456</a>',
+      ':link: <a href="https://jira.net/browse/ABC-123">ABC-123</a>, <a href="https://jira.net/browse/ABC-456">ABC-456</a>'
+    )
+  })
+  it('supports multiple JIRA boards in PR title', () => {
+    global.danger = {
+      github: { pr: { title: '[ABC-123][DEF-456] Change some things' } },
+    }
+    jiraIssue({
+      key: ['ABC', 'DEF'],
+      url: 'https://jira.net/browse',
+    })
+    expect(global.message).toHaveBeenCalledWith(
+      ':link: <a href="https://jira.net/browse/ABC-123">ABC-123</a>, <a href="https://jira.net/browse/DEF-456">DEF-456</a>'
     )
   })
 })

src/index.ts

@@ -1,8 +1,11 @@
 import { resolve } from 'url'
 
 export interface Options {
-  /** The JIRA issue key (e.g. the ABC in ABC-123). */
-  key: string
+  /**
+   * The JIRA issue key(s) (e.g. the ABC in ABC-123).
+   * Supports multiple JIRA projects (e.g. `['ABC', 'DEF']`).
+   */
+  key: string | string[]
   /** The JIRA instance issue base URL (e.g. https://jira.atlassian.com/browse/). */
   url: string
   /**
@@ -14,11 +17,12 @@ export interface Options {
   emoji?: string
 }
 
-const link = (href: string, text: string): string => `<a href="${href}">${text}</a>`
+const link = (href: string, text: string): string =>
+  `<a href="${href}">${text}</a>`
 
 const ensureUrlEndsWithSlash = (url: string) => {
   if (!url.endsWith('/')) {
-      return url.concat('/')
+    return url.concat('/')
   }
   return url
 }
@@ -38,7 +42,10 @@ export default function jiraIssue(options: Options) {
     throw Error(`'key' missing - must supply JIRA issue key`)
   }
 
-  const jiraKeyRegex = new RegExp(`(${key}-[0-9]+)`, 'g')
+  // Support multiple JIRA projects.
+  const keys = Array.isArray(key) ? `(${key.join('|')})` : key
+
+  const jiraKeyRegex = new RegExp(`(${keys}-[0-9]+)`, 'g')
   let match
   const jiraIssues = []
   // tslint:disable-next-line:no-conditional-assignment
@@ -47,7 +54,7 @@ export default function jiraIssue(options: Options) {
   }
   if (jiraIssues.length > 0) {
     const jiraUrls = jiraIssues
-      .map((issue) => link(resolve(ensureUrlEndsWithSlash(url), issue), issue))
+      .map(issue => link(resolve(ensureUrlEndsWithSlash(url), issue), issue))
       .join(', ')
     message(`${emoji} ${jiraUrls}`)
   } else {

tslint.json

@@ -1,10 +1,6 @@
 {
-  "extends": [
-    "tslint:recommended"
-  ],
+  "extends": ["tslint:recommended", "tslint-config-prettier"],
   "rules": {
-    "interface-name": [true, "never-prefix"],
-    "semicolon": [true, "never"],
-    "quotemark": [true, "single"]
+    "interface-name": [true, "never-prefix"]
   }
 }

yarn.lock

@@ -3249,6 +3249,10 @@ preserve@^0.2.0:
   version "0.2.0"
   resolved "https://registry.yarnpkg.com/preserve/-/preserve-0.2.0.tgz#815ed1f6ebc65926f865b310c0713bcb3315ce4b"
 
+prettier@^1.7.0:
+  version "1.7.0"
+  resolved "https://registry.yarnpkg.com/prettier/-/prettier-1.7.0.tgz#47481588f41f7c90f63938feb202ac82554e7150"
+
 pretty-format@^20.0.1:
   version "20.0.1"
   resolved "https://registry.yarnpkg.com/pretty-format/-/pretty-format-20.0.1.tgz#ba95329771907c189643dd251e244061ff642350"
@@ -4056,6 +4060,10 @@ tslib@^1.7.1:
   version "1.7.1"
   resolved "https://registry.yarnpkg.com/tslib/-/tslib-1.7.1.tgz#bc8004164691923a79fe8378bbeb3da2017538ec"
 
+tslint-config-prettier@^1.5.0:
+  version "1.5.0"
+  resolved "https://registry.yarnpkg.com/tslint-config-prettier/-/tslint-config-prettier-1.5.0.tgz#76645425edcc34d9b6835ba58266eaf90fdbfeda"
+
 tslint@^5.4.2:
   version "5.4.2"
   resolved "https://registry.yarnpkg.com/tslint/-/tslint-5.4.2.tgz#609b6640cc0424f4a395a9adf68c375563c549c7"