@playcanvas/eslint-config 1.0.12 → 1.0.16

package/LICENSE

@@ -1,6 +1,4 @@
-MIT License
-
-Copyright (c) 2018 PlayCanvas
+Copyright (c) 2011-2021 PlayCanvas Ltd.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -9,13 +7,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -1,2 +1,25 @@
-# eslint-config-playcanvas
-ESLint configuration used by PlayCanvas
+# PlayCanvas ESLint Config
+
+ESLint configuration developed by the PlayCanvas team and leveraged by many PlayCanvas-related projects, including the [PlayCanvas Engine][engine]. However, you can use it for any JavaScript-based project if you approve of the PlayCanvas coding style.
+
+The configuration is defined in [`index.js`][index]. It configures ESLint's rules in the same order as they are enumerated [here][rules]. It also configures rules for checking JSDoc comments using the ESLint plugin [`eslint-plugin-jsdoc-rules`][jsdoc-plugin].
+
+The configuration attempts to enable as many rules as possible, particularly those categorized as 'recommended' by ESLint.
+
+## Using this config in your own projects
+
+Edit your project's `package.json` file:
+
+1. Add `eslint` and `@playcanvas/eslint-config` to your `devDependencies` section.
+2. Add an `eslintConfig` section. At a minimum, you will need:
+
+```json
+    "eslintConfig": {
+        "extends": "@playcanvas/eslint-config"
+    },
+```
+
+[engine]: https://github.com/playcanvas/engine
+[index]: https://github.com/playcanvas/playcanvas-eslint-config/blob/master/index.js
+[rules]: https://eslint.org/docs/rules/
+[jsdoc-plugin]: https://github.com/gajus/eslint-plugin-jsdoc

package/index.js

