@playcanvas/eslint-config 1.0.14 → 1.0.15
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -0
- package/index.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -6,6 +6,19 @@ The configuration is defined in [`index.js`][index]. It configures ESLint's rule
|
|
|
6
6
|
|
|
7
7
|
The configuration attempts to enable as many rules as possible, particularly those categorized as 'recommended' by ESLint.
|
|
8
8
|
|
|
9
|
+
## Using this config in your own projects
|
|
10
|
+
|
|
11
|
+
Edit your project's `package.json` file:
|
|
12
|
+
|
|
13
|
+
1. Add `eslint` and `@playcanvas/eslint-config` to your `devDependencies` section.
|
|
14
|
+
2. Add an `eslintConfig` section. At a minimum, you will need:
|
|
15
|
+
|
|
16
|
+
```json
|
|
17
|
+
"eslintConfig": {
|
|
18
|
+
"extends": "@playcanvas/eslint-config"
|
|
19
|
+
},
|
|
20
|
+
```
|
|
21
|
+
|
|
9
22
|
[engine]: https://github.com/playcanvas/engine
|
|
10
23
|
[index]: https://github.com/playcanvas/playcanvas-eslint-config/blob/master/index.js
|
|
11
24
|
[rules]: https://eslint.org/docs/rules/
|
package/index.js
CHANGED
|
@@ -97,7 +97,7 @@ module.exports = {
|
|
|
97
97
|
"func-name-matching": "error",
|
|
98
98
|
"func-names": "off",
|
|
99
99
|
"func-style": "off",
|
|
100
|
-
"grouped-accessor-pairs": "error",
|
|
100
|
+
"grouped-accessor-pairs": ["error", "setBeforeGet"],
|
|
101
101
|
"guard-for-in": "off",
|
|
102
102
|
"id-denylist": "off",
|
|
103
103
|
"id-length": "off",
|