diff options
Diffstat (limited to '.eslintrc-jsdoc.js')
-rw-r--r-- | .eslintrc-jsdoc.js | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/.eslintrc-jsdoc.js b/.eslintrc-jsdoc.js new file mode 100644 index 0000000000..6f7351ec08 --- /dev/null +++ b/.eslintrc-jsdoc.js @@ -0,0 +1,29 @@ +module.exports = { + rules: { + 'require-jsdoc': 'off', + 'valid-jsdoc': [ 'error', { + prefer: { + arg: 'param', + argument: 'param', + extends: 'augments', + returns: 'return', + }, + preferType: { + array: 'Array', + bool: 'boolean', + Boolean: 'boolean', + float: 'number', + Float: 'number', + int: 'number', + integer: 'number', + Integer: 'number', + Number: 'number', + object: 'Object', + String: 'string', + Void: 'void', + }, + requireParamDescription: false, + requireReturn: false, + } ], + }, +}; |