1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
|
;;; ox-jira.el --- JIRA Backend for Org Export Engine
;; Copyright (C) 2016-2020 Stig Brautaset
;; Author: Stig Brautaset <stig@brautaset.org>
;; Version: 0.1-SNAPSHOT
;; Keywords: outlines, hypermedia, wp
;; Homepage: https://github.com/stig/ox-jira.el
;; Package-Requires: ((org "8.3"))
;; This file is NOT part of GNU Emacs.
;; This program is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with this program. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
;; This module plugs into the regular Org Export Engine and transforms Org
;; files to JIRA markup for pasting into JIRA tickets & comments.
;; In an Org buffer, hit `C-c C-e j j' to bring up *Org Export Dispatcher*
;; and export it as a JIRA buffer. I usually use `C-x h' to mark the whole
;; buffer, then `M-w' to save it to the kill ring (and global pasteboard) for
;; pasting into JIRA issues.
;;; Code:
(eval-when-compile (require 'cl-lib))
(require 'ox)
(require 'ox-publish)
(require 'subr-x)
;;; User Configurable Options
(defgroup ox-jira-export nil
"Options specific to JIRA export back-end."
:tag "Org Export JIRA"
:group 'org-export
:version "24.4"
:package-version '(ox-jira . "0.1"))
(defcustom ox-jira-src-collapse-threshold 30
"Minimum number of lines in a src block to set collapse=true in JIRA/Confluence {code} block."
:group 'ox-export-jira
:type '(integer))
(defcustom ox-jira-src-supported-languages
'("actionscript"
"ada"
"applescript"
"c"
"c#"
"c++"
"css"
"erlang"
"go"
"groovy"
"html"
"haskell"
"json"
"java"
"javascript"
"lua"
"nyan"
"objc"
"php"
"perl"
"python"
"r"
"ruby"
"sql"
"scala"
"swift"
"visualbasic"
"xml"
"yaml"
"bash")
"Supported languages for syntax highlighting."
:group 'ox-export-jira
:type '(list))
(defcustom ox-jira-override-headline-offset nil
"Use this to override the (default) relative headline levels.
If you want to have the headings *real* heading level in
the Jira output when you export a subsection, use `0' here.
If you think the headings in Jira are too big by default, you
could set this to `2' to start headings at level 3."
:group 'ox-export-jira
:type 'integer)
;;; Defining Backend
(org-export-define-backend 'jira
'((babel-call . (lambda (&rest args) (ox-jira--not-implemented 'babel-call)))
(body . (lambda (&rest args) (ox-jira--not-implemented 'body)))
(bold . ox-jira-bold)
(center-block . (lambda (&rest args) (ox-jira--not-implemented 'center-block)))
(clock . (lambda (&rest args) (ox-jira--not-implemented 'clock)))
(code . ox-jira-code)
(diary-sexpexample-block . (lambda (&rest args) (ox-jira--not-implemented 'diary-sexpexample-block)))
(drawer . (lambda (&rest args) (ox-jira--not-implemented 'drawer)))
(dynamic-block . (lambda (&rest args) (ox-jira--not-implemented 'dynamic-block)))
(entity . (lambda (&rest args) (ox-jira--not-implemented 'entity)))
(example-block . ox-jira-example-block)
(export-block . (lambda (&rest args) (ox-jira--not-implemented 'export-block)))
(export-snippet . (lambda (&rest args) (ox-jira--not-implemented 'export-snippet)))
(final-output . (lambda (&rest args) (ox-jira--not-implemented 'final-output)))
(fixed-width . ox-jira-fixed-width)
(footnote-definition . ox-jira-footnote-definition)
(footnote-reference . ox-jira-footnote-reference)
(headline . ox-jira-headline)
(horizontal-rule . ox-jira-horizontal-rule)
(inline-babel-call . (lambda (&rest args) (ox-jira--not-implemented 'inline-babel-call)))
(inline-src-block . (lambda (&rest args) (ox-jira--not-implemented 'inline-src-block)))
(inlinetask . (lambda (&rest args) (ox-jira--not-implemented 'inlinetask)))
(italic . ox-jira-italic)
(item . ox-jira-item)
(keyword . (lambda (&rest args) ""))
(latex-environment . (lambda (&rest args) (ox-jira--not-implemented 'latex-environment)))
(latex-fragment . (lambda (&rest args) (ox-jira--not-implemented 'latex-fragment)))
(line-break . (lambda (&rest args) (ox-jira--not-implemented 'line-break)))
(link . ox-jira-link)
(node-property . (lambda (&rest args) (ox-jira--not-implemented 'node-property)))
(options . (lambda (&rest args) (ox-jira--not-implemented 'options)))
(paragraph . ox-jira-paragraph)
(parse-tree . (lambda (&rest args) (ox-jira--not-implemented 'parse-tree)))
(plain-list . ox-jira-plain-list)
(plain-text . ox-jira-plain-text)
(planning . (lambda (&rest args) (ox-jira--not-implemented 'planning)))
(property-drawer . (lambda (&rest args) (ox-jira--not-implemented 'property-drawer)))
(quote-block . ox-jira-quote-block)
(radio-target . (lambda (&rest args) (ox-jira--not-implemented 'radio-target)))
(section . ox-jira-section)
(special-block . (lambda (&rest args) (ox-jira--not-implemented 'special-block)))
(src-block . ox-jira-src-block)
(statistics-cookie . ox-jira-statistics-cookie)
(strike-through . ox-jira-strike-through)
(subscript . ox-jira-subscript)
(superscript . ox-jira-superscript)
(table . ox-jira-table)
(table-cell . ox-jira-table-cell)
(table-row . ox-jira-table-row)
(target . (lambda (&rest args) (ox-jira--not-implemented 'target)))
(timestamp . ox-jira-timestamp)
(underline . ox-jira-underline)
(verbatim . ox-jira-verbatim)
(verse-block . (lambda (&rest args) (ox-jira--not-implemented 'verse-block))))
:filters-alist '((:filter-parse-tree . ox-jira-fix-multi-paragraph-items))
:options-alist '((:src-collapse-threshold nil nil ox-jira-src-collapse-threshold))
:menu-entry
'(?j "Export to JIRA"
((?j "As JIRA buffer" ox-jira-export-as-jira))))
;;; Internal Helpers
(defun ox-jira--not-implemented (element-type)
"Replace anything we don't handle yet with a big red marker."
(format "{color:red}Element of type '%s' not implemented!{color}" element-type))
(defun ox-jira--text-transform-embeddable (transform-char contents)
(concat "{anchor}" transform-char contents transform-char))
;;; Filters
(defun ox-jira-fix-multi-paragraph-items (tree backend info)
"Remove extra blank line between paragraphs in plain-list items.
TREE is the parse tree being exported. BACKEND is the export
back-end used. INFO is a plist used as a communication channel.
Assume BACKEND is `jira'."
(org-element-map tree '(item paragraph src-block)
(lambda (e)
(org-element-put-property
e :post-blank
(if (or (eq (org-element-type e) 'item)
(eq (org-element-type (org-element-property :parent e)) 'item))
0 1))))
;; Return updated tree.
tree)
;;; Transcode functions
(defun ox-jira-bold (bold contents info)
"Transcode BOLD from Org to JIRA.
CONTENTS is the text with bold markup. INFO is a plist holding
contextual information."
(format "*%s*" contents))
(defun ox-jira-code (code _contents info)
"Transcode a CODE object from Org to JIRA.
CONTENTS is nil. INFO is a plist used as a communication
channel."
(format "{{%s}}" (org-element-property :value code)))
(defun ox-jira-example-block (example-block contents info)
"Transcode an EXAMPLE-BLOCK element from Org to Jira.
CONTENTS is nil. INFO is a plist holding contextual
information."
(when (org-string-nw-p (org-element-property :value example-block))
(format "{noformat}\n%s{noformat}"
(org-export-format-code-default example-block info))))
(defun ox-jira-fixed-width (fixed-width contents info)
"Transcode an FIXED-WIDTH element from Org to Jira.
CONTENTS is nil. INFO is a plist holding contextual
information."
(format "{noformat}\n%s{noformat}"
(org-remove-indentation
(org-element-property :value fixed-width))))
(defun ox-jira--footnote-anchor (element)
(let ((label (org-element-property :label element)))
(replace-regexp-in-string ":" "" label)))
(defun ox-jira--footnote-ref (anchor)
(replace-regexp-in-string "fn" "" anchor))
(defun ox-jira-footnote-reference (footnote-reference contents info)
"Transcode an FOOTNOTE-REFERENCE element from Org to Jira.
CONTENTS is nil. INFO is a plist holding contextual
information."
(let* ((anchor (ox-jira--footnote-anchor footnote-reference))
(ref (ox-jira--footnote-ref anchor)))
(format "{anchor:fnr%s}[^%s^|#fn%s]"
anchor ref anchor)))
(defun ox-jira-footnote-definition (footnote-definition contents info)
"Transcode an FOOTNOTE-DEFINITION element from Org to Jira.
CONTENTS is nil. INFO is a plist holding contextual
information."
(let* ((anchor (ox-jira--footnote-anchor footnote-definition))
(ref (ox-jira--footnote-ref anchor)))
(format "{anchor:fn%s}[^%s^|#fnr%s] %s"
anchor ref anchor contents)))
(defun ox-jira-headline (headline contents info)
"Transcode a HEADLINE element from Org to JIRA.
CONTENTS is the contents of the headline, as a string. INFO is
the plist used as a communication channel."
(let* ((headline-info (if (eql ox-jira-override-headline-offset nil)
info
(plist-put nil :headline-offset ox-jira-override-headline-offset)))
(level (org-export-get-relative-level headline headline-info))
(title (org-export-data-with-backend
(org-element-property :title headline)
'jira info))
(todo (and (plist-get info :with-todo-keywords)
(let ((todo (org-element-property :todo-keyword headline)))
(and todo (org-export-data todo info)))))
(todo-type (and todo (org-element-property :todo-type headline)))
(todo-text (if todo
(format "{color:%s}{{%s}}{color} "
(if (eq todo-type 'done) "lightgreen" "red")
todo)
""))
(tags (and (plist-get info :with-tags)
(org-export-get-tags headline info)))
(tags-text (if tags
(format " {color:blue}{{:%s:}}{color}" (string-join tags ":"))
"")))
(concat
(format "h%d. %s%s%s\n" level todo-text title tags-text)
contents)))
(defun ox-jira-horizontal-rule (horizontal-rule contents info)
"Transcode a HORIZONTAL-RULE element from Org to JIRA."
"----\n")
(defun ox-jira-italic (italic contents info)
"Transcode ITALIC from Org to JIRA.
CONTENTS is the text with italic markup. INFO is a plist holding
contextual information."
(format "_%s_" contents))
(defun ox-jira--list-type-path (item)
(when (and item (eq 'item (org-element-type item)))
(let* ((list (org-element-property :parent item))
(list-type (org-element-property :type list)))
(cons list-type (ox-jira--list-type-path
(org-element-property :parent list))))))
(defun ox-jira--bullet-string (list-type-path)
(apply 'string
(mapcar (lambda (x) (if (eq x 'ordered) ?# ?*))
list-type-path)))
(defun ox-jira-item (item contents info)
"Transcode ITEM from Org to JIRA.
CONTENTS is the text with item markup. INFO is a plist holding
contextual information."
(let* ((list-type-path (ox-jira--list-type-path item))
(bullet-string (ox-jira--bullet-string (reverse list-type-path)))
(tag (let ((tag (org-element-property :tag item)))
(when tag
(org-export-data tag info))))
(checkbox (cl-case (org-element-property :checkbox item)
(on "(/)")
(off "[ ]")
(trans "(i)"))))
(concat
bullet-string
" "
(when checkbox
(concat checkbox " "))
(when tag
(format "*%s*: " tag))
contents)))
(defun ox-jira-link (link desc info)
"Transcode a LINK object from Org to JIRA.
DESC is the description part of the link, or the empty string.
INFO is a plist holding contextual information. See
`org-export-data'."
(let* ((type (org-element-property :type link))
(raw-path (org-element-property :path link))
(desc (and (not (string= desc "")) desc))
(path (cond
((member type '("http" "https" "ftp" "mailto" "doi"))
(concat type ":" raw-path))
((string-prefix-p "~accountid" raw-path)
raw-path)
((string= type "file")
(org-export-file-uri raw-path))
((string= type "custom-id")
(if desc (concat "#" desc) (concat "#" raw-path)))
((string-prefix-p "*" raw-path)
(concat "#" (seq-subseq raw-path 1)))
((org-export-custom-protocol-maybe link desc 'jira info))
(t raw-path))))
(cond
;; Link with description
((and path desc) (format "[%s|%s]" desc path))
;; Link without description
(path (format "[%s]" path))
;; Link with only description?!
(t desc))))
(defun ox-jira-underline (underline contents info)
"Transcode UNDERLINE from Org to JIRA.
CONTENTS is the text with underline markup. INFO is a plist holding
contextual information."
(format "+%s+" contents))
(defun ox-jira-verbatim (verbatim _contents info)
"Transcode a VERBATIM object from Org to Jira.
CONTENTS is nil. INFO is a plist used as a communication
channel."
(format "{{%s}}" (org-element-property :value verbatim)))
(defun ox-jira-paragraph (paragraph contents info)
"Transcode a PARAGRAPH element from Org to JIRA.
CONTENTS is the contents of the paragraph, as a string. INFO is
the plist used as a communication channel."
(replace-regexp-in-string "\n\\([^\']\\)" " \\1" contents))
(defun ox-jira-plain-list (plain-list contents info)
"Transcode PLAIN-LIST from Org to JIRA.
CONTENTS is the text with plain-list markup. INFO is a plist holding
contextual information."
contents)
(defun ox-jira-plain-text (text info)
"Transcode TEXT from Org to JIRA.
TEXT is the string to transcode. INFO is a plist holding
contextual information."
(replace-regexp-in-string "\\([[{]\\)"
'(lambda (p) (format "\\\\%s" p))
text))
(defun ox-jira-section (section contents info)
"Transcode a SECTION element from Org to JIRA.
CONTENTS is the contents of the section, as a string. INFO is
the plist used as a communication channel."
contents)
(defun ox-jira-src-block (src-block contents info)
"Transcode a SRC-BLOCK element from Org to Jira.
CONTENTS holds the contents of the src-block. INFO is a plist holding
contextual information."
(when (org-string-nw-p (org-element-property :value src-block))
(let* ((title (apply #'concat (org-export-get-caption src-block)))
(lang (org-element-property :language src-block))
(lang (if (member lang ox-jira-src-supported-languages) lang "none"))
(code (org-export-format-code-default src-block info))
(collapse (if (< (plist-get info :src-collapse-threshold)
(org-count-lines code))
"true" "false")))
(concat
(format "{code:%s|title=%s|collapse=%s}" lang title collapse)
code
"{code}"))))
(defun ox-jira-subscript (subscript contents info)
"Transcode SUBSCRIPT from Org to JIRA.
CONTENTS is the text with subscript markup. INFO is a plist holding
contextual information."
(ox-jira--text-transform-embeddable "~" contents))
(defun ox-jira-superscript (superscript contents info)
"Transcode SUPERSCRIPT from Org to JIRA.
CONTENTS is the text with superscript markup. INFO is a plist holding
contextual information."
(ox-jira--text-transform-embeddable "^" contents))
(defun ox-jira-table (table contents info)
"Transcode a TABLE element from Org to JIRA.
CONTENTS holds the contents of the table. INFO is a plist holding
contextual information."
contents)
(defun ox-jira-table-row (table-row contents info)
"Transcode a TABLE-ROW element from Org to JIRA.
CONTENTS holds the contents of the table-row. INFO is a plist holding
contextual information."
(when (eq 'standard (org-element-property :type table-row))
(format "%s\n" contents)))
(defun ox-jira-table-cell (table-cell contents info)
"Transcode a TABLE-CELL element from Org to JIRA.
CONTENTS holds the contents of the table-cell. INFO is a plist holding
contextual information."
(let* ((row (org-element-property :parent table-cell))
(table (org-element-property :parent row))
(has-header (org-export-table-has-header-p table info))
(group (org-export-table-row-group row info))
(is-header (and has-header (eq 1 group)))
(sep (if is-header "||" "|")))
(format "%s %s %s" sep (if contents contents "")
(if (org-export-last-sibling-p table-cell info) sep ""))))
(defun ox-jira-statistics-cookie (statistics-cookie _contents _info)
"Transcode a STATISTICS-COOKIE object from Org to JIRA.
CONTENTS is nil. INFO is a plist holding contextual information."
(format "\\%s" (org-element-property :value statistics-cookie)))
(defun ox-jira-strike-through (strike-through contents info)
"Transcode STRIKE-THROUGH from Org to JIRA.
CONTENTS is the text with strike-through markup. INFO is a plist holding
contextual information."
(format "-%s-" contents))
(defun ox-jira-quote-block (quote-block contents info)
"Transcode a QUOTE-BLOCK element from Org to Jira.
CONTENTS holds the contents of the block. INFO is a plist
holding contextual information."
(format "{quote}\n%s{quote}" contents))
(defun ox-jira-timestamp (timestamp _contents info)
"Transcode a TIMESTAMP object from Org to JIRA.
CONTENTS is nil. INFO is a plist holding contextual information."
(let ((value (org-timestamp-translate timestamp))
(fmt (cl-case (org-element-property :type timestamp)
((active active-range) "_%s_")
((inactive inactive-range) "_\\%s_")
(otherwise "_%s_"))))
(format fmt value)))
;;;###autoload
(defun ox-jira-export-as-jira
(&optional async subtreep visible-only body-only ext-plist)
"Export current buffer as a Jira buffer.
If narrowing is active in the current buffer, only export its
narrowed part.
If a region is active, export that region.
A non-nil optional argument ASYNC means the process should happen
asynchronously. The resulting buffer should be accessible
through the `org-export-stack' interface.
When optional argument SUBTREEP is non-nil, export the sub-tree
at point, extracting information from the headline properties
first.
When optional argument VISIBLE-ONLY is non-nil, don't export
contents of hidden elements.
When optional argument BODY-ONLY is non-nil, omit header
stuff. (e.g. AUTHOR and TITLE.)
EXT-PLIST, when provided, is a property list with external
parameters overriding Org default settings, but still inferior to
file-local settings.
Export is done in a buffer named \"*Org JIRA Export*\", which
will be displayed when `org-export-show-temporary-export-buffer'
is non-nil."
(interactive)
(org-export-to-buffer 'jira "*Org JIRA Export*"
async subtreep visible-only body-only ext-plist))
(provide 'ox-jira)
;;; ox-jira.el ends here
|