eslint-plugin-th-rules 1.4.0

package/.yarnrc.yml

@@ -0,0 +1,3 @@
+nodeLinker: node-modules
+
+yarnPath: .yarn/releases/yarn-4.1.0.cjs

package/CHANGELOG.md

@@ -0,0 +1,131 @@
+# [1.4.0](https://github.com/tomerh2001/eslint-plugin-th-rules/compare/v1.3.2...v1.4.0) (2024-02-23)
+
+
+### Features
+
+* Update package name and plugin references ([2fd90bd](https://github.com/tomerh2001/eslint-plugin-th-rules/commit/2fd90bd5873e541ea0e4ce05c7872732636753ec))
+
+## [1.3.1](https://github.com/tomerh2001/eslint-plugin-th-rules/compare/v1.3.0...v1.3.1) (2024-02-23)
+
+
+### Bug Fixes
+
+* fixed package name ([4e006ab](https://github.com/tomerh2001/eslint-plugin-th-rules/commit/4e006ab95cb8daa4310c43adbdd24c3be82b34b4))
+
+# [1.3.0](https://github.com/tomerh2001/eslint-plugin-th-rules/compare/v1.2.0...v1.3.0) (2024-02-23)
+
+
+### Bug Fixes
+
+* renamed recommended configuration to all ([f11d297](https://github.com/tomerh2001/eslint-plugin-th-rules/commit/f11d297861da5b9234ddebf18c1ea4f52099b7b6))
+* Update plugin and rule names in configs ([476b081](https://github.com/tomerh2001/eslint-plugin-th-rules/commit/476b0813aaecfe717291ac44fdd9c661a4356693))
+
+
+### Features
+
+* updated readme ([3903d35](https://github.com/tomerh2001/eslint-plugin-th-rules/commit/3903d354c2d4ba367258aa0cd80501db080cf595))
+
+# [1.2.0](https://github.com/tomerh2001/eslint-plugin-th-rules/compare/v1.1.4...v1.2.0) (2024-02-23)
+
+
+### Features
+
+* :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)
+
+
+### Bug Fixes
+
+* Update lib/index.js to import all rules in lib/rules ([d4f3183](https://github.com/tomerh2001/eslint-plugin-no-destruction/commit/d4f3183de27b530a7f62fc1670055915641d7533))
+
+## [1.1.3](https://github.com/tomerh2001/eslint-plugin-no-destruction/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))
+
+## [1.1.2](https://github.com/tomerh2001/eslint-plugin-no-destruction/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))
+
+## [1.1.1](https://github.com/tomerh2001/eslint-plugin-no-destruction/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))
+
+# [1.1.0](https://github.com/tomerh2001/eslint-plugin-no-destruction/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))
+
+
+### 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))
+
+## [1.0.7](https://github.com/tomerh2001/eslint-plugin-no-destruction/compare/v1.0.6...v1.0.7) (2024-02-22)
+
+
+### Bug Fixes
+
+* test ([99d8a4f](https://github.com/tomerh2001/eslint-plugin-no-destruction/commit/99d8a4f325faaa425bc0ea0842567562441dcf2e))
+
+## [1.0.6](https://github.com/tomerh2001/eslint-plugin-no-destruction/compare/v1.0.5...v1.0.6) (2024-02-22)
+
+
+### Bug Fixes
+
+* 7 ([f397bee](https://github.com/tomerh2001/eslint-plugin-no-destruction/commit/f397bee5676832b8b11e95dc52e0b8e83c5e5940))
+
+## [1.0.5](https://github.com/tomerh2001/eslint-plugin-no-destruction/compare/v1.0.4...v1.0.5) (2024-02-22)
+
+
+### Bug Fixes
+
+* 6 ([e4b80fd](https://github.com/tomerh2001/eslint-plugin-no-destruction/commit/e4b80fdea4d224b880c114e8ac5c433131f46e58))
+
+## [1.0.4](https://github.com/tomerh2001/eslint-plugin-no-destruction/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))
+
+## [1.0.3](https://github.com/tomerh2001/eslint-plugin-no-destruction/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))
+
+## [1.0.2](https://github.com/tomerh2001/eslint-plugin-no-destruction/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))
+
+## [1.0.1](https://github.com/tomerh2001/eslint-plugin-no-destruction/compare/v1.0.0...v1.0.1) (2024-02-22)
+
+
+### Bug Fixes
+
+* semantic ([1e08f3d](https://github.com/tomerh2001/eslint-plugin-no-destruction/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))

package/README.md

@@ -0,0 +1,84 @@
+# eslint-plugin-th-rules
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
+[![XO code style](https://shields.io/badge/code_style-5ed9c7?logo=xo&labelColor=gray)](https://github.com/xojs/xo)
+[![Snyk Security](../../actions/workflows/snyk-security.yml/badge.svg)](../../actions/workflows/snyk-security.yml)
+[![CodeQL](../../actions/workflows/codeql.yml/badge.svg)](../../actions/workflows/codeql.yml)
+[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/tomerh2001/eslint-plugin-th-rules/badge)](https://securityscorecards.dev/viewer/?uri=github.com/tomerh2001/eslint-plugin-th-rules)
+
+This repository contains custom ESLint rules to enhance code quality and consistency across projects.
+
+# Custom ESLint Rules
+
+This repository contains custom ESLint rules to enhance code quality and consistency across projects, created by Tomer Horowitz.
+
+## Configurations
+
+To add all of the rules into your project, add the following configuration into your ESLint configuration file:
+
+```json
+{
+  "extends": ["plugin:eslint-plugin-th-rules/all"]
+}
+```
+
+## Rules
+
+### 1. No-Destruction Rule
+
+**Rule ID:** `eslint-plugin-th-rules/no-destructuring`
+
+#### Description
+
+This rule disallows destructuring that does not meet certain conditions, aiming to prevent overly complex destructuring patterns and ensure code readability.
+
+#### Rule Details
+
+This rule checks for:
+
+- Destructuring at a nesting level above 3.
+- Destructuring of more than the specified maximum number of variables (default is 2).
+- Destructuring on a line exceeding the specified maximum line length (default is 100 characters).
+
+#### Configuration
+
+```json
+{
+  "rules": {
+    "eslint-plugin-th-rules/no-destructuring": ["error", { "maximumDestructuredVariables": 2, "maximumLineLength": 100 }]
+  }
+}
+```
+
+### 2. Name-Export Rule
+
+**Rule ID:** `eslint-plugin-th-rules/no-unamed-default-export`
+
+#### Description
+
+Converts unnamed default exports to named default exports based on the file name. This rule helps maintain consistency in export names and facilitates easier identification of components or modules.
+
+#### Rule Details
+
+This rule targets unnamed default exports and automatically generates a named export based on the file name.
+
+#### Configuration
+```json
+{
+  "rules": {
+    "eslint-plugin-th-rules/no-unamed-default-export": "error"
+  }
+}
+```
+
+## Installation
+```json
+{
+  "plugins": [
+    "eslint-plugin-th-rules"
+  ],
+  "rules": {
+    "eslint-plugin-th-rules/no-destructuring": "error",
+    "eslint-plugin-th-rules/no-unamed-default-export": "error"
+  }
+}
+```

package/SECURITY.md

@@ -0,0 +1,48 @@
+# Security Policy
+
+## 1. Purpose
+
+This document provides guidelines and procedures for maintaining the security and integrity of the repository.
+
+## 2. Scope
+
+This policy applies to all contributors, maintainers, and users of the repository.
+
+## 3. Repository Security
+
+### 3.1. Access Control
+
+- Access to the repository is restricted to authorized personnel only. All contributors must have a valid and active GitHub account.
+- External collaborators should be granted access on a need-to-know basis and should be reviewed periodically.
+
+### 3.2. Encryption
+
+- All sensitive data stored in this repo must be encrypted using `git-crypt`.
+- Authorized users will be provided with decryption keys. These keys must not be shared, stored publicly, or embedded in code.
+
+### 3.3. Code Review
+
+- All pull requests (PRs) must undergo a code review by at least one other member before being merged.
+- PRs with changes to cryptographic routines or handling of encrypted data must be reviewed by a security expert.
+
+## 4. Reporting Security Issues
+
+- If you discover a vulnerability or security issue, please create an issue on the GitHub repository. Label it as `security` for easy identification.
+- Do not disclose details of the vulnerability in public forums, chats, or other public channels.
+
+## 5. Patch Management
+
+- All contributors are encouraged to regularly fetch updates from the main branch and ensure their local copy is updated to benefit from security patches.
+
+## 6. Compliance
+
+- Contributors found to be in violation of this policy may have their access revoked.
+- Users and maintainers are encouraged to report any non-compliance to this policy.
+
+## 7. Review and Updates
+
+This policy will be reviewed annually or after any significant incident.
+
+## 8. Contact
+
+For any queries or concerns regarding this security policy, eat a biscuit. (tomerh2001@gmail.com)

package/lib/index.js

@@ -0,0 +1,27 @@
+/**
+ * @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');
+module.exports.configs = {
+	all: {
+		plugins: ['eslint-plugin-th-rules'],
+		rules: {
+			'eslint-plugin-th-rules/no-destructuring': 'error',
+			'eslint-plugin-th-rules/no-unamed-default-export': 'error',
+		},
+	},
+};

package/lib/rules/no-destruction.js

@@ -0,0 +1,94 @@
+const MAX_TAB_COUNT = 3;
+
+/**
+ * Represents the metadata for the "no-destruction" ESLint rule.
+ *
+ * @type {Object}
+ * @property {string} type - The type of the rule.
+ * @property {Object} docs - The documentation for the rule.
+ * @property {string} docs.description - The description of the rule.
+ * @property {string} docs.category - The category of the rule.
+ * @property {boolean} docs.recommended - Indicates if the rule is recommended.
+ * @property {Object[]} schema - The schema for the rule options.
+ * @property {Object} schema[].properties - The properties of the rule options.
+ * @property {number} schema[].properties.maximumDestructuredVariables - The maximum number of destructured variables allowed.
+ * @property {number} schema[].properties.maximumLineLength - The maximum line length allowed.
+ */
+const meta = {
+	type: 'problem',
+	docs: {
+		description: 'Disallow destructuring that does not meet certain conditions',
+		category: 'Possible Errors',
+		recommended: true,
+	},
+	schema: [
+		{
+			type: 'object',
+			properties: {
+				maximumDestructuredVariables: {
+					type: 'integer',
+					minimum: 0,
+				},
+				maximumLineLength: {
+					type: 'integer',
+					minimum: 0,
+				},
+			},
+			additionalProperties: false,
+		},
+	],
+};
+
+/**
+ * Creates an ESLint rule that checks for excessive destructuring in variable declarations.
+ * @param {Object} context - The ESLint rule context.
+ * @returns {Object} - The ESLint rule object.
+ */
+function create(context) {
+	const MAX_VARIABLES = context?.options[0]?.maximumDestructuredVariables || 2;
+	const MAX_LINE_LENGTH = context?.options[0]?.maximumLineLength || 100;
+
+	return {
+		VariableDeclarator(node) {
+			const sourceCode = context.getSourceCode();
+			const line = sourceCode.lines[node.loc.start.line - 1];
+			const lineLength = line.length;
+			const tabCount = line.search(/\S|$/);
+
+			if (node?.id?.type !== 'ObjectPattern') {
+				return;
+			}
+
+			// Check for the number of destructured variables and the nesting level
+			if (tabCount > MAX_TAB_COUNT) {
+				context.report({
+					node,
+					message: `Destruction at a nesting level above ${MAX_TAB_COUNT} is not allowed, instead saw ${tabCount} levels of nesting`,
+				});
+			}
+
+			// Check for the number of destructured variables
+			if (node?.id?.properties?.length > MAX_VARIABLES) {
+				context.report({
+					node,
+					message: `Destruction of more than ${MAX_VARIABLES} variables is not allowed`,
+				});
+			}
+
+			// Check for the line length
+			if (lineLength > MAX_LINE_LENGTH) {
+				context.report({
+					node,
+					message: `Destruction on a line exceeding ${MAX_LINE_LENGTH} characters is not allowed`,
+				});
+			}
+		},
+	};
+}
+
+const rule = {
+	meta,
+	create,
+};
+
+module.exports = rule;

package/lib/rules/no-unamed-default-export.js

@@ -0,0 +1,65 @@
+const path = require('node:path');
+
+const meta = {
+	type: 'suggestion',
+	docs: {
+		description: 'Convert unnamed default exports to named default exports based on the file name.',
+	},
+	fixable: 'code',
+	schema: [],
+};
+
+function create(context) {
+	function generateExportNameFromFileName(fileName) {
+		return fileName.replaceAll(/^\w|[A-Z]|\b\w|\s+/g, (match, index) => {
+			if (match === ' ') {
+				return '';
+			} // Remove spaces
+
+			if (index === 0) {
+				return match.toLowerCase();
+			} // Lowercase the first character
+
+			return match.toUpperCase();
+		})
+			.replaceAll(/[-_]/g, '')
+			.replaceAll('<', '')
+			.replaceAll('>', '');
+	}
+
+	return {
+		ExportDefaultDeclaration(node) {
+			// If the export declaration is an identifier (e.g., a variable name), it's considered named.
+			if (node.declaration.type === 'Identifier') {
+				return;
+			}
+
+			// Existing check for function or class declarations that are named
+			if (node.declaration.id) {
+				return;
+			}
+
+			const fileName = context.getFilename();
+			const exportName = generateExportNameFromFileName(path.basename(fileName, path.extname(fileName)));
+
+			context.report({
+				node,
+				message: 'Unnamed default export should be named based on the file name.',
+				fix(fixer) {
+					const sourceCode = context.getSourceCode();
+					const declarationText = sourceCode.getText(node.declaration);
+					const fixedCode = `const ${exportName} = ${declarationText};\nexport default ${exportName};`;
+
+					return fixer.replaceText(node, fixedCode);
+				},
+			});
+		},
+	};
+}
+
+const rule = {
+	meta,
+	create,
+};
+
+module.exports = rule;

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "eslint-plugin-th-rules",
+  "version": "1.4.0",
+  "description": "A List of custom ESLint rules created by Tomer Horowitz",
+  "keywords": [
+    "eslint",
+    "eslintplugin",
+    "eslint-plugin"
+  ],
+  "author": "Tomer Horowitz",
+  "main": "./lib/index.js",
+  "exports": "./lib/index.js",
+  "scripts": {
+    "lint": "npm-run-all \"lint:*\"",
+    "lint:eslint-docs": "npm-run-all \"update:eslint-docs -- --check\"",
+    "lint:js": "eslint .",
+    "test": "xo && mocha tests --recursive",
+    "update:eslint-docs": "eslint-doc-generator"
+  },
+  "dependencies": {
+    "requireindex": "^1.2.0"
+  },
+  "devDependencies": {
+    "@codedependant/semantic-release-docker": "^4.4.0",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/commit-analyzer": "^11.0.0",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/github": "^9.2.1",
+    "@semantic-release/npm": "^11.0.0",
+    "@semantic-release/release-notes-generator": "^12.0.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",
+    "mocha": "^10.0.0",
+    "npm-run-all": "^4.1.5",
+    "xo": "^0.57.0"
+  },
+  "engines": {
+    "node": ">= 20.11.0"
+  },
+  "peerDependencies": {
+    "eslint": ">=7",
+    "typescript": "^5.0.0"
+  },
+  "license": "ISC",
+  "packageManager": "yarn@4.1.0"
+}

package/renovate.json

@@ -0,0 +1,3 @@
+{
+    "automerge": true
+}

package/tests/lib/rules/no-destruction.js

@@ -0,0 +1,51 @@
+const {RuleTester} = require('eslint');
+const rule = require('../../../lib/rules/no-destruction.js');
+
+const ruleTester = new RuleTester({
+	parserOptions: {
+		ecmaVersion: 2020, // ES6 syntax
+		sourceType: 'module', // Allows the use of imports
+	},
+});
+
+ruleTester.run('no-destruction', rule, {
+	valid: [
+		{
+			code: 'const { a, b } = obj;',
+			options: [{maximumDestructuredVariables: 3, maximumLineLength: 80}],
+		},
+		{
+			code: 'const { a } = obj;',
+			options: [{maximumDestructuredVariables: 2, maximumLineLength: 80}],
+		},
+		{
+			code: 'const { a, b, c } = obj;',
+			options: [{maximumDestructuredVariables: 3, maximumLineLength: 30}],
+		},
+		{
+			code: 'function foo() {\n\tconst { a, b } = obj;\n}',
+			options: [{maximumDestructuredVariables: 3, maximumLineLength: 80}],
+		},
+		{
+			code: '\tconst { a, b } = obj;',
+			options: [{maximumDestructuredVariables: 3, maximumLineLength: 80}],
+		},
+	],
+	invalid: [
+		{
+			code: 'const { a, b, c } = obj;',
+			options: [{maximumDestructuredVariables: 2, maximumLineLength: 80}],
+			errors: [{message: 'Destruction of more than 2 variables is not allowed'}],
+		},
+		{
+			code: 'const { a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t, u, v, w, x, y, z } = obj;',
+			options: [{maximumDestructuredVariables: 3, maximumLineLength: 80}],
+			errors: [{message: 'Destruction of more than 3 variables is not allowed'}, {message: 'Destruction on a line exceeding 80 characters is not allowed'}],
+		},
+		{
+			code: 'function foo() {\n\t\t\t\t\t\t\tconst { a, b } = obj;\n}',
+			options: [{maximumDestructuredVariables: 3, maximumLineLength: 80}],
+			errors: [{message: 'Destruction at a nesting level above 3 is not allowed, instead saw 7 levels of nesting'}],
+		},
+	],
+});

package/tests/lib/rules/no-unamed-default-export.js

@@ -0,0 +1,56 @@
+const {RuleTester} = require('eslint');
+const rule = require('../../../lib/rules/no-unamed-default-export.js');
+
+const ruleTester = new RuleTester({
+	parserOptions: {
+		ecmaVersion: 2020,
+		sourceType: 'module',
+	},
+});
+
+ruleTester.run('no-unamed-default-export', rule, {
+	valid: [
+		// Already named exports should pass
+		'const a = 1; export default a;',
+		'export default function foo() {}',
+		'export default class Foo {}',
+	],
+	invalid: [
+		// Function exports without a name
+		{
+			code: 'export default function () {}',
+			output: 'const Input = function () {};\nexport default Input;',
+			errors: [{message: 'Unnamed default export should be named based on the file name.'}],
+		},
+		// Class exports without a name
+		{
+			code: 'export default class {}',
+			output: 'const Input = class {};\nexport default Input;',
+			errors: [{message: 'Unnamed default export should be named based on the file name.'}],
+		},
+		// Object literal exports
+		{
+			code: 'export default {}',
+			output: 'const Input = {};\nexport default Input;',
+			errors: [{message: 'Unnamed default export should be named based on the file name.'}],
+		},
+		// Primitive value exports
+		{
+			code: 'export default 42',
+			output: 'const Input = 42;\nexport default Input;',
+			errors: [{message: 'Unnamed default export should be named based on the file name.'}],
+		},
+		// Null exports
+		{
+			code: 'export default null',
+			output: 'const Input = null;\nexport default Input;',
+			errors: [{message: 'Unnamed default export should be named based on the file name.'}],
+		},
+		// Arrow function exports
+		{
+			code: 'export default () => {}',
+			output: 'const Input = () => {};\nexport default Input;',
+			errors: [{message: 'Unnamed default export should be named based on the file name.'}],
+		},
+	],
+});

package/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "lib": ["ESNext"],
+    "module": "esnext",
+    "target": "esnext",
+    "moduleResolution": "bundler",
+    "moduleDetection": "force",
+    "allowImportingTsExtensions": true,
+    "noEmit": true,
+    "composite": true,
+    "strict": true,
+    "downlevelIteration": true,
+    "skipLibCheck": true,
+    "jsx": "react-jsx",
+    "allowSyntheticDefaultImports": true,
+    "forceConsistentCasingInFileNames": true,
+    "allowJs": true,
+    "types": [
+      "bun-types" // add Bun global
+    ]
+  }
+}