eslint-plugin-th-rules 1.4.1 → 1.5.0

package/CHANGELOG.md

@@ -1,3 +1,22 @@
+# [1.5.0](https://github.com/tomerh2001/eslint-plugin-th-rules/compare/v1.4.2...v1.5.0) (2024-02-26)
+
+
+### Bug Fixes
+
+* Add ESLint configurations for JSDoc and React ([45b6297](https://github.com/tomerh2001/eslint-plugin-th-rules/commit/45b62978da758e4ebbf62780e74595393c38800b))
+
+
+### Features
+
+* adding basic, recommended and all, also planning to add a recommended-react and recommended-react-native variants in the future ([85e54dd](https://github.com/tomerh2001/eslint-plugin-th-rules/commit/85e54ddabe928aafadb83c4118ff5da390654260))
+
+## [1.4.2](https://github.com/tomerh2001/eslint-plugin-th-rules/compare/v1.4.1...v1.4.2) (2024-02-26)
+
+
+### Bug Fixes
+
+* fixed name of no-destructuring rule ([30ab24a](https://github.com/tomerh2001/eslint-plugin-th-rules/commit/30ab24aec8b84cda665c7fc43920f2625a2f8d83))
+
 ## [1.4.1](https://github.com/tomerh2001/eslint-plugin-th-rules/compare/v1.4.0...v1.4.1) (2024-02-26)
 
 
@@ -39,100 +58,100 @@
 
 * :sparkles: Created a recommended configuration ([4c81e02](https://github.com/tomerh2001/eslint-plugin-th-rules/commit/4c81e027ef00ab06a4c69ef32857093fcb06fb3b))
 
-## [1.1.4](https://github.com/tomerh2001/eslint-plugin-no-destruction/compare/v1.1.3...v1.1.4) (2024-02-23)
+## [1.1.4](https://github.com/tomerh2001/eslint-plugin-th-rules/compare/v1.1.3...v1.1.4) (2024-02-23)
 
 
 ### Bug Fixes
 
-* Update lib/index.js to import all rules in lib/rules ([d4f3183](https://github.com/tomerh2001/eslint-plugin-no-destruction/commit/d4f3183de27b530a7f62fc1670055915641d7533))
+* Update lib/index.js to import all rules in lib/rules ([d4f3183](https://github.com/tomerh2001/eslint-plugin-th-rules/commit/d4f3183de27b530a7f62fc1670055915641d7533))
 
-## [1.1.3](https://github.com/tomerh2001/eslint-plugin-no-destruction/compare/v1.1.2...v1.1.3) (2024-02-23)
+## [1.1.3](https://github.com/tomerh2001/eslint-plugin-th-rules/compare/v1.1.2...v1.1.3) (2024-02-23)
 
 
 ### Bug Fixes
 
-* Remove "type" field from package.json ([aadbbb0](https://github.com/tomerh2001/eslint-plugin-no-destruction/commit/aadbbb090a256e20e8437b5d9c7bf57cbfd0daf5))
+* Remove "type" field from package.json ([aadbbb0](https://github.com/tomerh2001/eslint-plugin-th-rules/commit/aadbbb090a256e20e8437b5d9c7bf57cbfd0daf5))
 
-## [1.1.2](https://github.com/tomerh2001/eslint-plugin-no-destruction/compare/v1.1.1...v1.1.2) (2024-02-23)
+## [1.1.2](https://github.com/tomerh2001/eslint-plugin-th-rules/compare/v1.1.1...v1.1.2) (2024-02-23)
 
 
 ### Bug Fixes
 
-* changed back to CommonJS ([07174fc](https://github.com/tomerh2001/eslint-plugin-no-destruction/commit/07174fce92e3a0b660fe76b4baa862fd0d33ee72))
+* changed back to CommonJS ([07174fc](https://github.com/tomerh2001/eslint-plugin-th-rules/commit/07174fce92e3a0b660fe76b4baa862fd0d33ee72))
 
-## [1.1.1](https://github.com/tomerh2001/eslint-plugin-no-destruction/compare/v1.1.0...v1.1.1) (2024-02-23)
+## [1.1.1](https://github.com/tomerh2001/eslint-plugin-th-rules/compare/v1.1.0...v1.1.1) (2024-02-23)
 
 
 ### Bug Fixes
 
-* changed index.js to ES ([d55351e](https://github.com/tomerh2001/eslint-plugin-no-destruction/commit/d55351ed380ceeb2c15d89f4b9db7e85c5250937))
+* changed index.js to ES ([d55351e](https://github.com/tomerh2001/eslint-plugin-th-rules/commit/d55351ed380ceeb2c15d89f4b9db7e85c5250937))
 
-# [1.1.0](https://github.com/tomerh2001/eslint-plugin-no-destruction/compare/v1.0.7...v1.1.0) (2024-02-23)
+# [1.1.0](https://github.com/tomerh2001/eslint-plugin-th-rules/compare/v1.0.7...v1.1.0) (2024-02-23)
 
 
 ### Bug Fixes
 
-*  Remove redundant Docker configuration ([2b1be8f](https://github.com/tomerh2001/eslint-plugin-no-destruction/commit/2b1be8f41a1036c8237f689d2addf29beedaedea))
-* Remove Dockerfile and update eslint rule ([63d6d03](https://github.com/tomerh2001/eslint-plugin-no-destruction/commit/63d6d033a3614be9a0e132e25ff5eb94b7448505))
+*  Remove redundant Docker configuration ([2b1be8f](https://github.com/tomerh2001/eslint-plugin-th-rules/commit/2b1be8f41a1036c8237f689d2addf29beedaedea))
+* Remove Dockerfile and update eslint rule ([63d6d03](https://github.com/tomerh2001/eslint-plugin-th-rules/commit/63d6d033a3614be9a0e132e25ff5eb94b7448505))
 
 
 ### Features
 
-* Added a rule to convert unnamed default exports to named default exports based on the file name ([cfda4c1](https://github.com/tomerh2001/eslint-plugin-no-destruction/commit/cfda4c16bbba11b281a45deca8ca8742ecab23e9))
+* Added a rule to convert unnamed default exports to named default exports based on the file name ([cfda4c1](https://github.com/tomerh2001/eslint-plugin-th-rules/commit/cfda4c16bbba11b281a45deca8ca8742ecab23e9))
 
-## [1.0.7](https://github.com/tomerh2001/eslint-plugin-no-destruction/compare/v1.0.6...v1.0.7) (2024-02-22)
+## [1.0.7](https://github.com/tomerh2001/eslint-plugin-th-rules/compare/v1.0.6...v1.0.7) (2024-02-22)
 
 
 ### Bug Fixes
 
-* test ([99d8a4f](https://github.com/tomerh2001/eslint-plugin-no-destruction/commit/99d8a4f325faaa425bc0ea0842567562441dcf2e))
+* test ([99d8a4f](https://github.com/tomerh2001/eslint-plugin-th-rules/commit/99d8a4f325faaa425bc0ea0842567562441dcf2e))
 
-## [1.0.6](https://github.com/tomerh2001/eslint-plugin-no-destruction/compare/v1.0.5...v1.0.6) (2024-02-22)
+## [1.0.6](https://github.com/tomerh2001/eslint-plugin-th-rules/compare/v1.0.5...v1.0.6) (2024-02-22)
 
 
 ### Bug Fixes
 
-* 7 ([f397bee](https://github.com/tomerh2001/eslint-plugin-no-destruction/commit/f397bee5676832b8b11e95dc52e0b8e83c5e5940))
+* 7 ([f397bee](https://github.com/tomerh2001/eslint-plugin-th-rules/commit/f397bee5676832b8b11e95dc52e0b8e83c5e5940))
 
-## [1.0.5](https://github.com/tomerh2001/eslint-plugin-no-destruction/compare/v1.0.4...v1.0.5) (2024-02-22)
+## [1.0.5](https://github.com/tomerh2001/eslint-plugin-th-rules/compare/v1.0.4...v1.0.5) (2024-02-22)
 
 
 ### Bug Fixes
 
-* 6 ([e4b80fd](https://github.com/tomerh2001/eslint-plugin-no-destruction/commit/e4b80fdea4d224b880c114e8ac5c433131f46e58))
+* 6 ([e4b80fd](https://github.com/tomerh2001/eslint-plugin-th-rules/commit/e4b80fdea4d224b880c114e8ac5c433131f46e58))
 
-## [1.0.4](https://github.com/tomerh2001/eslint-plugin-no-destruction/compare/v1.0.3...v1.0.4) (2024-02-22)
+## [1.0.4](https://github.com/tomerh2001/eslint-plugin-th-rules/compare/v1.0.3...v1.0.4) (2024-02-22)
 
 
 ### Bug Fixes
 
-* 3 ([de1546e](https://github.com/tomerh2001/eslint-plugin-no-destruction/commit/de1546eff2921718c6cfd6d6c4e8d6f82b178847))
-* 5 ([8d1b80d](https://github.com/tomerh2001/eslint-plugin-no-destruction/commit/8d1b80d22129d1a5baaa7330f76645ef6e9f2cc9))
+* 3 ([de1546e](https://github.com/tomerh2001/eslint-plugin-th-rules/commit/de1546eff2921718c6cfd6d6c4e8d6f82b178847))
+* 5 ([8d1b80d](https://github.com/tomerh2001/eslint-plugin-th-rules/commit/8d1b80d22129d1a5baaa7330f76645ef6e9f2cc9))
 
-## [1.0.3](https://github.com/tomerh2001/eslint-plugin-no-destruction/compare/v1.0.2...v1.0.3) (2024-02-22)
+## [1.0.3](https://github.com/tomerh2001/eslint-plugin-th-rules/compare/v1.0.2...v1.0.3) (2024-02-22)
 
 
 ### Bug Fixes
 
-* number 3 ([ac78e66](https://github.com/tomerh2001/eslint-plugin-no-destruction/commit/ac78e6685fcda4551a18f93afc0e05ecb232185c))
+* number 3 ([ac78e66](https://github.com/tomerh2001/eslint-plugin-th-rules/commit/ac78e6685fcda4551a18f93afc0e05ecb232185c))
 
-## [1.0.2](https://github.com/tomerh2001/eslint-plugin-no-destruction/compare/v1.0.1...v1.0.2) (2024-02-22)
+## [1.0.2](https://github.com/tomerh2001/eslint-plugin-th-rules/compare/v1.0.1...v1.0.2) (2024-02-22)
 
 
 ### Bug Fixes
 
-* Update package.json version to 1.0.6 ([1c5409c](https://github.com/tomerh2001/eslint-plugin-no-destruction/commit/1c5409ce77ccc5fc4e35a975ffa328f59766c1d7))
+* Update package.json version to 1.0.6 ([1c5409c](https://github.com/tomerh2001/eslint-plugin-th-rules/commit/1c5409ce77ccc5fc4e35a975ffa328f59766c1d7))
 
-## [1.0.1](https://github.com/tomerh2001/eslint-plugin-no-destruction/compare/v1.0.0...v1.0.1) (2024-02-22)
+## [1.0.1](https://github.com/tomerh2001/eslint-plugin-th-rules/compare/v1.0.0...v1.0.1) (2024-02-22)
 
 
 ### Bug Fixes
 
-* semantic ([1e08f3d](https://github.com/tomerh2001/eslint-plugin-no-destruction/commit/1e08f3ddb5f1432307ce7a1e50863c9325ddbbfc))
+* semantic ([1e08f3d](https://github.com/tomerh2001/eslint-plugin-th-rules/commit/1e08f3ddb5f1432307ce7a1e50863c9325ddbbfc))
 
 # 1.0.0 (2024-02-22)
 
 
 ### Bug Fixes
 
-* Add ESLint configuration and rules ([0197c62](https://github.com/tomerh2001/eslint-plugin-no-destruction/commit/0197c62d8d4be2f8fd5ae67ad4c3a83370d5d678))
+* Add ESLint configuration and rules ([0197c62](https://github.com/tomerh2001/eslint-plugin-th-rules/commit/0197c62d8d4be2f8fd5ae67ad4c3a83370d5d678))

package/README.md

@@ -17,7 +17,7 @@ To add all of the rules into your project, add the following configuration into
 
 ```json
 {
-  "extends": ["plugin:eslint-plugin-th-rules/all"]
+  "extends": ["plugin:th-rules/all"]
 }
 ```
 
@@ -25,7 +25,7 @@ To add all of the rules into your project, add the following configuration into
 
 ### 1. No-Destruction Rule
 
-**Rule ID:** `eslint-plugin-th-rules/no-destructuring`
+**Rule ID:** `th-rules/no-destructuring`
 
 #### Description
 
@@ -44,14 +44,14 @@ This rule checks for:
 ```json
 {
   "rules": {
-    "eslint-plugin-th-rules/no-destructuring": ["error", { "maximumDestructuredVariables": 2, "maximumLineLength": 100 }]
+    "th-rules/no-destructuring": ["error", { "maximumDestructuredVariables": 2, "maximumLineLength": 100 }]
   }
 }
 ```
 
 ### 2. Name-Export Rule
 
-**Rule ID:** `eslint-plugin-th-rules/no-default-export`
+**Rule ID:** `th-rules/no-default-export`
 
 #### Description
 
@@ -65,7 +65,7 @@ This rule targets unnamed default exports and automatically generates a named ex
 ```json
 {
   "rules": {
-    "eslint-plugin-th-rules/no-default-export": "error"
+    "no-default-export": "error"
   }
 }
 ```
@@ -74,11 +74,11 @@ This rule targets unnamed default exports and automatically generates a named ex
 ```json
 {
   "plugins": [
-    "eslint-plugin-th-rules"
+    "th-rules"
   ],
   "rules": {
-    "eslint-plugin-th-rules/no-destructuring": "error",
-    "eslint-plugin-th-rules/no-default-export": "error"
+    "no-destructuring": "error",
+    "no-default-export": "error"
   }
 }
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-th-rules",
-  "version": "1.4.1",
+  "version": "1.5.0",
   "description": "A List of custom ESLint rules created by Tomer Horowitz",
   "keywords": [
     "eslint",
@@ -8,8 +8,8 @@
     "eslint-plugin"
   ],
   "author": "Tomer Horowitz",
-  "main": "./lib/index.js",
-  "exports": "./lib/index.js",
+  "main": "./src/index.js",
+  "exports": "./src/index.js",
   "scripts": {
     "lint": "npm-run-all \"lint:*\"",
     "lint:eslint-docs": "npm-run-all \"update:eslint-docs -- --check\"",
@@ -18,6 +18,12 @@
     "update:eslint-docs": "eslint-doc-generator"
   },
   "dependencies": {
+    "eslint-config-jsdoc": "^15.4.0",
+    "eslint-config-xo": "^0.44.0",
+    "eslint-config-xo-react": "^0.27.0",
+    "eslint-plugin-jsdoc": "^48.2.0",
+    "eslint-plugin-react": "^7.33.2",
+    "eslint-plugin-react-hooks": "^4.6.0",
     "requireindex": "^1.2.0"
   },
   "devDependencies": {
@@ -28,6 +34,7 @@
     "@semantic-release/github": "^9.2.1",
     "@semantic-release/npm": "^11.0.0",
     "@semantic-release/release-notes-generator": "^12.0.0",
+    "@types/xo": "^0",
     "bun-types": "latest",
     "eslint": "^8.19.0",
     "eslint-doc-generator": "^1.0.0",

package/src/index.js

@@ -0,0 +1,94 @@
+/* eslint-disable n/no-path-concat */
+/* eslint-disable unicorn/prefer-module */
+
+/**
+ * @fileoverview A List of custom ESLint rules created by Tomer Horowitz
+ * @author Tomer Horowitz
+ */
+'use strict';
+const requireIndex = require('requireindex');
+
+/**
+ * Represents a basic configuration object.
+ *
+ * @type {Object}
+ * @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.
+ */
+const basic = {
+	plugins: ['th-rules'],
+	extends: [],
+	rules: {
+		'th-rules/no-destructuring': 'error',
+		'th-rules/no-default-export': 'error',
+	},
+	envs: {},
+};
+
+/**
+ * Represents the recommended ESLint configuration.
+ * @type {Object}
+ */
+const recommended = {
+	...basic,
+	envs: {
+		node: true,
+		ES2024: true,
+		jest: true,
+	},
+	rules: {
+		...basic.rules,
+		'unicorn/filename-case': 'off',
+		'unicorn/prefer-module': 'warn',
+		'import/extensions': 'off',
+		camelcase: 'warn',
+	},
+};
+
+/**
+ * Represents an object containing all the configurations.
+ * @type {Object}
+ */
+const all = {
+	...recommended,
+	plugins: [...recommended.plugins, 'jsdoc'],
+	extends: [...recommended.extends, 'plugin:jsdoc/recommended-error'],
+};
+
+/**
+ * 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} 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},
+	rules: {...all.rules, 'react/no-array-index-key': 'off'},
+	extends: [...all.extends, 'xo-react'],
+};
+
+/**
+ * Object representing all React Native configurations.
+ * @type {Object}
+ */
+const allReactNative = {
+	...allReact,
+	extends: [...allReact.extends, 'plugin:react-native/all'],
+};
+
+module.exports = {
+	rules: requireIndex(`${__dirname}/rules`),
+	configs: {
+		basic,
+		recommended,
+		all,
+		'all-react': allReact,
+		'all-react-native': allReactNative,
+	},
+};

package/{lib/rules/no-destruction.js → src/rules/no-destructuring.js}

@@ -1,7 +1,7 @@
 const MAX_TAB_COUNT = 3;
 
 /**
- * Represents the metadata for the "no-destruction" ESLint rule.
+ * Represents the metadata for the "no-destructuring" ESLint rule.
  *
  * @type {Object}
  * @property {string} type - The type of the rule.

package/{tests/lib/rules/no-unamed-default-export.js → src/tests/no-default-export.js}

@@ -1,5 +1,5 @@
 const {RuleTester} = require('eslint');
-const rule = require('../../../lib/rules/no-unamed-default-export.js');
+const rule = require('../../../lib/rules/no-default-export.js');
 
 const ruleTester = new RuleTester({
 	parserOptions: {

package/{tests/lib/rules/no-destruction.js → src/tests/no-destructuring.js}

@@ -1,5 +1,5 @@
 const {RuleTester} = require('eslint');
-const rule = require('../../../lib/rules/no-destruction.js');
+const rule = require('../../../lib/rules/no-destructuring.js');
 
 const ruleTester = new RuleTester({
 	parserOptions: {

package/lib/index.js

@@ -1,32 +0,0 @@
-/* eslint-disable n/no-path-concat */
-/* eslint-disable unicorn/prefer-module */
-
-/**
- * @fileoverview A List of custom ESLint rules created by Tomer Horowitz
- * @author Tomer Horowitz
- */
-'use strict';
-
-//------------------------------------------------------------------------------
-// Requirements
-//------------------------------------------------------------------------------
-
-const requireIndex = require('requireindex');
-
-//------------------------------------------------------------------------------
-// Plugin Definition
-//------------------------------------------------------------------------------
-
-// import all rules in lib/rules
-module.exports = {
-	rules: requireIndex(`${__dirname}/rules`),
-	configs: {
-		all: {
-			plugins: ['th-rules'],
-			rules: {
-				'th-rules/no-destructuring': 'error',
-				'th-rules/no-default-export': 'error',
-			},
-		},
-	},
-};