eslint-plugin-th-rules 1.4.2 → 1.5.1

package/CHANGELOG.md

@@ -1,3 +1,22 @@
+## [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)
+
+
+### 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)
 
 

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.4.2",
+  "version": "1.5.1",
   "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,13 @@
     "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",
+    "eslint-plugin-react-native": "^4.1.0",
     "requireindex": "^1.2.0"
   },
   "devDependencies": {
@@ -28,11 +35,13 @@
     "@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",
     "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

@@ -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/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',
-			},
-		},
-	},
-};