@hellomouse/eslint-config - npm Package Compare versions

Comparing version 1.1.1 to 1.1.2

index.js

@@ -47,3 +47,21 @@ module.exports = {
     // use jsdoc/require-jsdoc instead
-    'require-jsdoc': 'off'
+    'require-jsdoc': 'off',
+
+    // descriptions on params and return is often redundant
+    // for example:
+    /*
+     * Adds given numbers
+     *
+     * @param {Number} a First number
+     * @param {Number} b Second number
+     * @return {Number} The result of the operation
+     */
+    'jsdoc/require-param-description': 'off',
+    'jsdoc/require-returns-description': 'off',
+
+    // not everything needs to be a complete sentence
+    'jsdoc/require-description-complete-sentence': 'off',
+
+    // most things explain themselves
+    'jsdoc/require-example': 'off'
   },
@@ -59,3 +77,3 @@ settings: {
     }
-}
+  }
 };

package.json

 {
   "name": "@hellomouse/eslint-config",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "description": "Official ESLint config for Hellomouse, based off of Google's config",
@@ -5,0 +5,0 @@ "main": "index.js",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

4228

increased by14.7%

Lines of code

65

increased by30%

No dependency changes