eslint-plugin-th-rules 1.14.1 → 1.15.0

package/.yarnrc.yml

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

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [1.15.0](https://github.com/tomerh2001/eslint-plugin-th-rules/compare/v1.14.1...v1.15.0) (2024-12-30)
+
+
+### Features
+
+* add top-level functions rule and update ESLint configuration ([49e5ebb](https://github.com/tomerh2001/eslint-plugin-th-rules/commit/49e5ebbf597615e508a8b0067d8ca263d73f0469))
+
 ## [1.14.1](https://github.com/tomerh2001/eslint-plugin-th-rules/compare/v1.14.0...v1.14.1) (2024-12-30)
 
 

package/README.md

@@ -18,11 +18,12 @@ This repository contains custom ESLint rules to enhance code quality and consist
 ✅ Set in the `recommended` configuration.\
 🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).
 
-| Name                                                 | Description                                                                      | 💼                                                               | 🔧 |
-| :--------------------------------------------------- | :------------------------------------------------------------------------------- | :--------------------------------------------------------------- | :- |
-| [no-comments](docs/rules/no-comments.md)             | Disallow comments except for specified allowed patterns.                         | ✅ ![badge-recommended-react][] ![badge-recommended-typescript][] | 🔧 |
-| [no-default-export](docs/rules/no-default-export.md) | Convert unnamed default exports to named default exports based on the file name. | ✅ ![badge-recommended-react][] ![badge-recommended-typescript][] | 🔧 |
-| [no-destructuring](docs/rules/no-destructuring.md)   | Disallow destructuring that does not meet certain conditions                     | ✅ ![badge-recommended-react][] ![badge-recommended-typescript][] |    |
+| Name                                                     | Description                                                                      | 💼                                                               | 🔧 |
+| :------------------------------------------------------- | :------------------------------------------------------------------------------- | :--------------------------------------------------------------- | :- |
+| [no-comments](docs/rules/no-comments.md)                 | Disallow comments except for specified allowed patterns.                         | ✅ ![badge-recommended-react][] ![badge-recommended-typescript][] | 🔧 |
+| [no-default-export](docs/rules/no-default-export.md)     | Convert unnamed default exports to named default exports based on the file name. | ✅ ![badge-recommended-react][] ![badge-recommended-typescript][] | 🔧 |
+| [no-destructuring](docs/rules/no-destructuring.md)       | Disallow destructuring that does not meet certain conditions                     | ✅ ![badge-recommended-react][] ![badge-recommended-typescript][] |    |
+| [top-level-functions](docs/rules/top-level-functions.md) | Require all top-level functions to be named/regular functions.                   |                                                                  | 🔧 |
 
 <!-- end auto-generated rules list -->
 

package/docs/rules/top-level-functions.md

@@ -0,0 +1,47 @@
+# Require all top-level functions to be named/regular functions (`th-rules/top-level-functions`)
+
+🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
+
+<!-- end auto-generated rule header -->
+
+## Description
+
+This rule requires all top-level functions to be named/regular functions, preventing the use of arrow functions at the top level. This rule aims to improve code readability and maintainability by enforcing consistent function declaration styles.
+
+## Rule Details
+
+This rule checks for arrow functions at the top level and reports them as errors.
+
+Examples of **incorrect** code for this rule:
+
+```js
+const myFunction = () => {
+  // Function body
+};
+```
+
+Examples of **correct** code for this rule:
+
+```js
+function myFunction() {
+  // Function body
+}
+```
+
+## Usage
+
+```json
+{
+  "rules": {
+    "th-rules/top-level-functions": "error"
+  }
+}
+```
+
+## Options
+
+This rule has no options.
+
+## When Not To Use It
+
+If you do not want to enforce consistent function declaration styles, you can disable this rule.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-th-rules",
-  "version": "1.14.1",
+  "version": "1.15.0",
   "description": "A List of custom ESLint rules created by Tomer Horowitz",
   "keywords": [
     "eslint",
@@ -49,6 +49,7 @@
     "eslint-plugin-eslint-plugin": "^6.4.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-sonarjs": "^3.0.1",
+    "eslint-plugin-th-rules": "1.14.1",
     "eslint-plugin-unicorn": "^56.0.1",
     "mocha": "^11.0.1",
     "npm-run-all": "^4.1.5",
@@ -61,5 +62,5 @@
     "typescript": "^5.7.2"
   },
   "license": "ISC",
-  "packageManager": "yarn@4.4.0"
+  "packageManager": "yarn@4.6.0"
 }

package/src/rules/no-comments.js

@@ -5,7 +5,7 @@ const allowedPatterns = [
 	/warning/i, // Allow WARNING (case-insensitive)
 	/error/i, // Allow ERROR (case-insensitive)
 	/info/i, // Allow INFO (case-insensitive)
-	/^\s*eslint-(disable|enable|env|globals|ignore|directive)/, // Allow ESLint directives
+	/^\s*eslint-(disable|enable|env|globals|ignore|directive)/,
 ];
 
 const meta = {
@@ -47,26 +47,23 @@ function create(context) {
 	function isCommentAllowed(comment) {
 		const text = comment.value.trim();
 
-		// Check if the comment is a valid JSDoc comment
 		if (comment.type === 'Block' && comment.value.startsWith('*')) {
-			return true; // Allow any JSDoc-style block comment (/** ... */)
+			return true;
 		}
 
-		// Check if the comment matches any allowed pattern
 		for (const pattern of [...allowedPatterns, ...userAllowedPatterns]) {
 			if (pattern.test(text)) {
 				return true;
 			}
 		}
 
-		// Check if the comment matches any disallowed pattern
 		for (const pattern of userDisallowedPatterns) {
 			if (pattern.test(text)) {
 				return false;
 			}
 		}
 
-		return false; // Disallow by default if no match
+		return false;
 	}
 
 	return {

package/src/rules/no-default-export.js

@@ -17,11 +17,11 @@ function create(context) {
 		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();
 		})
@@ -30,12 +30,10 @@ function create(context) {
 
 	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;
 			}

package/src/rules/no-destructuring.js

@@ -60,7 +60,6 @@ function create(context) {
 				return;
 			}
 
-			// Check for the number of destructured variables and the nesting level
 			if (tabCount > MAX_TAB_COUNT) {
 				context.report({
 					node,
@@ -68,7 +67,6 @@ function create(context) {
 				});
 			}
 
-			// Check for the number of destructured variables
 			if (node?.id?.properties?.length > MAX_VARIABLES) {
 				context.report({
 					node,
@@ -76,7 +74,6 @@ function create(context) {
 				});
 			}
 
-			// Check for the line length
 			if (lineLength > MAX_LINE_LENGTH) {
 				context.report({
 					node,

package/src/rules/top-level-functions.js

@@ -0,0 +1,88 @@
+/**
+ * @type {Object}
+ * @property {string} type - The type of the rule, in this case 'suggestion'.
+ * @property {Object} docs - Documentation related to the rule.
+ * @property {string} docs.description - A brief description of the rule.
+ * @property {string} docs.category - The category of the rule, here 'Stylistic Issues'.
+ * @property {boolean} docs.recommended - Indicates whether the rule is recommended.
+ * @property {string} docs.url - The URL to the documentation of the rule.
+ * @property {string} fixable - Indicates if the rule is fixable, in this case 'code'.
+ * @property {Array} schema - The schema for the rule options.
+ */
+const meta = {
+	type: 'suggestion',
+	docs: {
+		description: 'Require all top-level functions to be named/regular functions.',
+		category: 'Stylistic Issues',
+		recommended: false,
+		url: 'https://github.com/tomerh2001/eslint-plugin-th-rules/blob/main/docs/rules/top-level-functions.md',
+	},
+	fixable: 'code',
+	schema: [],
+};
+
+/**
+ * ESLint rule to enforce naming of top-level functions.
+ *
+ * @param {Object} context - The ESLint rule context.
+ * @returns {Object} An object containing the rule's visitor methods.
+ */
+function create(context) {
+	return {
+
+		VariableDeclaration(node) {
+			if (node.parent.type !== 'Program') {
+				return;
+			}
+
+			for (const declaration of node.declarations) {
+				if (
+					declaration.init
+					&& (declaration.init.type === 'ArrowFunctionExpression'
+						|| declaration.init.type === 'FunctionExpression')
+				) {
+					context.report({
+						node: declaration,
+						message: 'Top-level functions must be named/regular functions.',
+						fix(fixer) {
+							const sourceCode = context.getSourceCode();
+							const functionText = sourceCode.getText(declaration.init);
+							const functionName = declaration.id.name;
+							const fixedCode = `function ${functionName}${functionText.slice(functionText.indexOf('('))}`;
+							return fixer.replaceText(declaration, fixedCode);
+						},
+					});
+				}
+			}
+		},
+
+		FunctionDeclaration(node) {
+			if (node.id) {
+				return;
+			}
+
+			if (node.parent.type === 'Program') {
+				context.report({
+					node,
+					message: 'Top-level functions must be named.',
+					fix(fixer) {
+						const sourceCode = context.getSourceCode();
+						const functionName = 'defaultFunction';
+						const functionText = sourceCode.getText(node);
+
+						const fixedCode = functionText.replace('function (', `function ${functionName}(`);
+
+						return fixer.replaceText(node, fixedCode);
+					},
+				});
+			}
+		},
+	};
+}
+
+const rule = {
+	meta,
+	create,
+};
+
+module.exports = rule;

package/.eslintrc.js

@@ -1,19 +0,0 @@
-"use strict";
-
-module.exports = {
-  root: true,
-  extends: [
-    "eslint:recommended",
-    "plugin:eslint-plugin/recommended",
-    "plugin:node/recommended",
-  ],
-  env: {
-    node: true,
-  },
-  overrides: [
-    {
-      files: ["tests/**/*.js"],
-      env: { mocha: true },
-    },
-  ],
-};