Skip to content

Commit

Permalink
clarify what is valid jsdoc => canonical jsdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
andreineculau committed Oct 28, 2019
1 parent 305808b commit 0c68d79
Showing 1 changed file with 37 additions and 1 deletion.
38 changes: 37 additions & 1 deletion configs/basic.js
Original file line number Diff line number Diff line change
Expand Up @@ -372,7 +372,43 @@ module.exports = {
'template-tag-spacing': ['error', 'never'],
'unicode-bom': 'error',
'use-isnan': 'error',
'valid-jsdoc': 'error',
'valid-jsdoc': ['error', {
prefer: {
// no synonyms
arg: 'param',
argument: 'param',
const: 'constant',
defaultvalue: 'default',
desc: 'description',
emits: 'fires',
exception: 'throws',
extends: 'augments',
fileoverview: 'file',
func: 'function',
host: 'external',
method: 'function',
overview: 'file',
return: 'returns',
var: 'member',
virtual: 'abstract',
yield: 'yields'
},
preferType: {
BigInt: 'bigint',
Boolean: 'boolean',
Null: 'null',
Number: 'number',
String: 'string',
Symbol: 'symbol',
Undefined: 'undefined',
Void: 'void',
array: 'Array',
function: 'Function',
object: 'Object'
},
requireParamDescription: false,
requireReturnDescription: false
}],
'valid-typeof': 'error',
'vars-on-top': 'error',
'wrap-iife': ['error', 'inside'],
Expand Down

0 comments on commit 0c68d79

Please sign in to comment.