-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi-mode.el
226 lines (204 loc) · 7.89 KB
/
openapi-mode.el
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
(require 'cl-lib)
(require 'xref)
(require 'openapi-common)
;; regexp constants
(defun openapi-xref-backend ()
"ref backend identifier for openapi"
'openapi)
;; define the indentifier
(cl-defmethod xref-backend-identifier-at-point ((backend (eql openapi)))
(openapi--identifier-at-point))
;; xref-backend
(cl-defmethod xref-backend-identifier-completion-table ((backend (eql openapi)))
"Return list of terms for completion from the current buffer"
(openapi--list-definitions))
(cl-defmethod xref-backend-definitions ((backend (eql openapi)) symbol)
"Find ref definitions for SYMBOL"
(openapi--find-definitions symbol))
(cl-defmethod xref-backend-references ((backend (eql openapi)) symbol)
"Find all references matching SYMBOL"
(openapi--find-references symbol))
;; helpers
(defun is-openapi-file ()
"Function returns t if current buffer is a openapi file by
checking if the top-level key 'openapi' is present"
(save-excursion
(save-restriction
(widen)
(goto-char (point-min))
(when (re-search-forward "^openapi:" nil t)
t))))
(defun openapi--identifier-at-point ()
"Looks at current line to find if a component reference is present"
(save-excursion
(goto-char (line-beginning-position))
(when (re-search-forward openapi-ref-regexp (line-end-position) t)
(when-let ((ref (match-string-no-properties 3)))
;; (message "identifier : %s" ref)
(let ((tokens (split-string ref "/")))
(when (and (eql 4 (length tokens)) (string-equal "#" (car tokens)))
(let ((id (string-join (cdr tokens) "/")))
;; (message "id: %s" id)
id)))))))
(defun openapi--list-definitions ()
"Returns list of all available component definitions"
(let ((refs) (subsection))
(save-excursion
(save-restriction
(widen)
(goto-char (point-min))
(when (re-search-forward openapi-components-regexp nil t)
(setq sb (openapi-block-bounds))
(apply #'narrow-to-region sb)
(goto-char (point-min))
(while (re-search-forward openapi-subsection-key-regexp nil t)
(pcase (/ (length (match-string-no-properties 1)) 2)
(1
(setq subsection (match-string-no-properties 2)))
(2
(push (format "components/%s/%s" subsection (match-string-no-properties 2)) refs)))))))
(reverse refs)))
(defun openapi--list-sections ()
"Returns the lit of sections inside the 'components' key"
(save-excursion
(save-restriction
(widen)
(goto-char (point-min))
(when (re-search-forward openapi-components-regexp nil t)
(message "found tld")
(let ((b (openapi-block-bounds)))
(apply #'narrow-to-region (openapi-block-bounds))
(goto-char (point-min))
(let (sections)
(while (re-search-forward (format "^%s\\([[:word:]]+\\):" (make-string 2 ? )) nil t)
(push
(cons (format "components/%s" (match-string-no-properties 1)) (match-beginning 1))
sections))
(reverse sections)))))))
(defun openapi--find-references (symbol)
"Find schema references within the buffer of the
form $ref: '#/components/subsection/key' for the SYMBOL"
(save-excursion
(save-restriction
(widen)
(goto-char (point-min))
(let (refs)
(while (re-search-forward (format "#/%s" symbol) nil t)
(push
(xref-make
(format
"%s:%s"
(propertize (format "%s" (line-number-at-pos (line-beginning-position))) 'face 'shadow)
(buffer-substring (line-beginning-position) (line-end-position))
)
(xref-make-buffer-location (current-buffer) (match-beginning 0)))
refs))
(append (reverse refs) (openapi--find-definitions symbol))))))
(defun openapi--find-definitions (symbol)
"Return the ref objects for the definitions found for SYMBOL
within the buffer"
(let* ((tokens (split-string symbol "/"))
(section (car tokens))
(subsection (cadr tokens))
(key (caddr tokens)))
(when (and section subsection key)
(save-excursion
(save-restriction
(widen)
(goto-char (point-min))
(when (re-search-forward (format "^%s:" section) nil t)
(setq sb (openapi-block-bounds))
(apply #'narrow-to-region sb)
(goto-char (point-min))
;; (message "looking at section : '%s'" (buffer-substring-no-properties (point-min) (point-max)))
(when (re-search-forward (format "^%s%s:" (make-string 2 ? ) subsection) (cadr sb) t)
(setq ssb (openapi-block-bounds))
(apply #'narrow-to-region ssb)
(goto-char (point-min))
;; (message "looking at subsection: '%s'" (buffer-substring-no-properties (point-min) (point-max)))
(when (re-search-forward (format "^%s%s:" (make-string 4 ? ) key) nil t)
;; (message "match : '%s' %d / %" (match-string-no-properties 0) (match-beginning 0) (line-beginning-position))
(list
(xref-make
(buffer-substring-no-properties (line-beginning-position) (line-end-position))
(xref-make-buffer-location (current-buffer) (match-beginning 0))))))))))))
(defun openapi-jump-to-section ()
"Jumps to selected component section"
(interactive)
(let ((options (openapi--list-sections)))
(let ((selection (completing-read "Select section: " options nil t "components/")))
(when-let ((section (assoc selection options)))
(push-mark)
(print section)
(goto-char (cdr section))))))
(defun openapi-insert-component-ref ()
"Inserts a component reference at point"
(interactive)
(when-let
((selection
(completing-read "Select component: " (openapi--list-definitions)
nil t "components/")))
(insert
(format
(if (looking-back openapi-yaml-ref-regexp (line-beginning-position))
(if (> (length (match-string-no-properties 2)) 0)
"#/%s"
"'#/%s'"
)
"$ref: '#/%s'"
)
selection))))
(defun openapi--list-section (section)
(seq-filter (lambda (x) (string-prefix-p (format "components/%s" section) x)) (openapi--list-definitions)))
(defun openapi--section-singular (section)
(cond
("parameters" "Parameter")
("headers" "Header")
("schemas" "Schema item")
("responses" "Response")
("requestBodies" "Request body")))
(defmacro openapi--insert-section (section)
`(lambda ()
(interactive)
(when-let
((selection
(completing-read
,(format "Select %s: " (openapi--section-singular section)) (openapi--list-section ,section)
nil t ,(format "components/%s/" section))))
(insert
(format
(if (looking-back openapi-yaml-ref-regexp (line-beginning-position))
(if (> (length (match-string-no-properties 2)) 0)
"#/%s"
"'#/%s'"
)
"$ref: '#/%s'"
)
selection)))))
(defvar openapi-mode-map
(let ((keymap (make-sparse-keymap)))
(set-keymap-parent keymap openapi--yaml-mode-map)
(define-key keymap (kbd "C-c C-p") #'openapi-jump-to-operation)
(define-key keymap (kbd "C-c C-s") #'openapi-jump-to-section)
(define-key keymap (kbd "C-c C-c") #'openapi-insert-component-ref)
(define-key keymap (kbd "C-c i p") (openapi--insert-section "parameters"))
(define-key keymap (kbd "C-c i h") (openapi--insert-section "headers"))
(define-key keymap (kbd "C-c i s") (openapi--insert-section "schemas"))
(define-key keymap (kbd "C-c i r") (openapi--insert-section "responses"))
(define-key keymap (kbd "C-c i b") (openapi--insert-section "requestBodies"))
keymap)
"OpenAPI keymap for block & path-operation navigation"
)
(define-minor-mode openapi-mode
"Minor mode to provide xref navigation within OpenAPI yaml files"
:lighter " OpenAPI"
(setq-local openapi-list-paths-backend #'openapi-list-paths)
(add-hook 'xref-backend-functions #'openapi-xref-backend nil t)
(openapi--add-font-lock-extras))
(defun enable-openapi-mode ()
"Conditionally enable openapi mode"
(when (is-openapi-file)
(openapi-mode)))
;;;###autoload
(add-hook 'yaml-mode-hook #'enable-openapi-mode)
(provide 'openapi-mode)