Skip to content

Commit c2c2884

Browse files
committed
Add missing schema and test case
1 parent 4cd557a commit c2c2884

3 files changed

Lines changed: 40 additions & 2 deletions

File tree

lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-tag-names/lib/main.js

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,17 @@ module.exports = {
9090
'docs': {
9191
'description': 'enforce that only allowed JSDoc tags are used'
9292
},
93-
'schema': []
93+
'schema': [
94+
{
95+
'type': 'object',
96+
'properties': {
97+
'tags': {
98+
'type': 'array'
99+
}
100+
},
101+
'additionalProperties': false
102+
}
103+
]
94104
},
95105
'create': main
96106
};

lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-tag-names/test/fixtures/invalid.js

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,34 @@ test = {
124124
};
125125
invalid.push( test );
126126

127+
test = {
128+
'code': [
129+
'/**',
130+
'* Squares a number.',
131+
'* ',
132+
'* @param {number} x - input number',
133+
'* @returns {number} x squared',
134+
'*',
135+
'* @example',
136+
'* var y = square( 2.0 );',
137+
'* // returns 4.0',
138+
'*/',
139+
'function square( x ) {',
140+
' return x*x;',
141+
'}'
142+
].join( '\n' ),
143+
'errors': [
144+
{
145+
'message': '"example" is not one of the allowed tags ("param","returns")',
146+
'type': null
147+
}
148+
],
149+
'options': [{
150+
'tags': [ 'param', 'returns' ]
151+
}]
152+
};
153+
invalid.push( test );
154+
127155

128156
// EXPORTS //
129157

lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-tag-names/test/fixtures/unvalidated.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ var test;
55

66
test = {
77
'code': [
8-
'function fizzBuzz( x ) {',
8+
'function fizzBuzz() {',
99
' // This is a single-line comment',
1010
' var out;',
1111
' var i;',

0 commit comments

Comments
 (0)