Testing eslintrc config

medic · Aug 21, 2024 · e3b0f56 · e3b0f56
1 parent 2e31d49
commit e3b0f56
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 10 deletions.
diff --git a/.eslintrc b/.eslintrc
@@ -16,6 +16,7 @@
     "build/**",
     "jsdocs/**",
     "shared-libs/cht-datasource/dist/**",
+    "shared-libs/cht-datasource/docs/**",
     "tests/scalability/report*/**",
     "tests/scalability/jmeter/**",
     "webapp/src/ts/providers/xpath-element-path.provider.ts"

diff --git a/shared-libs/cht-datasource/.eslintrc.js b/shared-libs/cht-datasource/.eslintrc.js
@@ -1,3 +1,13 @@
+const JS_DOC_REQUIRED_CONTEXTS = [
+  'FunctionDeclaration',
+  'FunctionExpression',
+  'VariableDeclaration',
+  'TSInterfaceDeclaration',
+  'TSTypeAliasDeclaration',
+  'TSEnumDeclaration',
+  'TSMethodSignature'
+];
+
 module.exports = {
   overrides: [
     {
@@ -19,11 +29,6 @@ module.exports = {
       settings: {
         jsdoc: {
           contexts: [
-            'VariableDeclaration',
-            'TSInterfaceDeclaration',
-            'TSTypeAliasDeclaration',
-            'TSEnumDeclaration',
-            'TSMethodSignature'
           ]
         }
       },
@@ -42,9 +47,22 @@ module.exports = {
             FunctionExpression: true,
             MethodDefinition: true,
           },
-          publicOnly: true,
+          contexts: JS_DOC_REQUIRED_CONTEXTS,
+          publicOnly: true
         }],
-        ['jsdoc/check-tag-names']: ['error', { definedTags: ['typeParam'] }],
+        ['jsdoc/require-param']: ['error', {
+          contexts: JS_DOC_REQUIRED_CONTEXTS,
+          exemptedBy: ['private', 'internal']
+        }],
+        ['jsdoc/require-returns']: ['error', {
+          contexts: JS_DOC_REQUIRED_CONTEXTS,
+          exemptedBy: ['private', 'internal']
+        }],
+        ['jsdoc/require-yields']: ['error', {
+          contexts: JS_DOC_REQUIRED_CONTEXTS,
+          exemptedBy: ['private', 'internal']
+        }],
+        ['jsdoc/check-tag-names']: ['error', { definedTags: ['typeParam']}],
       }
     }
   ]

diff --git a/shared-libs/cht-datasource/test/person.spec.ts b/shared-libs/cht-datasource/test/person.spec.ts
@@ -249,9 +249,6 @@ describe('person', () => {
           yield person;
         }
       };
-      const emptyMockGenerator = function* () {
-        // empty
-      };
 
       let personGetPage: sinon.SinonStub;
       let getPagedGenerator: sinon.SinonStub;