eslint-plugin-th-rules 1.15.0 → 1.15.2

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [1.15.2](https://github.com/tomerh2001/eslint-plugin-th-rules/compare/v1.15.1...v1.15.2) (2024-12-30)
+
+
+### Bug Fixes
+
+* implement top-level functions rule with tests for ESLint ([c19c451](https://github.com/tomerh2001/eslint-plugin-th-rules/commit/c19c4515b66b314cc327ef84c674a1324ad7d204))
+
+## [1.15.1](https://github.com/tomerh2001/eslint-plugin-th-rules/compare/v1.15.0...v1.15.1) (2024-12-30)
+
+
+### Bug Fixes
+
+* enable top-level functions rule in ESLint configuration ([ce694ad](https://github.com/tomerh2001/eslint-plugin-th-rules/commit/ce694ad302388f13e04af8e3d951c8cf00c0603f))
+
 # [1.15.0](https://github.com/tomerh2001/eslint-plugin-th-rules/compare/v1.14.1...v1.15.0) (2024-12-30)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-th-rules",
-  "version": "1.15.0",
+  "version": "1.15.2",
   "description": "A List of custom ESLint rules created by Tomer Horowitz",
   "keywords": [
     "eslint",

package/src/index.js

@@ -18,6 +18,7 @@ const configs = {
 			'th-rules/no-destructuring': 'error',
 			'th-rules/no-default-export': 'error',
 			'th-rules/no-comments': 'error',
+			'th-rules/top-level-functions': 'error',
 			'unicorn/prefer-module': 'warn',
 			'unicorn/filename-case': 'off',
 			'unicorn/no-array-callback-reference': 'off',

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

@@ -1,14 +1,3 @@
-/**
- * @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: {
@@ -21,39 +10,29 @@ const meta = {
 	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') {
+		VariableDeclarator(node) {
+			if (node.parent.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);
-						},
-					});
-				}
+			if (!(node.init && (node.init.type === 'ArrowFunctionExpression' || node.init.type === 'FunctionExpression'))) {
+				return;
 			}
+
+			const sourceCode = context.getSourceCode();
+			const functionText = sourceCode.getText(node.init);
+			const functionName = node.id.name;
+
+			context.report({
+				node: node.init,
+				message: 'Top-level functions must be named/regular functions.',
+				fix(fixer) {
+					const fixedCode = `function ${functionName}${functionText.slice(functionText.indexOf('('))}`;
+					return fixer.replaceText(node, fixedCode);
+				},
+			});
 		},
 
 		FunctionDeclaration(node) {
@@ -66,10 +45,9 @@ function create(context) {
 					node,
 					message: 'Top-level functions must be named.',
 					fix(fixer) {
-						const sourceCode = context.getSourceCode();
 						const functionName = 'defaultFunction';
+						const sourceCode = context.getSourceCode();
 						const functionText = sourceCode.getText(node);
-
 						const fixedCode = functionText.replace('function (', `function ${functionName}(`);
 
 						return fixer.replaceText(node, fixedCode);

package/tests/top-level-functions.test.js

@@ -0,0 +1,30 @@
+const {RuleTester} = require('eslint');
+const rule = require('../src/rules/top-level-functions');
+
+const ruleTester = new RuleTester({
+	parserOptions: {ecmaVersion: 2021, sourceType: 'module'},
+});
+
+ruleTester.run('top-level-functions', rule, {
+	valid: [
+		'function test() {}',
+		'function anotherFunction() {}',
+	],
+	invalid: [
+		{
+			code: 'const test = () => {};',
+			errors: [{message: 'Top-level functions must be named/regular functions.'}],
+			output: 'function test() {}',
+		},
+		{
+			code: 'const response = (res, parameters = {}) => {};',
+			errors: [{message: 'Top-level functions must be named/regular functions.'}],
+			output: 'function response(res, parameters = {}) {}',
+		},
+		{
+			code: 'const func = function () {};',
+			errors: [{message: 'Top-level functions must be named/regular functions.'}],
+			output: 'function func() {}',
+		},
+	],
+});