Skip to content

Commit 70a6c53

Browse files
AlhadisAlhadis
committed
Highlight {@inline tags} in default @param values
1 parent c422015 commit 70a6c53

File tree

2 files changed

+70
-42
lines changed

2 files changed

+70
-42
lines changed

‎grammars/jsdoc.cson‎

Lines changed: 51 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -264,6 +264,9 @@
264264
'2':
265265
'name': 'source.embedded.js'
266266
'patterns': [
267+
{
268+
'include': '#inline-tags'
269+
}
267270
{
268271
'include': 'source.js'
269272
}
@@ -381,48 +384,7 @@
381384
'name': 'storage.type.class.jsdoc'
382385
}
383386
{
384-
# Description preceding {@inline tag}
385-
'captures':
386-
'1':
387-
'name': 'punctuation.definition.bracket.square.begin.jsdoc'
388-
'2':
389-
'name': 'punctuation.definition.bracket.square.end.jsdoc'
390-
'match': '(\\[)[^\\]]+(\\])(?={@(?:link|linkcode|linkplain|tutorial))'
391-
'name': 'constant.other.description.jsdoc'
392-
}
393-
{
394-
# {@link|@tutorial …}
395-
'begin': '({)((@)(?:link(?:code|plain)?|tutorial))\\s*'
396-
'beginCaptures':
397-
'1':
398-
'name': 'punctuation.definition.bracket.curly.begin.jsdoc'
399-
'2':
400-
'name': 'storage.type.class.jsdoc'
401-
'3':
402-
'name': 'punctuation.definition.inline.tag.jsdoc'
403-
'end': '}|(?=\\*/)'
404-
'endCaptures':
405-
'0':
406-
'name': 'punctuation.definition.bracket.curly.end.jsdoc'
407-
'name': 'entity.name.type.instance.jsdoc'
408-
'patterns': [
409-
{
410-
'captures':
411-
'1':
412-
'name': 'variable.other.link.underline.jsdoc'
413-
'2':
414-
'name': 'punctuation.separator.pipe.jsdoc'
415-
'match': '\\G((?=https?://)(?:[^|}\\s*]|\\*[/])+)(\\|)?'
416-
}
417-
{
418-
'captures':
419-
'1':
420-
'name': 'variable.other.description.jsdoc'
421-
'2':
422-
'name': 'punctuation.separator.pipe.jsdoc'
423-
'match': '\\G((?:[^{}@\\s|*]|\\*[^/])+)(\\|)?'
424-
}
425-
]
387+
'include': '#inline-tags'
426388
}
427389
]
428390

