Merge branch 'development' into reactstrap

.eslintrc.json

@@ -10,11 +10,8 @@
     },
     "extends": [
         "eslint:recommended",
-        "plugin:@typescript-eslint/recommended"
-        // uncomment this to enforce eslint-plugin-jsdoc rules (and add comma above)
-        // along with the plugins below for jsdoc.
-        //the line of code below is in regards to https://github.com/OpenEnergyDashboard/OED/issues/396 
-        // "plugin:jsdoc/recommended"
+        "plugin:@typescript-eslint/recommended", 
+        "plugin:jsdoc/recommended-typescript"
     ],
     "parser": "@typescript-eslint/parser",
     "parserOptions": {
@@ -25,18 +22,14 @@
         "sourceType": "module"
     },
     "plugins": [
-        "@typescript-eslint"
-        //this section of code is for running jsdoc checker (eslint-plugin-jsdoc) https://github.com/OpenEnergyDashboard/OED/issues/396.
-        // It needs to be uncommented if using jsdoc plugin and add a comma above.
-        // "jsdoc"
+        "@typescript-eslint",
+        "jsdoc"
     ],
     "rules": {
         //https://github.com/typescript-eslint/typescript-eslint/issues/1824, indent is therefore turned off and we use typescript-eslint/indent instead
         "indent": [
             "off"
         ],
-        // TODO: Decide whether this setting should be on or off
-        // "jsdoc/newline-after-description": 0,
         "@typescript-eslint/indent": [
             "error",
             "tab",
@@ -78,7 +71,7 @@
     },
     "overrides": [
         {
-            // also possible in the future to limit to src/client/app/components/**/*.tsx files, where we make sure {} is only used for props.
+            // TODO: Remove this override once these components have been converted to use hooks
             "files": [
                 "src/client/app/containers/admin/CreateUserContainer.tsx",
                 "src/client/app/containers/csv/UploadCSVContainer.tsx"
@@ -154,6 +147,31 @@
                     "as-needed"
                 ]
             }
+        },
+        {
+            // disable jsdoc requirement for reducers and actions
+            "files": [
+                "src/client/app/reducers/*.ts",
+                "src/client/app/actions/*.ts"
+            ],
+            "rules": {
+                "jsdoc/require-jsdoc": "off",
+                "jsdoc/require-returns": "off"
+            }
+        },
+        {
+            // disable jsdoc for containers separately
+            // jsdoc makes sense for containers but we are working on removing them from the codebase
+            // TODO: Remove this override once containers have been converted
+            "files": [
+                "src/client/app/containers/*/*",
+                "src/client/app/containers/*"
+            ],
+            "rules": {
+                "jsdoc/require-jsdoc": "off",
+                "jsdoc/require-returns": "off",
+                "jsdoc/require-param": "off"
+            }
         }
     ]
 }