@playcanvas/eslint-config 2.0.8 → 2.1.0

package/README.md

@@ -1,25 +1,44 @@
 # 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.
+ESLint configuration developed by the PlayCanvas team and leveraged by many PlayCanvas-related projects, including the [PlayCanvas Engine](https://github.com/playcanvas/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 is defined in [`eslint.config.mjs`](https://github.com/playcanvas/eslint-config/blob/main/eslint.config.mjs). It configures ESLint's rules in a comprehensive manner, covering Possible Problems, Suggestions, and Formatting categories. It also includes additional plugins:
 
-The configuration attempts to enable as many rules as possible, particularly those categorized as 'recommended' by ESLint.
+- `eslint-plugin-jsdoc`: For JSDoc validation and enforcement
+- `eslint-plugin-import`: For import/export validation and ordering
+- `eslint-plugin-regexp`: For regular expression best practices
+
+The configuration attempts to enable as many rules as possible, particularly those categorized as 'recommended' by ESLint, while maintaining practicality for real-world development.
 
 ## Using this config in your own projects
 
-Edit your project's `package.json` file:
+1. Install the package:
+
+```bash
+npm install --save-dev @playcanvas/eslint-config eslint
+```
+
+2. Create an `eslint.config.js` file in your project root:
 
-1. Add `eslint` and `@playcanvas/eslint-config` to your `devDependencies` section.
-2. Add an `eslintConfig` section. At a minimum, you will need:
+```js
+import playcanvasConfig from '@playcanvas/eslint-config';
 
-```json
-    "eslintConfig": {
-        "extends": "@playcanvas/eslint-config"
-    },
+export default [
+    ...playcanvasConfig,
+    // Your custom configurations here
+];
 ```
 
-[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
+## Features
+
+- Full flat config format support for ESLint 8+
+- Comprehensive rule configuration
+- Support for ESM Script JSDoc tags used in PlayCanvas
+- Import ordering and validation
+- Strict JSDoc validation
+- Regular expression pattern enforcement
+
+## Requirements
+
+- ESLint 8 or later
+- Node.js 16 or later

package/eslint.config.mjs

@@ -13,7 +13,9 @@ const esmScriptTags = [
   'precision',
   'size',
   'step',
-  'title'
+  'title',
+  'visibleif',
+  'enabledif'
 ]
 
 export default [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@playcanvas/eslint-config",
-  "version": "2.0.8",
+  "version": "2.1.0",
   "author": "PlayCanvas <support@playcanvas.com>",
   "homepage": "https://playcanvas.com",
   "description": "ESLint configuration used by PlayCanvas",
@@ -26,8 +26,8 @@
   ],
   "dependencies": {
     "eslint-plugin-import": "^2.31.0",
-    "eslint-plugin-jsdoc": "^50.3.1",
-    "eslint-plugin-regexp": "^2.6.0"
+    "eslint-plugin-jsdoc": "^50.6.11",
+    "eslint-plugin-regexp": "^2.7.0"
   },
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"