Add new eslint rules for jsdoc

OpenGeoscience · Jun 13, 2017 · 3c0074b · 3c0074b
1 parent 0889a10
commit 3c0074b
Showing 1 changed file with 27 additions and 0 deletions.
diff --git a/src/.eslintrc b/src/.eslintrc
@@ -0,0 +1,27 @@
+{
+    "rules": {
+        "valid-jsdoc": ["warn", {
+            "preferType": {
+                "Object": "object",
+                "Number": "number",
+                "String": "string",
+                "Boolean": "boolean",
+                "bool": "boolean"
+            },
+            "prefer": {
+                "return": "returns"
+            },
+            "requireReturn": false,
+            "requireReturnDescription": false,
+            "requireParamDescription": false,
+            "matchDescription": "^[^a-z][\\s\\S]*\\.$"
+        }],
+        "require-jsdoc": ["error", {
+            "require": {
+                "FunctionDeclaration": false,
+                "MethodDefinition": true,
+                "ClassDeclaration": true
+            }
+        }]
+    }
+}