Disable require-jsdoc rule in test files

lifion · May 20, 2019 · fa76e0c · fa76e0c
1 parent ebbc375
commit fa76e0c
Show file tree

Hide file tree

Showing 3 changed files with 46 additions and 51 deletions.
diff --git a/lib/index.js b/lib/index.js
@@ -15,6 +15,15 @@ module.exports = {
     'plugin:unicorn/recommended',
     'prettier/unicorn'
   ],
+  overrides: [
+    {
+      files: ['*.test.js', '**/__mocks__/*.js'],
+      rules: {
+        'global-require': 'off',
+        'jsdoc/require-jsdoc': 'off'
+      }
+    }
+  ],
   parserOptions: {
     sourceType: 'script'
   },
@@ -43,6 +52,10 @@ module.exports = {
       }
     ],
     'jsdoc/require-hyphen-before-param-description': 'warn',
+    'jsdoc/require-jsdoc': [
+      'warn',
+      { require: { ClassDeclaration: true, MethodDefinition: true } }
+    ],
     'jsdoc/require-returns-description': 'off',
     'no-await-in-loop': 'off',
     'security/detect-object-injection': 'off',

diff --git a/lib/index.test.js b/lib/index.test.js
@@ -7,6 +7,7 @@ describe('lib/index', () => {
     expect(index).toEqual({
       env: expect.any(Object),
       extends: expect.any(Array),
+      overrides: expect.any(Array),
       parserOptions: {
         sourceType: 'script'
       },

diff --git a/package-lock.json b/package-lock.json