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

Commit bd1d81a

Browse files
author
Wliu
authored
Merge pull request #461 from bgriffith/feature/jsdoc-advanced-func
Add support for JSDoc function type param prefixes/suffixes
2 parents ea15b19 + b66c3f7 commit bd1d81a

File tree

2 files changed

+152
-18
lines changed

2 files changed

+152
-18
lines changed

‎grammars/javascript.cson‎

Lines changed: 98 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1932,17 +1932,57 @@
19321932
(?:
19331933
function # {function(string, number)} function type
19341934
\\s*
1935-
\\(
1936-
\\s*
19371935
(?:
1938-
[a-zA-Z_$][\\w$]*
19391936
(?:
1940-
\\s*,\\s*
1941-
[a-zA-Z_$][\\w$]*
1942-
)*
1943-
)?
1944-
\\s*
1945-
\\)
1937+
\\(\\s*
1938+
\\.{3}[a-zA-Z_$][\\w$]+ # {function(...string)} variable number of parameters
1939+
\\s*\\)
1940+
)
1941+
|
1942+
(?:
1943+
\\(\\s*
1944+
(?:
1945+
(?:\\?|!)? # {function(?string)} or function(!string)} nullable/non-nullable type
1946+
[a-zA-Z_$][\\w$]+
1947+
(?:\\[\\])? # {function(string[])} type application, an array of strings
1948+
(?:
1949+
(?:
1950+
(?:
1951+
\\s*,\\s*
1952+
(?:\\?|!)? # {function(?string)} or function(!string)} nullable/non-nullable type
1953+
[a-zA-Z_$][\\w$]+
1954+
(?:\\[\\])? # {function(string[])} type application, an array of strings
1955+
)*
1956+
(?:
1957+
\\s*,\\s*
1958+
\\.{3}[a-zA-Z_$][\\w$]+ # {function(string, ...string)} variable number of parameters
1959+
)?
1960+
)
1961+
|
1962+
(?:
1963+
=? # {function(string=)} optional parameter
1964+
(?:
1965+
(?<!=) # {function(string, string, number)} loop non-optional params
1966+
\\s*,\\s*
1967+
(?:\\?|!)? # {function(?string)} or function(!string)} nullable/non-nullable type
1968+
[a-zA-Z_$][\\w$]+
1969+
(?:\\[\\])? # {function(string[])} type application, an array of strings
1970+
=?
1971+
)*
1972+
(?:
1973+
(?<==) # {function(string, string=, number=)} loop optional params
1974+
\\s*,\\s*
1975+
(?:\\?|!)? # {function(?string)} or function(!string)} nullable/non-nullable type
1976+
[a-zA-Z_$][\\w$]+
1977+
(?:\\[\\])? # {function(string[])} type application, an array of strings
1978+
=
1979+
)*
1980+
)
1981+
)
1982+
)?
1983+
\\s*\\)
1984+
)
1985+
)
19461986
(?: # {function(): string} function return type
19471987
\\s*:\\s*
19481988
[a-zA-Z_$][\\w$]*
@@ -2063,17 +2103,57 @@
20632103
(?:
20642104
function # {function(string, number)} function type
20652105
\\s*
2066-
\\(
2067-
\\s*
20682106
(?:
2069-
[a-zA-Z_$][\\w$]*
20702107
(?:
2071-
\\s*,\\s*
2072-
[a-zA-Z_$][\\w$]*
2073-
)*
2074-
)?
2075-
\\s*
2076-
\\)
2108+
\\(\\s*
2109+
\\.{3}[a-zA-Z_$][\\w$]+ # {function(...string)} variable number of parameters
2110+
\\s*\\)
2111+
)
2112+
|
2113+
(?:
2114+
\\(\\s*
2115+
(?:
2116+
(?:\\?|!)? # {function(?string)} or function(!string)} nullable/non-nullable type
2117+
[a-zA-Z_$][\\w$]+
2118+
(?:\\[\\])? # {function(string[])} type application, an array of strings
2119+
(?:
2120+
(?:
2121+
(?:
2122+
\\s*,\\s*
2123+
(?:\\?|!)? # {function(?string)} or function(!string)} nullable/non-nullable type
2124+
[a-zA-Z_$][\\w$]+
2125+
(?:\\[\\])? # {function(string[])} type application, an array of strings
2126+
)*
2127+
(?:
2128+
\\s*,\\s*
2129+
\\.{3}[a-zA-Z_$][\\w$]+ # {function(string, ...string)} variable number of parameters
2130+
)?
2131+
)
2132+
|
2133+
(?:
2134+
=? # {function(string=)} optional parameter
2135+
(?:
2136+
(?<!=) # {function(string, string, number)} loop non-optional params
2137+
\\s*,\\s*
2138+
(?:\\?|!)? # {function(?string)} or function(!string)} nullable/non-nullable type
2139+
[a-zA-Z_$][\\w$]+
2140+
(?:\\[\\])? # {function(string[])} type application, an array of strings
2141+
=?
2142+
)*
2143+
(?:
2144+
(?<==) # {function(string, string=, number=)} loop optional params
2145+
\\s*,\\s*
2146+
(?:\\?|!)? # {function(?string)} or function(!string)} nullable/non-nullable type
2147+
[a-zA-Z_$][\\w$]+
2148+
(?:\\[\\])? # {function(string[])} type application, an array of strings
2149+
=
2150+
)*
2151+
)
2152+
)
2153+
)?
2154+
\\s*\\)
2155+
)
2156+
)
20772157
(?: # {function(): string} function return type
20782158
\\s*:\\s*
20792159
[a-zA-Z_$][\\w$]*

‎spec/javascript-spec.coffee‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2287,6 +2287,36 @@ describe "JavaScript grammar", ->
22872287
expect(tokens[6]).toEqual value: 'variable', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'variable.other.jsdoc']
22882288
expect(tokens[8]).toEqual value: 'this is the description ', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'other.description.jsdoc']
22892289
2290+
{tokens} = grammar.tokenizeLine('/** @param {function(...string)} variable this is the description */')
2291+
expect(tokens[4]).toEqual value: '{function(...string)}', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'entity.name.type.instance.jsdoc']
2292+
expect(tokens[6]).toEqual value: 'variable', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'variable.other.jsdoc']
2293+
expect(tokens[8]).toEqual value: 'this is the description ', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'other.description.jsdoc']
2294+
2295+
{tokens} = grammar.tokenizeLine('/** @param {function(string, ...number)} variable this is the description */')
2296+
expect(tokens[4]).toEqual value: '{function(string, ...number)}', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'entity.name.type.instance.jsdoc']
2297+
expect(tokens[6]).toEqual value: 'variable', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'variable.other.jsdoc']
2298+
expect(tokens[8]).toEqual value: 'this is the description ', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'other.description.jsdoc']
2299+
2300+
{tokens} = grammar.tokenizeLine('/** @param {function(string, number, ...number)} variable this is the description */')
2301+
expect(tokens[4]).toEqual value: '{function(string, number, ...number)}', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'entity.name.type.instance.jsdoc']
2302+
expect(tokens[6]).toEqual value: 'variable', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'variable.other.jsdoc']
2303+
expect(tokens[8]).toEqual value: 'this is the description ', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'other.description.jsdoc']
2304+
2305+
{tokens} = grammar.tokenizeLine('/** @param {function(!string)} variable this is the description */')
2306+
expect(tokens[4]).toEqual value: '{function(!string)}', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'entity.name.type.instance.jsdoc']
2307+
expect(tokens[6]).toEqual value: 'variable', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'variable.other.jsdoc']
2308+
expect(tokens[8]).toEqual value: 'this is the description ', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'other.description.jsdoc']
2309+
2310+
{tokens} = grammar.tokenizeLine('/** @param {function(?string, !number)} variable this is the description */')
2311+
expect(tokens[4]).toEqual value: '{function(?string, !number)}', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'entity.name.type.instance.jsdoc']
2312+
expect(tokens[6]).toEqual value: 'variable', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'variable.other.jsdoc']
2313+
expect(tokens[8]).toEqual value: 'this is the description ', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'other.description.jsdoc']
2314+
2315+
{tokens} = grammar.tokenizeLine('/** @param {function(string[], number=)} variable this is the description */')
2316+
expect(tokens[4]).toEqual value: '{function(string[], number=)}', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'entity.name.type.instance.jsdoc']
2317+
expect(tokens[6]).toEqual value: 'variable', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'variable.other.jsdoc']
2318+
expect(tokens[8]).toEqual value: 'this is the description ', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'other.description.jsdoc']
2319+
22902320
{tokens} = grammar.tokenizeLine('/** @param {function():number} variable this is the description */')
22912321
expect(tokens[4]).toEqual value: '{function():number}', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'entity.name.type.instance.jsdoc']
22922322
expect(tokens[6]).toEqual value: 'variable', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'variable.other.jsdoc']
@@ -2342,6 +2372,30 @@ describe "JavaScript grammar", ->
23422372
expect(tokens[4]).toEqual value: '{function(string, number)}', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'entity.name.type.instance.jsdoc']
23432373
expect(tokens[6]).toEqual value: 'this is the description ', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'other.description.jsdoc']
23442374
2375+
{tokens} = grammar.tokenizeLine('/** @return {function(...string)} this is the description */')
2376+
expect(tokens[4]).toEqual value: '{function(...string)}', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'entity.name.type.instance.jsdoc']
2377+
expect(tokens[6]).toEqual value: 'this is the description ', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'other.description.jsdoc']
2378+
2379+
{tokens} = grammar.tokenizeLine('/** @return {function(string, ...number)} this is the description */')
2380+
expect(tokens[4]).toEqual value: '{function(string, ...number)}', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'entity.name.type.instance.jsdoc']
2381+
expect(tokens[6]).toEqual value: 'this is the description ', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'other.description.jsdoc']
2382+
2383+
{tokens} = grammar.tokenizeLine('/** @return {function(string, number, ...number)} this is the description */')
2384+
expect(tokens[4]).toEqual value: '{function(string, number, ...number)}', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'entity.name.type.instance.jsdoc']
2385+
expect(tokens[6]).toEqual value: 'this is the description ', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'other.description.jsdoc']
2386+
2387+
{tokens} = grammar.tokenizeLine('/** @return {function(!string)} this is the description */')
2388+
expect(tokens[4]).toEqual value: '{function(!string)}', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'entity.name.type.instance.jsdoc']
2389+
expect(tokens[6]).toEqual value: 'this is the description ', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'other.description.jsdoc']
2390+
2391+
{tokens} = grammar.tokenizeLine('/** @return {function(?string, !number)} this is the description */')
2392+
expect(tokens[4]).toEqual value: '{function(?string, !number)}', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'entity.name.type.instance.jsdoc']
2393+
expect(tokens[6]).toEqual value: 'this is the description ', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'other.description.jsdoc']
2394+
2395+
{tokens} = grammar.tokenizeLine('/** @return {function(string[], number=)} this is the description */')
2396+
expect(tokens[4]).toEqual value: '{function(string[], number=)}', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'entity.name.type.instance.jsdoc']
2397+
expect(tokens[6]).toEqual value: 'this is the description ', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'other.description.jsdoc']
2398+
23452399
{tokens} = grammar.tokenizeLine('/** @return {function():number} this is the description */')
23462400
expect(tokens[4]).toEqual value: '{function():number}', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'entity.name.type.instance.jsdoc']
23472401
expect(tokens[6]).toEqual value: 'this is the description ', scopes: ['source.js', 'comment.block.documentation.js', 'other.meta.jsdoc', 'other.description.jsdoc']

0 commit comments

Comments
 (0)