Skip to content

Commit

Permalink
WIP need to define multiline-blocks and move on from there
Browse files Browse the repository at this point in the history
  • Loading branch information
gurpreetatwal committed Jul 14, 2022
1 parent a6de3a1 commit 586533a
Show file tree
Hide file tree
Showing 3 changed files with 60 additions and 24 deletions.
15 changes: 12 additions & 3 deletions index.js
Original file line number Diff line number Diff line change
Expand Up @@ -542,7 +542,8 @@ module.exports = {
checkDestructured: true,
checkRestProperty: true,
allowExtraTrailingParamDocs: false,
useDefaultObjectProperties: true,
useDefaultObjectProperties: false,
disableExtraPropertyReporting: true,
},
],
'jsdoc/check-property-names': 'error',
Expand All @@ -557,10 +558,17 @@ module.exports = {
'jsdoc/implements-on-classes': 'error',
'jsdoc/match-description': 'off',
'jsdoc/newline-after-description': ['error', 'always'],
'jsdoc/no-bad-blocks': 'error',
'jsdoc/no-bad-blocks': ['error', { preventAllMultiAsteriskBlocks: true }],
'jsdoc/no-defaults': 'off',
'jsdoc/no-missing-syntax': 'off',
'jsdoc/no-restricted-syntax': 'off',
'jsdoc/no-types': 'off', // only needed if using TS
'jsdoc/no-undefined-types': 'off', // weird to enforce without formal TS support
'jsdoc/require-asterisk-prefix': [
'error',
'always',
{ tags: { any: ['*description'] } },
],
'jsdoc/require-description-complete-sentence': 'off', // too strict
'jsdoc/require-description': 'off', // too strict
'jsdoc/require-example': 'off', // too strict
Expand All @@ -579,7 +587,7 @@ module.exports = {
'jsdoc/require-property-name': 'error',
'jsdoc/require-property-type': 'error',
'jsdoc/require-property': 'error',
'jsdoc/require-returns-check': 'error',
'jsdoc/require-returns-check': ['error', { exemptAsync: false }],
'jsdoc/require-returns-description': 'off', // not needed when function is clear enough
'jsdoc/require-returns-type': 'error',
'jsdoc/require-returns': [
Expand All @@ -600,6 +608,7 @@ module.exports = {
{ checkGeneratorsOnly: true, next: true },
],
'jsdoc/require-throws': 'off',
'jsdoc/tag-lines': 'off',
'jsdoc/valid-types': ['error', { allowEmptyNamepaths: true }],

/**
Expand Down
67 changes: 47 additions & 20 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
"eslint-plugin-ava": "13.2.0",
"eslint-plugin-eslint-comments": "3.2.0",
"eslint-plugin-import": "2.26.0",
"eslint-plugin-jsdoc": "^31.2.3",
"eslint-plugin-jsdoc": "^34.4.0",
"eslint-plugin-lodash": "7.4.0",
"eslint-plugin-mocha": "10.0.5",
"eslint-plugin-no-use-extend-native": "0.5.0",
Expand Down

0 comments on commit 586533a

Please sign in to comment.