eslint-config-node-services - npm Package Compare versions

Comparing version 2.0.2 to 2.1.0

.eslintrc.js

@@ -8,3 +8,3 @@ "use strict";
     },
-    "plugins": ["json"],
+    "plugins": ["jsdoc", "json"],
     "rules": {
@@ -354,3 +354,11 @@ "no-alert": "error",
             "never"
-        ]
+        ],
+
+        // https://www.npmjs.com/package/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules
+        "jsdoc/check-param-names": "warn",
+        "jsdoc/check-tag-names": "warn",
+        "jsdoc/check-types": "warn",
+        "jsdoc/newline-after-description": ["warn", "never"],
+        "jsdoc/require-param-type": "warn",
+        "jsdoc/require-returns-type": "warn"
     },
@@ -364,4 +372,32 @@ "parserOptions": {
     "ecmaFeatures": {},
-    "extends": "eslint:recommended"
+    "extends": "eslint:recommended",
+    "settings": {
+        // https://www.npmjs.com/package/eslint-plugin-jsdoc#eslint-plugin-jsdoc-settings-alias-preference
+        "jsdoc": {
+            // one synonym for each ambiguity listed: http://usejsdoc.org/#block-tags
+            "tagNamePreference": {
+                abstract: "virtual",
+                arg: "param",
+                argument: "param",
+                augments: "extends",
+                constructor: "class",
+                constant: "const",
+                defaultvalue: "default",
+                description: "desc",
+                host: "external",
+                fileoverview: "file",
+                overview: "file",
+                fires: "emits",
+                function: "func",
+                method: "func",
+                member: "var",
+                property: "prop",
+                returns: "return",
+                exception: "throws",
+                linkcode: "link",
+                linkplain: "link"
+            }
+        }
+    }
 };
 

package.json

 {
   "name": "eslint-config-node-services",
-  "version": "2.0.2",
+  "version": "2.1.0",
   "description": "ESLint configuration for Wikimedia node.js services",
@@ -27,2 +27,3 @@ "main": ".eslintrc.js",
     "eslint": "^3.12.0",
+    "eslint-plugin-jsdoc": "^2.4.0",
     "eslint-plugin-json": "^1.2.0"
@@ -32,2 +33,3 @@ },
     "eslint": "^3.12.0",
+    "eslint-plugin-jsdoc": "^2.4.0",
     "eslint-plugin-json": "^1.2.0",
@@ -34,0 +36,0 @@ "pre-commit": "^1.2.2"

README.md

@@ -11,3 +11,4 @@ # eslint-config-node-services
  - [swagger-router](https://github.com/wikimedia/swagger-router)
+ - [service-template-node](https://github.com/wikimedia/service-template-node)
  
 Please test any proposed changes to the config against all thouse repos to avoid breaking the builds.

No alert changes

Improved metrics

Total package byte prevSize

25780

increased by6.26%

Lines of code

397

increased by9.67%

Number of lines in readme file

14

increased by7.69%

Worsened metrics

Dependency count

3

increased by50%

Dev dependency count

4

increased by33.33%

No dependency changes