@playcanvas/eslint-config 2.1.0 → 3.0.0-beta.0

package/LICENSE

@@ -1,19 +1,19 @@
-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
-in the Software without restriction, including without limitation the rights
-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 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.
+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
+in the Software without restriction, including without limitation the rights
+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 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.

package/README.md

@@ -1,44 +1,50 @@
-# PlayCanvas ESLint Config
-
-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 [`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:
-
-- `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
-
-1. Install the package:
-
-```bash
-npm install --save-dev @playcanvas/eslint-config eslint
-```
-
-2. Create an `eslint.config.js` file in your project root:
-
-```js
-import playcanvasConfig from '@playcanvas/eslint-config';
-
-export default [
-    ...playcanvasConfig,
-    // Your custom configurations here
-];
-```
-
-## 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
+# PlayCanvas ESLint Config
+
+[![NPM Version](https://img.shields.io/npm/v/@playcanvas/eslint-config)](https://www.npmjs.com/package/@playcanvas/eslint-config)
+[![NPM Downloads](https://img.shields.io/npm/dw/@playcanvas/eslint-config)](https://npmtrends.com/@playcanvas/eslint-config)
+[![License](https://img.shields.io/npm/l/@playcanvas/eslint-config)](https://github.com/playcanvas/editor-api/blob/main/LICENSE)
+[![Discord](https://img.shields.io/badge/Discord-5865F2?style=flat&logo=discord&logoColor=white&color=black)](https://discord.gg/RSaMRzg)
+[![Reddit](https://img.shields.io/badge/Reddit-FF4500?style=flat&logo=reddit&logoColor=white&color=black)](https://www.reddit.com/r/PlayCanvas)
+[![X](https://img.shields.io/badge/X-000000?style=flat&logo=x&logoColor=white&color=black)](https://x.com/intent/follow?screen_name=playcanvas)
+
+| [User Manual](https://developer.playcanvas.com/user-manual/editor) | [API Reference](https://api.playcanvas.com/editor) | [Blog](https://blog.playcanvas.com) | [Forum](https://forum.playcanvas.com) |
+
+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.
+
+## Usage
+
+1. Install the package:
+
+```bash
+npm install -D @playcanvas/eslint-config eslint
+```
+
+2. Create an `eslint.config.js` file in your project root:
+
+```js
+import playcanvasConfig from '@playcanvas/eslint-config';
+
+export default [
+    ...playcanvasConfig.typescript,
+    // ...playcanvasConfig.react, // Uncomment if using react
+    // ...playcanvasConfig.legacy, // Uncomment if using legacy javascript rules
+    // Your custom configurations here
+];
+```
+
+## Features
+
+> [!WARNING]
+> The typescript and react rules are incomplete and are still being developed based on current practises and existing legacy rules
+
+- Full flat config format support for ESLint 9+
+- 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 9 or later
+- Node.js 18 or later