-
Notifications
You must be signed in to change notification settings - Fork 5
/
cmd-help.sublime-syntax
370 lines (322 loc) · 10 KB
/
cmd-help.sublime-syntax
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
%YAML 1.2
---
name: Command Help
file_extensions:
- cmd-help # doesn't really exist, but useful for the shortname
scope: text.cmd-help
variables:
### section name variables:
# words regardless of case, including dashes for compound words
any_word: '[A-Za-z][A-Za-z-]*\b'
# allow parentheses on both ends of the word
any_word2: '\(?{{any_word}}\)?'
# words starting with uppercase
leading_word: '[A-Z][A-Za-z-]*\b'
# only consider lines <= 40 chars long
lookahead_40: '(?=.{1,40}\n)'
### command option variables:
option_break: '[ \t\n,=\[</:]'
# marks seen in options: . ? : # $ -- +
option_char: '[^{{option_break}}]'
option_name: '{{option_char}}+'
### command/option argument variables:
ellipsis: '\.\.\.'
allcaps_argument_name: '[A-Z][0-9A-Z_]*\b'
relaxed_argument_name: '[A-Za-z][0-9A-Za-z_-]*\b'
### other-def variables:
other_lowercase_name: '[a-z][0-9a-z_-]*\b'
long_space: ' |\t|\n'
scope_variables: # rightmost scope is matched first
section_heading_scope: &SECTION_HEADING_SCOPE
constant.section-heading.cmd-help string.section-heading.cmd-help
markup.heading.cmd-help entity.name.section.cmd-help
inline_usage_scope: &INLINE_USAGE_SCOPE
constant.section-heading.cmd-help string.inline-usage.cmd-help
markup.heading.inline-usage.cmd-help entity.name.section.inline-usage.cmd-help
option_def_scope: &OPTION_DEF_SCOPE
entity.name.function.option.cmd-help
option_argument_scope: &OPTION_ARGUMENT_SCOPE
string.option-argument.cmd-help variable.other.option-argument.cmd-help
variable.parameter.option-argument.cmd-help
argument_def_scope: &ARGUMENT_DEF_SCOPE # same base scopes as option argument
string.argument.cmd-help variable.other.argument.cmd-help
variable.parameter.argument.cmd-help
# all-caps definitions, usually environment vars but also command args
other_variable_def_scope: &OTHER_VARIABLE_DEF_SCOPE
variable.other.readwrite.cmd-help string.other-variable.cmd-help
# non all-caps definitions: subcommands, arguments, features, etc.
other_def_scope: &OTHER_DEF_SCOPE
keyword.other.def.cmd-help # support.fuction variable.function ?
contexts:
prototype:
# abort if color escape codes
- match: '(?=.*\e\[0m)'
set: sink
# abort if formatted with backspaces
- match: '(?=.*[\b])'
set: sink
main: # entry point only, main-b is the real main
- meta_include_prototype: false
- include: first-line-specials
- match: '^'
set: main-b
first-line-specials:
- include: ignore-syntax-test-header
# man page first line: ^cmd/fn_name(man_section_digit) ... idem$
- match: '(?=^([A-Z-]+)\(([0-9])\)\s.+\s\1\(\2\)$)'
push:
- clear_scopes: true
- include: Manpage.sublime-syntax
main-b: # stack lv 0
- match: '^'
push: [line, line-begin]
line: # stack lv 1
- match: '$'
pop: true
### helpers ##################################################################
else-pop:
- include: eol-pop # '.' doesn't match '\n'
- match: '(?=.)'
pop: true
eol-pop:
- match: '\n'
pop: true
then-pop:
- match: ''
pop: true
de-scope-match:
- clear_scopes: 1
- include: then-pop
sink:
- clear_scopes: true
- meta_include_prototype: false
ignore-syntax-test-header:
- match: '# SYNTAX TEST "cmd-help.sublime-syntax"\n'
set: main
- match: '^\n$' # empty line
set: main
### stack lv 2 ###############################################################
line-begin:
- match: '^(?=\S)'
set: indent-0
- match: '^ {1,2}(?=\S)'
set: indent-1-2
- match: '^ {3,8}(?=\S)'
set: indent-3-8
- match: '^\t{1,2}(?=\S)'
set: indent-3-8
- include: else-pop
indent-0:
- include: heading
- include: option-def-first
- include: argument-def
- include: other-def
- include: else-pop
indent-1-2:
- include: option-def-first
- include: heading
- include: argument-def
- include: other-def
- include: else-pop
indent-3-8:
- include: option-def-first
- include: argument-def
- include: other-def
- include: else-pop
### section headings #########################################################
heading:
- include: heading-specials
- match: '{{lookahead_40}}{{leading_word}}( {{any_word2}})*:?\n'
scope: *SECTION_HEADING_SCOPE
set: then-pop
# - match: '{{any_word2}}( {{any_word2}})*:\n'
# scope: *SECTION_HEADING_SCOPE
# set: then-pop
heading-specials:
- match: '(?i:usage):(?=.+\n)'
scope: *INLINE_USAGE_SCOPE
set: then-pop
# python argparse
- match: '(positional arguments|optional arguments|required arguments|options):\n'
scope: *SECTION_HEADING_SCOPE
set: then-pop
### option definitions #######################################################
option-def:
- match: '-{{option_name}}'
scope: *OPTION_DEF_SCOPE
set: option-def-post
option-def-specials:
- match: '--(?=\s)'
scope: keyword.control.end-of-options.cmd-help
set: then-pop
- match: '\+(?=[\s<[:alpha:]])'
scope: keyword.control.plus-option.cmd-help
set: plus-option-post
- match: '-:(?={{option_break}})'
scope: *OPTION_DEF_SCOPE
set: option-def-post
option-def-first:
- include: option-def-specials
- match: '---' # probably a separator
pop: true
- include: option-def
option-def-post:
- include: option-def-connectors
- match: '='
set: option-def+equals
# match '[=' or '[' or ' [' or ':['
- match: '\[=|\[| \[|:\['
set: option-def+square-bracket
- match: ':'
set: option-def+colon
- match: ','
set: option-def+comma
- match: '(?=<)'
set: option-def+space
- match: ' '
set: option-def+space
- include: else-pop
option-def-connectors:
- match: ', '
set: option-def-or-pop
- match: ' \| '
set: option-def-or-pop
- match: ' (?=-)'
set: option-def-or-pop
- match: ' or '
set: option-def-or-pop
- match: ' or '
set: option-def-or-pop
- match: '/'
set: option-def-or-pop
- match: '\s+(?=-)'
set: option-def-or-pop
option-def-or-pop:
- include: option-def
- include: else-pop
### option arguments #########################################################
option-def+space:
- match: '<.*?>'
scope: *OPTION_ARGUMENT_SCOPE
set: option-argument-post
- match: '{{allcaps_argument_name}}\b'
scope: *OPTION_ARGUMENT_SCOPE
set: option-argument-post
- match: '{{relaxed_argument_name}}(?! [:alpha:])'
scope: *OPTION_ARGUMENT_SCOPE
set: option-argument-post
- match: '{{relaxed_argument_name}}(?= or )'
scope: *OPTION_ARGUMENT_SCOPE
set: option-argument-post
- match: "'{{relaxed_argument_name}}'"
scope: *OPTION_ARGUMENT_SCOPE
set: option-argument-post
- match: '{'
set: option-argument-curly-bracket
- include: else-pop
option-def+equals:
- match: '{{relaxed_argument_name}}'
scope: *OPTION_ARGUMENT_SCOPE
set: option-argument-post
- match: '<.*?>'
scope: *OPTION_ARGUMENT_SCOPE
set: option-argument-post
- match: '{'
set: option-argument-curly-bracket
- include: else-pop
option-def+square-bracket:
- meta_content_scope: *OPTION_ARGUMENT_SCOPE
- match: '\|'
push: de-scope-match
- match: '(?=])'
set:
- match: ']'
set: option-argument-post
option-def+colon:
- match: '<.*?>'
scope: *OPTION_ARGUMENT_SCOPE
set: option-argument-post
- include: else-pop
option-def+comma:
- match: '<.*?>'
scope: *OPTION_ARGUMENT_SCOPE
set: option-argument-post
- include: else-pop
option-argument-curly-bracket:
- meta_content_scope: *OPTION_ARGUMENT_SCOPE
# match ',' or '|'
- match: ',|\|'
push: de-scope-match
- match: '(?=})'
set:
- match: '}'
set: option-argument-post
option-argument-post:
- include: option-def-connectors
- match: '({{ellipsis}})?'
scope: *OPTION_ARGUMENT_SCOPE
# match '[=' or '['
- match: '\[=|\['
set: option-def+square-bracket
- match: ',\['
set: option-def+square-bracket
- match: '='
set: option-def+equals
- match: '\|'
set: option-def+space
- include: else-pop
plus-option-post:
- match: '<.*?>'
scope: *OPTION_ARGUMENT_SCOPE
set: then-pop
# e.g.: "LINE:COLUMN" (from emacs)
- match: '{{allcaps_argument_name}}(:{{allcaps_argument_name}})*'
scope: *OPTION_ARGUMENT_SCOPE
set: then-pop
- include: else-pop
### other definitions ########################################################
argument-def:
- match: '<{{relaxed_argument_name}}>({{ellipsis}})?'
scope: *ARGUMENT_DEF_SCOPE
set: then-pop
- match: '{'
set: curly-bracket-argument-def
- match: '-(?= )'
scope: *ARGUMENT_DEF_SCOPE # stdin
set: then-pop
- match: '({{relaxed_argument_name}}) ({{ellipsis}})'
captures:
1: *ARGUMENT_DEF_SCOPE
2: *ARGUMENT_DEF_SCOPE
set: then-pop
curly-bracket-argument-def:
- meta_content_scope: *ARGUMENT_DEF_SCOPE
# match ',' or '|'
- match: ',|\|'
push: de-scope-match
- match: '(?=})'
set:
- match: '}'
set: then-pop
- include: eol-pop
other-def:
- match: '{{other_lowercase_name}}(?={{long_space}})'
scope: *OTHER_DEF_SCOPE
set: then-pop
# e.g.: "compose*" (from docker)
- match: '{{other_lowercase_name}}\*(?= )'
scope: *OTHER_DEF_SCOPE
set: then-pop
# e.g.: "build, b" (from cargo)
- match: '({{other_lowercase_name}}), ({{other_lowercase_name}})(?={{long_space}})'
captures:
1: *OTHER_DEF_SCOPE
2: *OTHER_DEF_SCOPE
set: then-pop
- match: '{{allcaps_argument_name}}(?= )'
scope: *OTHER_VARIABLE_DEF_SCOPE
set: then-pop
# e.g.: "PYTHONSTARTUP:", "PYTHONCASEOK :"
- match: '{{allcaps_argument_name}}(?=\s*:)'
scope: *OTHER_VARIABLE_DEF_SCOPE
set: then-pop