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

Commit bdde572

Browse files
author
Wliu
authored
Merge pull request #396 from bgriffith/feature/jsdoc
Add support for JSDoc parameter properties
2 parents 54b926a + 165662b commit bdde572

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed

grammars/javascript.cson

+1-1
Original file line numberDiff line numberDiff line change
@@ -1605,7 +1605,7 @@
16051605
'name': 'storage.type.class.jsdoc'
16061606
}
16071607
{
1608-
'match': '({\\b(?:[a-zA-Z_$][\\w$]*)\\b})\\s+(\\[\\b(?:[a-zA-Z_$]+(?:=[\\w][\\s\\w$]*)?)\\b\\]|\\b(?:[a-zA-Z_$][\\w$]*)\\b)\\s*((?:(?!\\*\\/).)*)'
1608+
'match': '({\\b(?:[a-zA-Z_$][\\w$]*)\\b})\\s+(\\[\\b(?:[a-zA-Z_$]+(?:=[\\w][\\s\\w$]*)?)\\b\\]|\\b(?:[a-zA-Z_$][\\w$]*(?:\\.[a-zA-Z_$][\\w$]*)*)\\b)\\s*((?:(?!\\*\\/).)*)'
16091609
'captures':
16101610
0:
16111611
'name': 'other.meta.jsdoc'

spec/javascript-spec.coffee

+5
Original file line numberDiff line numberDiff line change
@@ -1519,6 +1519,11 @@ describe "Javascript grammar", ->
15191519
expect(tokens[6]).toEqual value: '[variable=default value]', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'variable.other.jsdoc']
15201520
expect(tokens[8]).toEqual value: 'this is the description ', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'other.description.jsdoc']
15211521

1522+
{tokens} = grammar.tokenizeLine('/** @param {object} parameter.property this is the description */')
1523+
expect(tokens[4]).toEqual value: '{object}', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'entity.name.type.instance.jsdoc']
1524+
expect(tokens[6]).toEqual value: 'parameter.property', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'variable.other.jsdoc']
1525+
expect(tokens[8]).toEqual value: 'this is the description ', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'other.description.jsdoc']
1526+
15221527
it "tokenizes // comments", ->
15231528
{tokens} = grammar.tokenizeLine('// comment')
15241529
expect(tokens[0]).toEqual value: '//', scopes: ['source.js', 'comment.line.double-slash.js', 'punctuation.definition.comment.js']

0 commit comments

Comments
 (0)