@@ -1,7 +1,7 @@
 module.exports = {
 
   "parserOptions": {
-    "ecmaVersion": 2015,
+    "ecmaVersion": "latest",
     "sourceType": "module",
     "ecmaFeatures": {}
   },
@@ -54,7 +54,7 @@ module.exports = {
     "no-sparse-arrays": "error",
     "no-template-curly-in-string": "error",
     "no-this-before-super": "error",
-    "no-undef": "off",
+    "no-undef": "error",
     "no-unexpected-multiline": "error",
     "no-unmodified-loop-condition": "error",
     "no-unreachable": "error",
@@ -62,13 +62,17 @@ module.exports = {
     "no-unsafe-finally": "error",
     "no-unsafe-negation": "error",
     "no-unsafe-optional-chaining": "error",
-    "no-unused-private-class-members": "off", // update to error (requires eslint 8.1.0)
+    "no-unused-private-class-members": "error",
     "no-unused-vars": [
-      "warn", {
+      "error", {
         "args": "none"
       }
     ],
-    "no-use-before-define": ["error", { "functions": false }],
+    "no-use-before-define": [
+      "error", {
+        "functions": false
+      }
+    ],
     "no-useless-backreference": "error",
     "require-atomic-updates": "error",
     "use-isnan": "error",
@@ -93,7 +97,7 @@ module.exports = {
     "func-name-matching": "error",
     "func-names": "off",
     "func-style": "off",
-    "grouped-accessor-pairs": "error",
+    "grouped-accessor-pairs": ["error", "setBeforeGet"],
     "guard-for-in": "off",
     "id-denylist": "off",
     "id-length": "off",
@@ -218,7 +222,11 @@ module.exports = {
     "sort-imports": "off",
     "sort-keys": "off",
     "sort-vars": "off",
-    "spaced-comment": ["error", "always", { "exceptions": ["/"] }],
+    "spaced-comment": [
+      "error", "always", {
+        "exceptions": ["/"]
+      }
+    ],
     "strict": "error",
     "symbol-description": "error",
     "vars-on-top": "off",
@@ -237,7 +245,12 @@ module.exports = {
     "block-spacing": "error",
     "brace-style": "error",
     "comma-dangle": ["error", "never"],
-    "comma-spacing": ["error", { "before": false, "after": true }],
+    "comma-spacing": [
+      "error", {
+        "before": false,
+        "after": true
+      }
+    ],
     "comma-style": ["error", "last"],
     "computed-property-spacing": ["error", "never"],
     "dot-location": ["error", "property"],
@@ -257,8 +270,18 @@ module.exports = {
       }
     ],
     "jsx-quotes": "off",
-    "key-spacing": ["error", { "beforeColon": false, "afterColon": true }],
-    "keyword-spacing": ["error", { "before": true, "after": true }],
+    "key-spacing": [
+      "error", {
+        "beforeColon": false,
+        "afterColon": true
+      }
+    ],
+    "keyword-spacing": [
+      "error", {
+        "before": true,
+        "after": true
+      }
+    ],
     "line-comment-position": "off",
     "linebreak-style": "off",
     "lines-around-comment": "off",
@@ -284,26 +307,52 @@ module.exports = {
         }
       }
     ],
-    "no-multiple-empty-lines": ["error", { "max": 2, "maxBOF": 0, "maxEOF": 0 }],
+    "no-multiple-empty-lines": [
+      "error", {
+        "max": 2,
+        "maxBOF": 0,
+        "maxEOF": 0
+      }
+    ],
     "no-tabs": "error",
     "no-trailing-spaces": "error",
     "no-whitespace-before-property": "error",
     "nonblock-statement-body-position": "off",
-    "object-curly-newline": ["error", { "consistent": true }],
+    "object-curly-newline": [
+      "error", {
+        "consistent": true
+      }
+    ],
     "object-curly-spacing": ["error", "always"],
-    "object-property-newline": ["error", { "allowAllPropertiesOnSameLine": true }],
+    "object-property-newline": [
+      "error", {
+        "allowAllPropertiesOnSameLine": true
+      }
+    ],
     "operator-linebreak": ["error", "after"],
-    "padded-blocks": ["error", {
-      "classes": "never"
-    }],
+    "padded-blocks": [
+      "error", {
+        "classes": "never"
+      }
+    ],
     "padding-line-between-statements": "off",
     "quotes": ["off", "single"],
     "rest-spread-spacing": "error",
     "semi": ["error", "always"],
-    "semi-spacing": [ "error", { "before": false, "after": true } ],
+    "semi-spacing": [
+      "error", {
+        "before": false,
+        "after": true
+      }
+    ],
     "semi-style": ["error", "last"],
     "space-before-blocks": "error",
-    "space-before-function-paren": ["error", { "anonymous": "always", "named": "never" }],
+    "space-before-function-paren": [
+      "error", {
+        "anonymous": "always",
+        "named": "never"
+      }
+    ],
     "space-in-parens": ["error", "never"],
     "space-infix-ops": [
       "error", {
@@ -317,7 +366,12 @@ module.exports = {
         "overrides": {
         }
     }],
-    "switch-colon-spacing": ["error", {"after": true, "before": false}],
+    "switch-colon-spacing": [
+      "error", {
+        "after": true,
+        "before": false
+      }
+    ],
     "template-curly-spacing": "error",
     "template-tag-spacing": "error",
     "unicode-bom": ["error", "never"],
@@ -330,24 +384,20 @@ module.exports = {
     "jsdoc/check-alignment": "error",
     "jsdoc/check-examples": "off",
     "jsdoc/check-indentation": "off",
-    "jsdoc/check-line-alignment": "off",
+    "jsdoc/check-line-alignment": "error",
     "jsdoc/check-param-names": "off",
     "jsdoc/check-property-names": "error",
     "jsdoc/check-syntax": "error",
-    "jsdoc/check-tag-names": [
-      "error", {
-        "definedTags": ["component", "field"]
-      }
-    ],
+    "jsdoc/check-tag-names": "error",
     "jsdoc/check-types": "error",
     "jsdoc/check-values": "error",
     "jsdoc/empty-tags": "error",
     "jsdoc/implements-on-classes": "error",
     "jsdoc/match-description": "off",
     "jsdoc/match-name": "off",
-    "jsdoc/multiline-blocks": "off",
+    "jsdoc/multiline-blocks": "error",
     "jsdoc/newline-after-description": "error",
-    "jsdoc/no-bad-blocks": "off",
+    "jsdoc/no-bad-blocks": "error",
     "jsdoc/no-defaults": "off",
     "jsdoc/no-missing-syntax": "off",
     "jsdoc/no-multi-asterisks": "error",
@@ -364,7 +414,7 @@ module.exports = {
     "jsdoc/require-example": "off",
     "jsdoc/require-file-overview": "off",
     "jsdoc/require-hyphen-before-param-description": ["error", "always"],
-    "jsdoc/require-jsdoc": "off", // Not everything needs to be documented
+    "jsdoc/require-jsdoc": "off",
     "jsdoc/require-param-description": "error",
     "jsdoc/require-param-name": "error",
     "jsdoc/require-param-type": "error",
@@ -378,8 +428,8 @@ module.exports = {
     "jsdoc/require-returns-type": "error",
     "jsdoc/require-returns": "error",
     "jsdoc/require-throws": "off",
-    "jsdoc/require-yields": "off",
-    "jsdoc/require-yields-check": "off",
+    "jsdoc/require-yields": "error",
+    "jsdoc/require-yields-check": "error",
     "jsdoc/tag-lines": "off",
     "jsdoc/valid-types": "off"
   },
@@ -390,6 +440,7 @@ module.exports = {
 
   "env": {
     "browser": true,
+    "es6": true,
     "node": true
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@playcanvas/eslint-config",
-  "version": "1.0.12",
+  "version": "1.0.16",
   "author": "PlayCanvas <support@playcanvas.com>",
   "homepage": "https://playcanvas.com",
   "description": "ESLint configuration used by PlayCanvas",
@@ -26,7 +26,7 @@
     "README.md"
   ],
   "dependencies": {
-    "eslint-plugin-jsdoc": "^37.0.3"
+    "eslint-plugin-jsdoc": "^37.5.1"
   },
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"