Skip to content

Commit

Permalink
🏗 Disable JSDoc requirement on Storybook files (ampproject#34255)
Browse files Browse the repository at this point in the history
Disable `require-jsdoc` since it auto-fixes, and we don't need JSDoc in these locations.

We preserve the following rules since they ensure correctness, like type-check already does.

jsdoc/check-param-names
jsdoc/check-tag-names
jsdoc/check-types
jsdoc/require-param
jsdoc/require-param-name
jsdoc/require-param-type
jsdoc/require-returns
jsdoc/require-returns-type
  • Loading branch information
alanorozco authored and rochapablo committed Aug 30, 2021
1 parent 62ee017 commit 344924f
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
8 changes: 7 additions & 1 deletion .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -312,12 +312,18 @@ module.exports = {
'**/_init_tests.js',
'**/*_test.js',
'**/testing/**',
'**/storybook/*.js',
],
'rules': {
'local/no-forbidden-terms': [2, forbiddenTermsGlobal],
},
},
{
'files': ['**/storybook/*.js'],
'rules': {
'require-jsdoc': 0,
'local/no-forbidden-terms': [2, forbiddenTermsGlobal],
},
},
{
'files': [
'**/.eslintrc.js',
Expand Down
4 changes: 0 additions & 4 deletions extensions/amp-video/1.0/storybook/_helpers.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,6 @@
*/
import * as Preact from '../../../../src/preact';

/**
* @param {*} props
* @return {*}
*/
export const VideoElementWithActions = ({
id,
children,
Expand Down

0 comments on commit 344924f

Please sign in to comment.