eslint-plugin-th-rules 1.5.0 → 1.5.2

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [1.5.2](https://github.com/tomerh2001/eslint-plugin-th-rules/compare/v1.5.1...v1.5.2) (2024-02-26)
+
+
+### Bug Fixes
+
+* Update environment configuration in index.js ([277871c](https://github.com/tomerh2001/eslint-plugin-th-rules/commit/277871cc4ff71659fa1e476fd463c39893878797))
+
+## [1.5.1](https://github.com/tomerh2001/eslint-plugin-th-rules/compare/v1.5.0...v1.5.1) (2024-02-26)
+
+
+### Bug Fixes
+
+* fixed ([9730e96](https://github.com/tomerh2001/eslint-plugin-th-rules/commit/9730e96ff296ccd4afbc278fefd176f2684b89cb))
+
 # [1.5.0](https://github.com/tomerh2001/eslint-plugin-th-rules/compare/v1.4.2...v1.5.0) (2024-02-26)
 
 

package/README.md

@@ -13,6 +13,7 @@ This repository contains custom ESLint rules to enhance code quality and consist
 
 ## Configurations
 
+### All
 To add all of the rules into your project, add the following configuration into your ESLint configuration file:
 
 ```json
@@ -21,6 +22,34 @@ To add all of the rules into your project, add the following configuration into
 }
 ```
 
+### All React
+```json
+{
+  "extends": ["plugin:th-rules/all-react"]
+}
+```
+
+### All React Native
+```json
+{
+  "extends": ["plugin:th-rules/all-react-native"]
+}
+```
+
+### Recommended
+```json
+{
+  "extends": ["plugin:th-rules/recommended"]
+}
+```
+
+### Basic
+```json
+{
+  "extends": ["plugin:th-rules/basic"]
+}
+```
+
 ## Rules
 
 ### 1. No-Destruction Rule

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-th-rules",
-  "version": "1.5.0",
+  "version": "1.5.2",
   "description": "A List of custom ESLint rules created by Tomer Horowitz",
   "keywords": [
     "eslint",
@@ -24,6 +24,7 @@
     "eslint-plugin-jsdoc": "^48.2.0",
     "eslint-plugin-react": "^7.33.2",
     "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-react-native": "^4.1.0",
     "requireindex": "^1.2.0"
   },
   "devDependencies": {
@@ -40,6 +41,7 @@
     "eslint-doc-generator": "^1.0.0",
     "eslint-plugin-eslint-plugin": "^5.0.0",
     "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-unicorn": "^51.0.1",
     "mocha": "^10.0.0",
     "npm-run-all": "^4.1.5",
     "xo": "^0.57.0"

package/src/index.js

@@ -15,7 +15,7 @@ const requireIndex = require('requireindex');
  * @property {string[]} plugins - The list of plugins.
  * @property {string[]} extends - The list of extended configurations.
  * @property {Object} rules - The rules configuration.
- * @property {Object} envs - The environment configuration.
+ * @property {Object} env - The environment configuration.
  */
 const basic = {
 	plugins: ['th-rules'],
@@ -24,7 +24,7 @@ const basic = {
 		'th-rules/no-destructuring': 'error',
 		'th-rules/no-default-export': 'error',
 	},
-	envs: {},
+	env: {},
 };
 
 /**
@@ -33,7 +33,7 @@ const basic = {
  */
 const recommended = {
 	...basic,
-	envs: {
+	env: {
 		node: true,
 		ES2024: true,
 		jest: true,
@@ -60,15 +60,15 @@ const all = {
 /**
  * Represents an object containing all React-related configurations.
  * @typedef {Object} allReact
- * @property {Object} envs - The environment configurations.
- * @property {boolean} envs.browser - Indicates if the browser environment is enabled.
+ * @property {Object} env - The environment configurations.
+ * @property {boolean} env.browser - Indicates if the browser environment is enabled.
  * @property {Object} rules - The rule configurations.
  * @property {string} rules['react/no-array-index-key'] - The configuration for the 'react/no-array-index-key' rule.
  * @property {string[]} extends - The list of extended configurations.
  */
 const allReact = {
 	...all,
-	envs: {...all.envs, node: false, browser: true},
+	env: {...all.env, node: false, browser: true},
 	rules: {...all.rules, 'react/no-array-index-key': 'off'},
 	extends: [...all.extends, 'xo-react'],
 };