@@ -449,6 +411,53 @@
449411
]
450412
}
451413
]
414+
'inline-tags':
415+
'patterns': [
416+
{
417+
# Description preceding {@inline tag}
418+
'captures':
419+
'1':
420+
'name': 'punctuation.definition.bracket.square.begin.jsdoc'
421+
'2':
422+
'name': 'punctuation.definition.bracket.square.end.jsdoc'
423+
'match': '(\\[)[^\\]]+(\\])(?={@(?:link|linkcode|linkplain|tutorial))'
424+
'name': 'constant.other.description.jsdoc'
425+
}
426+
{
427+
# {@link|@tutorial …}
428+
'begin': '({)((@)(?:link(?:code|plain)?|tutorial))\\s*'
429+
'beginCaptures':
430+
'1':
431+
'name': 'punctuation.definition.bracket.curly.begin.jsdoc'
432+
'2':
433+
'name': 'storage.type.class.jsdoc'
434+
'3':
435+
'name': 'punctuation.definition.inline.tag.jsdoc'
436+
'end': '}|(?=\\*/)'
437+
'endCaptures':
438+
'0':
439+
'name': 'punctuation.definition.bracket.curly.end.jsdoc'
440+
'name': 'entity.name.type.instance.jsdoc'
441+
'patterns': [
442+
{
443+
'captures':
444+
'1':
445+
'name': 'variable.other.link.underline.jsdoc'
446+
'2':
447+
'name': 'punctuation.separator.pipe.jsdoc'
448+
'match': '\\G((?=https?://)(?:[^|}\\s*]|\\*[/])+)(\\|)?'
449+
}
450+
{
451+
'captures':
452+
'1':
453+
'name': 'variable.other.description.jsdoc'
454+
'2':
455+
'name': 'punctuation.separator.pipe.jsdoc'
456+
'match': '\\G((?:[^{}@\\s|*]|\\*[^/])+)(\\|)?'
457+
}
458+
]
459+
}
460+
]
452461
# Balanced quotes
453462
'quotes':
454463
'patterns': [

‎spec/jsdoc-spec.coffee‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,25 @@ describe "JSDoc grammar", ->
123123
expect(tokens[20]).toEqual value: '. ', scopes: ['source.js', 'comment.block.documentation.js']
124124
expect(tokens[21]).toEqual value: '*/', scopes: ['source.js', 'comment.block.documentation.js', 'punctuation.section.end.comment.js']
125125

126+
it "tokenises inline tags within default @param values", ->
127+
{tokens} = grammar.tokenizeLine('/** @param {EntityType} [typeHint={@link EntityType.FILE}] */')
128+
expect(tokens[0]).toEqual value: '/**', scopes: ['source.js', 'comment.block.documentation.js', 'punctuation.section.begin.comment.js']
129+
expect(tokens[2]).toEqual value: '@', scopes: ['source.js', 'comment.block.documentation.js', 'storage.type.class.jsdoc', 'punctuation.definition.block.tag.jsdoc']
130+
expect(tokens[3]).toEqual value: 'param', scopes: ['source.js', 'comment.block.documentation.js', 'storage.type.class.jsdoc']
131+
expect(tokens[5]).toEqual value: '{', scopes: ['source.js', 'comment.block.documentation.js', 'entity.name.type.instance.jsdoc', 'punctuation.definition.bracket.curly.begin.jsdoc']
132+
expect(tokens[6]).toEqual value: 'EntityType', scopes: ['source.js', 'comment.block.documentation.js', 'entity.name.type.instance.jsdoc']
133+
expect(tokens[7]).toEqual value: '}', scopes: ['source.js', 'comment.block.documentation.js', 'entity.name.type.instance.jsdoc', 'punctuation.definition.bracket.curly.end.jsdoc']
134+
expect(tokens[9]).toEqual value: '[', scopes: ['source.js', 'comment.block.documentation.js', 'variable.other.jsdoc']
135+
expect(tokens[10]).toEqual value: 'typeHint', scopes: ['source.js', 'comment.block.documentation.js', 'variable.other.jsdoc']
136+
expect(tokens[11]).toEqual value: '=', scopes: ['source.js', 'comment.block.documentation.js', 'variable.other.jsdoc', 'keyword.operator.assignment.jsdoc']
137+
expect(tokens[12]).toEqual value: '{', scopes: ['source.js', 'comment.block.documentation.js', 'variable.other.jsdoc', 'source.embedded.js', 'entity.name.type.instance.jsdoc', 'punctuation.definition.bracket.curly.begin.jsdoc']
138+
expect(tokens[13]).toEqual value: '@', scopes: ['source.js', 'comment.block.documentation.js', 'variable.other.jsdoc', 'source.embedded.js', 'entity.name.type.instance.jsdoc', 'storage.type.class.jsdoc', 'punctuation.definition.inline.tag.jsdoc']
139+
expect(tokens[14]).toEqual value: 'link', scopes: ['source.js', 'comment.block.documentation.js', 'variable.other.jsdoc', 'source.embedded.js', 'entity.name.type.instance.jsdoc', 'storage.type.class.jsdoc']
140+
expect(tokens[16]).toEqual value: 'EntityType.FILE', scopes: ['source.js', 'comment.block.documentation.js', 'variable.other.jsdoc', 'source.embedded.js', 'entity.name.type.instance.jsdoc', 'variable.other.description.jsdoc']
141+
expect(tokens[17]).toEqual value: '}', scopes: ['source.js', 'comment.block.documentation.js', 'variable.other.jsdoc', 'source.embedded.js', 'entity.name.type.instance.jsdoc', 'punctuation.definition.bracket.curly.end.jsdoc']
142+
expect(tokens[18]).toEqual value: ']', scopes: ['source.js', 'comment.block.documentation.js', 'variable.other.jsdoc']
143+
expect(tokens[20]).toEqual value: '*/', scopes: ['source.js', 'comment.block.documentation.js', 'punctuation.section.end.comment.js']
144+
126145
describe "block tags", ->
127146
it "tokenises simple tags", ->
128147
{tokens} = grammar.tokenizeLine('/** @mixins */')

0 commit comments

Comments
 (0)