adding require-jsdoc functionality per library (#2555)

microsoft · Jul 26, 2020 · 2e1b42d · 2e1b42d
1 parent 6c7922b
commit 2e1b42d
Show file tree

Hide file tree

Showing 2 changed files with 260 additions and 1 deletion.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -5,6 +5,264 @@
         "only-warn"
     ],
     "extends": ["plugin:@typescript-eslint/recommended"],
+    "overrides": [
+        {
+            "files": ["libraries/adaptive-expressions/src/*.ts", "libraries/adaptive-expressions/src/**/*.ts"],
+            "plugins": ["jsdoc"],
+            "rules": {
+              "jsdoc/require-jsdoc": ["warn", {
+                  "require": {
+                      "FunctionDeclaration": true,
+                      "MethodDefinition": true,
+                      "ClassDeclaration": true,
+                      "ArrowFunctionExpression": false,
+                      "FunctionExpression": false
+                  },
+                  "publicOnly": true
+              }]
+            }
+        },
+        {
+            "files": ["libraries/botbuilder/src/*.ts", "libraries/botbuilder/src/**/*.ts"],
+            "plugins": ["jsdoc"],
+            "rules": {
+              "jsdoc/require-jsdoc": ["warn", {
+                  "require": {
+                      "FunctionDeclaration": true,
+                      "MethodDefinition": true,
+                      "ClassDeclaration": true,
+                      "ArrowFunctionExpression": false,
+                      "FunctionExpression": false
+                  },
+                  "publicOnly": true
+              }]
+            }
+        },
+        {
+            "files": ["libraries/botbuilder-ai/src/*.ts", "libraries/botbuilder-ai/src/**/*.ts"],
+            "plugins": ["jsdoc"],
+            "rules": {
+              "jsdoc/require-jsdoc": ["warn", {
+                  "require": {
+                      "FunctionDeclaration": true,
+                      "MethodDefinition": true,
+                      "ClassDeclaration": true,
+                      "ArrowFunctionExpression": false,
+                      "FunctionExpression": false
+                  },
+                  "publicOnly": true
+              }]
+            }
+        },
+        {
+            "files": ["libraries/botbuilder-applicationinsights/src/*.ts", "libraries/botbuilder-applicationinsights/src/**/*.ts"],
+            "plugins": ["jsdoc"],
+            "rules": {
+              "jsdoc/require-jsdoc": ["warn", {
+                  "require": {
+                      "FunctionDeclaration": true,
+                      "MethodDefinition": true,
+                      "ClassDeclaration": true,
+                      "ArrowFunctionExpression": false,
+                      "FunctionExpression": false
+                  },
+                  "publicOnly": true
+              }]
+            }
+        },
+        {
+            "files": ["libraries/botbuilder-azure/src/*.ts", "libraries/botbuilder-azure/src/**/*.ts"],
+            "plugins": ["jsdoc"],
+            "rules": {
+              "jsdoc/require-jsdoc": ["warn", {
+                  "require": {
+                      "FunctionDeclaration": true,
+                      "MethodDefinition": true,
+                      "ClassDeclaration": true,
+                      "ArrowFunctionExpression": false,
+                      "FunctionExpression": false
+                  },
+                  "publicOnly": true
+              }]
+            }
+        },
+        {
+            "files": ["libraries/botbuilder-core/src/*.ts", "libraries/botbuilder-core/src/**/*.ts"],
+            "plugins": ["jsdoc"],
+            "rules": {
+              "jsdoc/require-jsdoc": ["warn", {
+                  "require": {
+                      "FunctionDeclaration": true,
+                      "MethodDefinition": true,
+                      "ClassDeclaration": true,
+                      "ArrowFunctionExpression": false,
+                      "FunctionExpression": false
+                  },
+                  "publicOnly": true
+              }]
+            }
+        },
+        {
+            "files": ["libraries/botbuilder-dialogs/src/*.ts", "libraries/botbuilder-dialogs/src/**/*.ts"],
+            "plugins": ["jsdoc"],
+            "rules": {
+              "jsdoc/require-jsdoc": ["warn", {
+                  "require": {
+                      "FunctionDeclaration": true,
+                      "MethodDefinition": true,
+                      "ClassDeclaration": true,
+                      "ArrowFunctionExpression": false,
+                      "FunctionExpression": false
+                  },
+                  "publicOnly": true
+              }]
+            }
+        },
+        {
+            "files": ["libraries/botbuilder-dialogs-adaptive/src/*.ts", "libraries/botbuilder-dialogs-adaptive/src/**/*.ts"],
+            "plugins": ["jsdoc"],
+            "rules": {
+              "jsdoc/require-jsdoc": ["warn", {
+                  "require": {
+                      "FunctionDeclaration": true,
+                      "MethodDefinition": true,
+                      "ClassDeclaration": true,
+                      "ArrowFunctionExpression": false,
+                      "FunctionExpression": false
+                  },
+                  "publicOnly": true
+              }]
+            }
+        },
+        {
+            "files": ["libraries/botbuilder-dialogs-adaptive-tests/src/*.ts", "libraries/botbuilder-dialogs-adaptive-tests/src/**/*.ts"],
+            "plugins": ["jsdoc"],
+            "rules": {
+              "jsdoc/require-jsdoc": ["warn", {
+                  "require": {
+                      "FunctionDeclaration": true,
+                      "MethodDefinition": true,
+                      "ClassDeclaration": true,
+                      "ArrowFunctionExpression": false,
+                      "FunctionExpression": false
+                  },
+                  "publicOnly": true
+              }]
+            }
+        },
+        {
+            "files": ["libraries/botbuilder-dialogs-declarative/src/*.ts", "libraries/botbuilder-dialogs-declarative/src/**/*.ts"],
+            "plugins": ["jsdoc"],
+            "rules": {
+              "jsdoc/require-jsdoc": ["warn", {
+                  "require": {
+                      "FunctionDeclaration": true,
+                      "MethodDefinition": true,
+                      "ClassDeclaration": true,
+                      "ArrowFunctionExpression": false,
+                      "FunctionExpression": false
+                  },
+                  "publicOnly": true
+              }]
+            }
+        },
+        {
+            "files": ["libraries/botbuilder-lg/src/*.ts", "libraries/botbuilder-lg/src/**/*.ts"],
+            "plugins": ["jsdoc"],
+            "rules": {
+              "jsdoc/require-jsdoc": ["warn", {
+                  "require": {
+                      "FunctionDeclaration": true,
+                      "MethodDefinition": true,
+                      "ClassDeclaration": true,
+                      "ArrowFunctionExpression": false,
+                      "FunctionExpression": false
+                  },
+                  "publicOnly": true
+              }]
+            }
+        },
+        {
+            "files": ["libraries/botbuilder-testing/src/*.ts", "libraries/botbuilder-testing/src/**/*.ts"],
+            "plugins": ["jsdoc"],
+            "rules": {
+              "jsdoc/require-jsdoc": ["warn", {
+                  "require": {
+                      "FunctionDeclaration": true,
+                      "MethodDefinition": true,
+                      "ClassDeclaration": true,
+                      "ArrowFunctionExpression": false,
+                      "FunctionExpression": false
+                  },
+                  "publicOnly": true
+              }]
+            }
+        },
+        {
+            "files": ["libraries/botframework-config/src/*.ts", "libraries/botframework-config/src/**/*.ts"],
+            "plugins": ["jsdoc"],
+            "rules": {
+              "jsdoc/require-jsdoc": ["warn", {
+                  "require": {
+                      "FunctionDeclaration": true,
+                      "MethodDefinition": true,
+                      "ClassDeclaration": true,
+                      "ArrowFunctionExpression": false,
+                      "FunctionExpression": false
+                  },
+                  "publicOnly": true
+              }]
+            }
+        },
+        {
+            "files": ["libraries/botframework-connector/src/*.ts", "libraries/botframework-connector/src/**/*.ts"],
+            "plugins": ["jsdoc"],
+            "rules": {
+              "jsdoc/require-jsdoc": ["warn", {
+                  "require": {
+                      "FunctionDeclaration": true,
+                      "MethodDefinition": true,
+                      "ClassDeclaration": true,
+                      "ArrowFunctionExpression": false,
+                      "FunctionExpression": false
+                  },
+                  "publicOnly": true
+              }]
+            }
+        },
+        {
+            "files": ["libraries/botframework-schema/src/*.ts", "libraries/botframework-schema/src/**/*.ts"],
+            "plugins": ["jsdoc"],
+            "rules": {
+              "jsdoc/require-jsdoc": ["warn", {
+                  "require": {
+                      "FunctionDeclaration": true,
+                      "MethodDefinition": true,
+                      "ClassDeclaration": true,
+                      "ArrowFunctionExpression": false,
+                      "FunctionExpression": false
+                  },
+                  "publicOnly": true
+              }]
+            }
+        },
+        {
+          "files": ["libraries/botframework-streaming/src/*.ts", "libraries/botframework-streaming/src/**/*.ts"],
+          "plugins": ["jsdoc"],
+          "rules": {
+            "jsdoc/require-jsdoc": ["warn", {
+                "require": {
+                    "FunctionDeclaration": true,
+                    "MethodDefinition": true,
+                    "ClassDeclaration": true,
+                    "ArrowFunctionExpression": false,
+                    "FunctionExpression": false
+                },
+                "publicOnly": true
+            }]
+          }
+        }
+    ],
     "parserOptions": {
         "ecmaVersion": 9,
         "sourceType": "module",
@@ -28,6 +286,6 @@
         "@typescript-eslint/no-object-literal-type-assertion": ["error", {
             "allowAsParameter": true
          }],
-         "@typescript-eslint/no-use-before-define": ["error", { "functions": false, "classes": true }]
+        "@typescript-eslint/no-use-before-define": ["error", { "functions": false, "classes": true }]
     }
 }
diff --git a/package.json b/package.json
@@ -30,6 +30,7 @@
     "coveralls": "^3.0.4",
     "eslint": "^5.16.0",
     "eslint-plugin-only-warn": "^1.0.1",
+    "eslint-plugin-jsdoc": "^29.2.0",
     "lerna": "^3.2.1",
     "mocha": "^6.2.3",
     "ms-rest-azure": "^2.6.0",