asciidoctor-jira 0.0.1

package/README.md

@@ -0,0 +1,26 @@
+# Asciidoctor Jira Extension
+
+[![CI](https://github.com/uniqueck/asciidoctor-jira/actions/workflows/build-js.yml/badge.svg?branch=main)](https://github.com/uniqueck/asciidoctor-jira/actions/workflows/build-js.yml)
+
+A set of macros for [Asciidoctor.js](https://github.com/asciidoctor/asciidoctor.js) to integrate Jira!
+
+  * [Install](#install)
+    + [Antora Integration](#antora-integration)
+
+## Install
+
+### Antora Integration
+
+If you are using [Antora](https://antora.org/), you can integrate Jira in your documentation site.
+
+Install the extension in your playbook project:
+
+    $ npm i asciidoctor-jira
+
+Register the extension in your playbook file:
+
+  ```yaml
+  asciidoc:
+    extensions:
+      - asciidoctor-jira
+  ```

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "asciidoctor-jira",
+  "author": "Constantin Krüger (https://github.com/uniqueck)",
+  "license": "MIT",
+  "version": "0.0.1",
+  "bugs": {
+    "url": "https://github.com/doctoolchain/asciidoctor-jira/issues"
+  },
+  "files": [
+    "src"
+  ],
+  "keywords": [
+    "asciidoctor",
+    "jira",
+    "javascript",
+    "extension"
+  ],
+  "main": "src/asciidoctor-jira.js",
+  "devDependencies": {
+    "@antora/site-generator-default": "^2.3.3",
+    "@asciidoctor/core": "^2.2.0",
+    "chai": "^4.3.4",
+    "cheerio": "0.22.0",
+    "dotenv": "^10.0.0",
+    "jest": "27.2",
+    "mocha": "^9.0.0",
+    "rimraf": "^3.0.2",
+    "shx": "^0.3.3",
+    "standard": "^16.0.2",
+    "sync-request": "^6.1.0"
+  },
+  "peerDependencies": {
+    "@asciidoctor/core": "^2.2.0"
+  },
+  "scripts": {
+    "test": "npm run test:antora",
+    "test:antora": "mocha --reporter json --reporter-option output=test-results.json test/antora/**.spec.js",
+    "lint": "standard src/**.js",
+    "lint-fix": "npm run lint -- --fix",
+    "clean": "shx rm -rf dist/*"
+  },
+  "engines": {
+    "node": ">=10"
+  }
+}

package/src/Jira.js

@@ -0,0 +1,58 @@
+
+const request = require('sync-request')
+
+class Jira {
+  constructor (doc) {
+    this.doc = doc
+  }
+
+  searchIssues (jql) {
+    const data = { jql: jql, fields: 'created,resolutiondate,priority,summary,timeoriginalestimate,assignee,issuetype' }
+    let issues
+    try {
+      const jiraBaseUrl = this.doc.getAttribute('jira-host') || process.env.AJE_JIRABASEURL
+      const jiraRestApiSearchEndpoint = jiraBaseUrl + '/rest/api/2/search'
+      const jiraUserName = this.doc.getAttribute('jira-username') || process.env.AJE_USERNAME
+      const jiraApiToken = this.doc.getAttribute('jira-apitoken') || process.env.AJE_APITOKEN || process.env.AJE_PASSWORD
+      const auth = 'Basic ' + Buffer.from(jiraUserName + ':' + jiraApiToken).toString('base64')
+      const headers = {
+        authorization: auth
+      }
+      const res = request('GET', jiraRestApiSearchEndpoint, {
+        headers: headers,
+        qs: data
+      })
+      issues = JSON.parse(res.getBody('utf-8')).issues
+    } catch (err) {
+      console.log(err)
+      issues = null
+    }
+    return issues
+  }
+
+  searchIssue (issueKey) {
+    const data = { jql: 'issueKey=' + issueKey, fields: 'created,resolutiondate,priority,summary,timeoriginalestimate,assignee,issuetype' }
+    let result
+    try {
+      const jiraBaseUrl = this.doc.getAttribute('jira-host') || process.env.AJE_JIRABASEURL
+      const jiraRestApiSearchEndpoint = jiraBaseUrl + '/rest/api/2/search'
+      const jiraUserName = this.doc.getAttribute('jira-username') || process.env.AJE_USERNAME
+      const jiraApiToken = this.doc.getAttribute('jira-apitoken') || process.env.AJE_APITOKEN || process.env.AJE_PASSWORD
+      const auth = 'Basic ' + Buffer.from(jiraUserName + ':' + jiraApiToken).toString('base64')
+      const headers = {
+        authorization: auth
+      }
+      const res = request('GET', jiraRestApiSearchEndpoint, {
+        headers: headers,
+        qs: data
+      })
+      result = JSON.parse(res.getBody('utf-8')).issues[0]
+    } catch (err) {
+      console.log(err)
+      result = null
+    }
+    return result
+  }
+}
+
+module.exports = Jira

package/src/asciidoctor-jira.js

@@ -0,0 +1,76 @@
+/* global
+  Opal
+*/
+
+// @ts-check
+const Jira = require('./Jira.js')
+require('dotenv').config()
+
+function jiraIssuesBlockMacro (context) {
+  return function () {
+    const self = this
+    self.named('jira')
+    self.positionalAttributes(['jql'])
+    self.process((parent, target, attrs) => {
+      const doc = parent.getDocument()
+      const jql = attrs.jql || "resolution='Unresolved' ORDER BY priority DESC, key ASC, duedate ASC"
+      const jiraClient = new Jira(doc)
+      const issues = jiraClient.searchIssues(jql)
+
+      const content = []
+      content.push('[options="header",cols="2,1,1,2,6"]')
+      content.push('|====')
+      content.push('|ID | Priority | Created | Assignee | Summary')
+
+      for (let i = 0; i < issues.length; i++) {
+        const issue = issues[i]
+        content.push('a|jira:' + issue.key + '[]')
+        content.push('|' + issue.fields.priority.name)
+        content.push('|' + issue.fields.created)
+        const assignee = issue.fields.assignee ? issue.fields.assignee.displayName : 'not assigned'
+        content.push('|' + assignee)
+        content.push('|' + issue.fields.summary)
+      }
+      content.push('|====')
+
+      self.parseContent(parent, content.join('\n'), Opal.hash(attrs))
+
+      return undefined
+    })
+  }
+}
+
+function jiraIssueInlineMacro (context) {
+  return function () {
+    const self = this
+    self.named('jira')
+    self.positionalAttributes(['format'])
+    self.process((parent, target, attrs) => {
+      const doc = parent.getDocument()
+      const displayFormat = attrs.format || doc.getAttribute('jira-inline-format') || 'short'
+      const issueKey = target
+      const jiraClient = new Jira(doc)
+      const issue = jiraClient.searchIssue(issueKey)
+      let title = issueKey
+      if (displayFormat === 'long') {
+        title += issue.fields.summary
+      }
+      const jiraBaseUrl = doc.getAttribute('jira-host') || process.env.AJE_JIRABASEURL
+      const issueLink = jiraBaseUrl + '/browse/' + issueKey
+      return self.createInline(parent, 'anchor', title, { type: 'link', target: issueLink }).convert()
+    })
+  }
+}
+
+module.exports.register = function register (registry, context = {}) {
+  if (typeof registry.register === 'function') {
+    registry.register(function () {
+      this.blockMacro(jiraIssuesBlockMacro(context))
+      this.inlineMacro(jiraIssueInlineMacro(context))
+    })
+  } else if (typeof registry.block === 'function') {
+    registry.blockMacro(jiraIssuesBlockMacro(context))
+    registry.inlineMacro(jiraIssueInlineMacro(context))
+  }
+  return registry
+}