Skip to content
This repository was archived by the owner on Dec 15, 2022. It is now read-only.

Add improved JSDoc support for @returns #411

Merged
merged 2 commits into from
Aug 23, 2016
Merged

Add improved JSDoc support for @returns #411

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
619316e
:bug: Add improved JSDoc highlighting for return
bgriffith Aug 23, 2016
2a24cc2
:white_check_mark: Add specs for improved JSDoc highlighting for return
bgriffith Aug 23, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 31 additions & 9 deletions grammars/javascript.cson
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1677,16 +1677,38 @@
'name': 'storage.type.class.jsdoc'
}
{
'match': '({(?:\\*|(?:\\?|\\!|\\.{3})?[a-zA-Z_$][\\w$]*(?:\\.[a-zA-Z_$][\\w$]*)*(?:\\[\\])?=?)})\\s+(\\[(?:[a-zA-Z_$]+(?:=[\\w][\\s\\w$]*)?)\\]|(?:[a-zA-Z_$][\\w$]*(?:\\.[a-zA-Z_$][\\w$]*)*))\\s*((?:(?!\\*\\/).)*)'
'match': '''(?x)
({(?:\\*|(?:\\?|\\!|\\.{3})?[a-zA-Z_$][\\w$]*(?:\\.[a-zA-Z_$][\\w$]*)*(?:\\[\\])?=?)})
\\s+
(\\[(?:[a-zA-Z_$]+(?:=[\\w][\\s\\w$]*)?)\\]|(?:[a-zA-Z_$][\\w$]*(?:\\.[a-zA-Z_$][\\w$]*)*))
\\s+
((?:(?!\\*\\/).)*)
'''
'captures':
'0':
'name': 'other.meta.jsdoc'
'1':
'name': 'entity.name.type.instance.jsdoc'
'2':
'name': 'variable.other.jsdoc'
'3':
'name': 'other.description.jsdoc'
}
{
'match': '''(?x)
(?:(?<=@returns)|(?<=@return))
\\s+
({(?:\\*|(?:\\?|\\!|\\.{3})?[a-zA-Z_$][\\w$]*(?:\\.[a-zA-Z_$][\\w$]*)*(?:\\[\\])?=?)})
\\s+
((?:(?!\\*\\/).)*)
'''
'captures':
0:
'name': 'other.meta.jsdoc'
1:
'name': 'entity.name.type.instance.jsdoc'
2:
'name': 'variable.other.jsdoc'
3:
'name': 'other.description.jsdoc'
'0':
'name': 'other.meta.jsdoc'
'1':
'name': 'entity.name.type.instance.jsdoc'
'2':
'name': 'other.description.jsdoc'
}
]
'comments':
Expand Down
14 changes: 14 additions & 0 deletions spec/javascript-spec.coffee
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1573,6 +1573,20 @@ describe "Javascript grammar", ->
expect(tokens[6]).toEqual value: 'variable', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'variable.other.jsdoc']
expect(tokens[8]).toEqual value: 'this is the description ', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'other.description.jsdoc']

{tokens} = grammar.tokenizeLine('/** @return {object} this is the description */')
expect(tokens[4]).toEqual value: '{object}', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'entity.name.type.instance.jsdoc']
expect(tokens[6]).toEqual value: 'this is the description ', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'other.description.jsdoc']

{tokens} = grammar.tokenizeLine('/** @return {object} */')
expect(tokens[4]).toEqual value: '{object}', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'entity.name.type.instance.jsdoc']

{tokens} = grammar.tokenizeLine('/** @returns {object} this is the description */')
expect(tokens[4]).toEqual value: '{object}', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'entity.name.type.instance.jsdoc']
expect(tokens[6]).toEqual value: 'this is the description ', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'other.description.jsdoc']

{tokens} = grammar.tokenizeLine('/** @returns {object} */')
expect(tokens[4]).toEqual value: '{object}', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'entity.name.type.instance.jsdoc']

it "tokenizes // comments", ->
{tokens} = grammar.tokenizeLine('// comment')
expect(tokens[0]).toEqual value: '//', scopes: ['source.js', 'comment.line.double-slash.js', 'punctuation.definition.comment.js']
Expand Down