eslint-plugin-th-rules 1.12.0 → 1.13.0

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [1.13.0](https://github.com/tomerh2001/eslint-plugin-th-rules/compare/v1.12.0...v1.13.0) (2024-08-19)
+
+
+### Features
+
+* Add named-functions rule to recommended and recommended-typescript configs ([3f88f76](https://github.com/tomerh2001/eslint-plugin-th-rules/commit/3f88f76460d7bce934f83da68c555c9795fdfe92))
+
 # [1.12.0](https://github.com/tomerh2001/eslint-plugin-th-rules/compare/v1.11.4...v1.12.0) (2024-08-19)
 
 

package/README.md

@@ -12,82 +12,17 @@ This repository contains custom ESLint rules to enhance code quality and consist
 This repository contains custom ESLint rules to enhance code quality and consistency across projects, created by Tomer Horowitz.
 
 ## Rules
+<!-- begin auto-generated rules list -->
 
-### 1. No-destructuring Rule
+💼 Configurations enabled in.\
+✅ Set in the `recommended` configuration.\
+🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).
 
-**Rule ID:** `th-rules/no-destructuring`
+| Name                                                 | Description                                                                      | 💼                                  | 🔧 |
+| :--------------------------------------------------- | :------------------------------------------------------------------------------- | :---------------------------------- | :- |
+| [named-functions](docs/rules/named-functions.md)     | Enforce top-level functions to be named functions                                | ✅ ![badge-recommended-typescript][] | 🔧 |
+| [no-comments](docs/rules/no-comments.md)             | Disallow comments except for specified allowed patterns.                         | ✅ ![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-typescript][] | 🔧 |
+| [no-destructuring](docs/rules/no-destructuring.md)   | Disallow destructuring that does not meet certain conditions                     | ✅ ![badge-recommended-typescript][] |    |
 
-#### 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": {
-    "th-rules/no-destructuring": ["error", { "maximumDestructuredVariables": 2, "maximumLineLength": 100 }]
-  }
-}
-```
-
-### 2. Name-Export Rule
-
-**Rule ID:** `th-rules/no-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": {
-    "no-default-export": "error"
-  }
-}
-```
-### 3. No-Disallowed-Comments Rule
-
-**Rule ID:** `th-rules/no-disallowed-comments`
-
-#### Description
-
-This rule disallows comments unless they match specified allowed patterns. It ensures that only relevant and permitted comments are present in the codebase, such as TODOs, warnings, JSDoc comments, ESLint directives, etc.
-
-#### Rule Details
-
-By default, the following comments are allowed:
-
-- TODO, WARNING, ERROR, INFO (case-insensitive).
-- ESLint directives like `/* eslint-disable */`.
-- JSDoc comments (any comment starting with `/**`).
-
-You can also configure additional patterns to allow or disallow specific types of comments.
-
-#### Configuration
-
-```json
-{
-  "rules": {
-    "th-rules/no-disallowed-comments": [
-      "error",
-      {
-        "allow": ["keep", "important"],
-        "disallow": ["deprecated", "hack"]
-      }
-    ]
-  }
-}
+<!-- end auto-generated rules list -->

package/docs/rules/named-functions.md

@@ -0,0 +1,7 @@
+# Enforce top-level functions to be named functions (`th-rules/named-functions`)
+
+💼 This rule is enabled in the following configs: ✅ `recommended`, `recommended-typescript`.
+
+🔧 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 -->

package/docs/rules/no-comments.md

@@ -0,0 +1,48 @@
+# Disallow comments except for specified allowed patterns (`th-rules/no-comments`)
+
+💼 This rule is enabled in the following configs: ✅ `recommended`, `recommended-typescript`.
+
+🔧 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 -->
+
+## Options
+
+<!-- begin auto-generated rule options list -->
+
+| Name       | Description                                  | Type     |
+| :--------- | :------------------------------------------- | :------- |
+| `allow`    | Additional patterns to allow in comments.    | String[] |
+| `disallow` | Additional patterns to disallow in comments. | String[] |
+
+<!-- end auto-generated rule options list -->
+
+## Description
+
+This rule disallows comments unless they match specified allowed patterns. It ensures that only relevant and permitted comments are present in the codebase, such as TODOs, warnings, JSDoc comments, ESLint directives, etc.
+
+## Rule Details
+
+By default, the following comments are allowed:
+
+- TODO, WARNING, ERROR, INFO (case-insensitive).
+- ESLint directives like `/* eslint-disable */`.
+- JSDoc comments (any comment starting with `/**`).
+
+You can also configure additional patterns to allow or disallow specific types of comments.
+
+## Usage
+
+```json
+{
+  "rules": {
+    "th-rules/no-comments": [
+      "error",
+      {
+        "allow": ["keep", "important"],
+        "disallow": ["deprecated", "hack"]
+      }
+    ]
+  }
+}
+```

package/docs/rules/no-default-export.md

@@ -0,0 +1,24 @@
+# Convert unnamed default exports to named default exports based on the file name (`th-rules/no-default-export`)
+
+💼 This rule is enabled in the following configs: ✅ `recommended`, `recommended-typescript`.
+
+🔧 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
+
+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.
+
+## Usage
+```json
+{
+  "rules": {
+    "no-default-export": "error"
+  }
+}
+```

package/docs/rules/no-destructuring.md

@@ -0,0 +1,38 @@
+# Disallow destructuring that does not meet certain conditions (`th-rules/no-destructuring`)
+
+💼 This rule is enabled in the following configs: ✅ `recommended`, `recommended-typescript`.
+
+<!-- end auto-generated rule header -->
+
+## Options
+
+<!-- begin auto-generated rule options list -->
+
+| Name                           | Type    |
+| :----------------------------- | :------ |
+| `maximumDestructuredVariables` | Integer |
+| `maximumLineLength`            | Integer |
+
+<!-- end auto-generated rule options list -->
+
+## 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).
+
+## Usage
+
+```json
+{
+  "rules": {
+    "th-rules/no-destructuring": ["error", { "maximumDestructuredVariables": 2, "maximumLineLength": 100 }]
+  }
+}
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-th-rules",
-  "version": "1.12.0",
+  "version": "1.13.0",
   "description": "A List of custom ESLint rules created by Tomer Horowitz",
   "keywords": [
     "eslint",
@@ -28,7 +28,7 @@
     "eslint-plugin-react-native": "^4.1.0",
     "eslint-plugin-security": "^3.0.1",
     "eslint-plugin-sonarjs": "^1.0.4",
-    "eslint-plugin-th-rules": "^1.11.4",
+    "eslint-plugin-th-rules": "^1.12.0",
     "requireindex": "^1.2.0"
   },
   "devDependencies": {

package/src/index.js

@@ -19,6 +19,7 @@ configs.recommended = {
 		'th-rules/no-destructuring': 'error',
 		'th-rules/no-default-export': 'error',
 		'th-rules/no-comments': 'error',
+		'th-rules/named-functions': 'error',
 		'unicorn/prefer-module': 'warn',
 		'unicorn/filename-case': 'off',
 		'unicorn/no-array-callback-reference': 'off',

package/src/rules/named-functions.js

@@ -0,0 +1,80 @@
+module.exports = {
+  meta: {
+    type: 'problem',
+    docs: {
+      description: 'Enforce top-level functions to be named functions',
+      url: 'https://github.com/tomerh2001/eslint-plugin-th-rules/blob/main/docs/rules/named-functions.md',
+    },
+    fixable: 'code',
+    schema: [],
+  },
+
+  create(context) {
+    function reportAndFix(node, name) {
+      context.report({
+        node,
+        message: 'Top-level functions must be named function declarations.',
+        fix(fixer) {
+          if (node.type === 'FunctionExpression' && node.parent.type === 'VariableDeclarator') {
+            // Convert to a function declaration
+            const sourceCode = context.getSourceCode();
+            const varName = node.parent.id.name;
+            const functionBody = sourceCode.getText(node.body);
+            const functionParams = sourceCode.getText(node.params);
+            const asyncKeyword = node.async ? 'async ' : '';
+            const generatorKeyword = node.generator ? '*' : '';
+
+            const functionDeclaration = `${asyncKeyword}function ${generatorKeyword}${varName}(${functionParams}) ${functionBody}`;
+            return fixer.replaceText(node.parent.parent, functionDeclaration);
+          }
+
+          if (node.type === 'FunctionExpression') {
+            // Convert to a function declaration
+            const sourceCode = context.getSourceCode();
+            const functionBody = sourceCode.getText(node.body);
+            const functionParams = sourceCode.getText(node.params);
+            const asyncKeyword = node.async ? 'async ' : '';
+            const generatorKeyword = node.generator ? '*' : '';
+
+            const functionDeclaration = `${asyncKeyword}function ${generatorKeyword}${name}(${functionParams}) ${functionBody}`;
+            return fixer.replaceText(node, functionDeclaration);
+          }
+
+          return null;
+        },
+      });
+    }
+
+    return {
+      Program(programNode) {
+        const topLevelNodes = programNode.body;
+
+        topLevelNodes.forEach((node) => {
+          if (node.type === 'FunctionDeclaration') {
+            // Skip if already a named function declaration
+            return;
+          }
+
+          if (
+            node.type === 'FunctionExpression' ||
+            (node.type === 'VariableDeclaration' && node.declarations[0].init?.type === 'FunctionExpression')
+          ) {
+            // Force it to be a named function declaration
+            if (node.type === 'VariableDeclaration') {
+              const varName = node.declarations[0].id.name;
+              reportAndFix(node.declarations[0].init, varName);
+            } else {
+              reportAndFix(node, 'Anonymous');
+            }
+          }
+
+          if (node.type === 'ExpressionStatement' && node.expression.type === 'ArrowFunctionExpression') {
+            // Convert arrow functions into named function declarations
+            const varName = node.expression.id ? node.expression.id.name : 'Anonymous';
+            reportAndFix(node.expression, varName);
+          }
+        });
+      },
+    };
+  },
+};

package/src/rules/no-comments.js

@@ -12,6 +12,7 @@ const meta = {
 type: 'problem',
 docs: {
     description: 'Disallow comments except for specified allowed patterns.',
+    url: 'https://github.com/tomerh2001/eslint-plugin-th-rules/blob/main/docs/rules/no-comments.md'
 },
 fixable: 'code',
 schema: [

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

@@ -6,6 +6,7 @@ const meta = {
 	type: 'suggestion',
 	docs: {
 		description: 'Convert unnamed default exports to named default exports based on the file name.',
+		url: 'https://github.com/tomerh2001/eslint-plugin-th-rules/blob/main/docs/rules/no-default-export.md'
 	},
 	fixable: 'code',
 	schema: [],

package/src/rules/no-destructuring.js

@@ -20,6 +20,7 @@ const meta = {
 		description: 'Disallow destructuring that does not meet certain conditions',
 		category: 'Possible Errors',
 		recommended: true,
+		url: 'https://github.com/tomerh2001/eslint-plugin-th-rules/blob/main/docs/rules/no-destructuring.md'
 	},
 	schema: [
 		{

package/src/tests/no-comments.js

@@ -1,115 +0,0 @@
-/* eslint-disable unicorn/prefer-module */
-
-const { RuleTester } = require('eslint');
-const rule = require('../rules/no-comments.js');
-
-// Initialize RuleTester without the old parserOptions, using the new format
-const ruleTester = new RuleTester({
-  parser: require.resolve('@babel/eslint-parser'),
-});
-
-ruleTester.run('no-comments', rule, {
-  valid: [
-    {
-      code: `
-        /**
-         * JSDoc comment
-         * @param {string} name - The name of the person.
-         */
-        function foo(name) {}
-      `,
-    },
-    {
-      code: `
-        // TODO: this needs to be refactored
-        const x = 5;
-      `,
-    },
-    {
-      code: `
-        /* WARNING: temporary fix */
-        const y = 10;
-      `,
-    },
-    {
-      code: `
-        // eslint-disable-next-line no-console
-        console.log("hello");
-      `,
-    },
-    {
-      code: `
-        // keep this comment
-        const z = 15;
-      `,
-      options: [{ allow: ['keep'] }],
-    },
-  ],
-
-  invalid: [
-    {
-      code: `
-        // Regular comment
-        const a = 5;
-      `,
-      errors: [{ message: 'Comment not allowed.' }],
-      output: `
-        const a = 5;
-      `,
-    },
-    {
-      code: `
-        // Some disallowed comment
-        const b = 10;
-      `,
-      options: [{ disallow: ['disallowed'] }],
-      errors: [{ message: 'Comment not allowed.' }],
-      output: `
-        const b = 10;
-      `,
-    },
-    {
-      code: `
-        // DEPRECATED: Remove this function in the next version
-        function deprecatedFunc() {}
-      `,
-      options: [{ disallow: ['deprecated'] }],
-      errors: [{ message: 'Comment not allowed.' }],
-      output: `
-        function deprecatedFunc() {}
-      `,
-    },
-    {
-      code: `
-        // important comment
-        const c = 20;
-      `,
-      errors: [{ message: 'Comment not allowed.' }],
-      output: `
-        const c = 20;
-      `,
-    },
-    {
-      code: `
-        // A completely random comment
-        const d = 25;
-      `,
-      options: [{ allow: ['keep'] }],
-      errors: [{ message: 'Comment not allowed.' }],
-      output: `
-        const d = 25;
-      `,
-    },
-    {
-      code: `
-        // @ts-ignore
-        const e = "typescript";
-      `,
-      options: [{ disallow: ['@ts-ignore'] }],
-      errors: [{ message: 'Comment not allowed.' }],
-      output: `
-        const e = "typescript";
-      `,
-    },
-  ],
-});

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

@@ -1,56 +0,0 @@
-const {RuleTester} = require('eslint');
-const rule = require('../../../lib/rules/no-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/src/tests/no-destructuring.js

@@ -1,51 +0,0 @@
-const {RuleTester} = require('eslint');
-const rule = require('../../../lib/rules/no-destructuring.js');
-
-const ruleTester = new RuleTester({
-	parserOptions: {
-		ecmaVersion: 2020, // ES6 syntax
-		sourceType: 'module', // Allows the use of imports
-	},
-});
-
-ruleTester.run('no-destructuring', 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: 'destructuring 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: 'destructuring of more than 3 variables is not allowed'}, {message: 'destructuring 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: 'destructuring at a nesting level above 3 is not allowed, instead saw 7 levels of nesting'}],
-		},
-	],
-});