From bc3fe59312dd94d82ec3767356481c9a6bad38db Mon Sep 17 00:00:00 2001
From: Aman <138197666+aman44444@users.noreply.github.com>
Date: Wed, 4 Oct 2023 14:36:54 +0530
Subject: [PATCH] feat: added an enlint rule to enforce no-type-import (#1838)

* feat: added an enlint rule to enforce no-type-import

* Update style-guide.mdx

---------

Co-authored-by: aman1357 <101919821+aman1357@users.noreply.github.com>
---
 docs/docs/developer/frontend/style-guide.mdx | 31 ++++++++++++++++++++
 front/.eslintrc.js                           |  1 +
 packages/eslint-plugin-twenty/.eslintrc.js   |  1 +
 packages/twenty-cli/.eslintrc.cjs            |  1 +
 server/.eslintrc.js                          |  1 +
 5 files changed, 35 insertions(+)

diff --git a/docs/docs/developer/frontend/style-guide.mdx b/docs/docs/developer/frontend/style-guide.mdx
index dfd47a65d..65efd35d0 100644
--- a/docs/docs/developer/frontend/style-guide.mdx
+++ b/docs/docs/developer/frontend/style-guide.mdx
@@ -259,3 +259,34 @@ const StyledButton = styled.button`
   margin-left: ${({ theme }) => theme.spacing(1)};
   border-radius:  ${({ theme }) => theme.border.rounded};
 `;
+```
+## Enforcing No-Type Imports
+
+In our codebase, we've adopted a coding standard to disallow type imports. This helps maintain consistency and readability in our TypeScript code. To enforce this standard, we've added an ESLint rule that checks for and reports any type imports.
+
+```tsx
+// ❌ Bad
+import { type Meta, type StoryObj } from '@storybook/react';
+
+// ❌ Bad
+import type { Meta, StoryObj } from '@storybook/react';
+
+// ✅ Good
+import { Meta, StoryObj } from '@storybook/react';
+```
+
+### Why No-Type Imports?
+
+- **Consistency**: By avoiding type imports, our codebase remains consistent in its module import style. We use a single approach for both type and value imports.
+
+- **Readability**: No-type imports improve code readability by making it clear when you're importing values or types. This reduces ambiguity and makes it easier to understand the purpose of imported symbols.
+
+- **Maintainability**: Codebase maintainability is enhanced because developers can quickly identify and locate type-only imports when reviewing or modifying code.
+
+### ESLint Rule
+
+We've configured an ESLint rule, `@typescript-eslint/consistent-type-imports`, to enforce the no-type import standard. This rule will generate errors or warnings for any type import violations.
+
+Please note that this rule is intended to address rare edge cases where type imports might be used unintentionally. TypeScript itself discourages this practice, as mentioned in the [TypeScript 3.8 release notes](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-8.html). In most situations, you should not need to use type-only imports.
+
+To ensure your code complies with this rule, make sure to run ESLint as part of your development workflow.
diff --git a/front/.eslintrc.js b/front/.eslintrc.js
index 114b83b78..eaccabd46 100644
--- a/front/.eslintrc.js
+++ b/front/.eslintrc.js
@@ -95,5 +95,6 @@ module.exports = {
         ],
       },
     ],
+    "@typescript-eslint/consistent-type-imports": ["error", { "prefer": "no-type-imports" }],
   }
 };
diff --git a/packages/eslint-plugin-twenty/.eslintrc.js b/packages/eslint-plugin-twenty/.eslintrc.js
index 92957bced..32493518d 100644
--- a/packages/eslint-plugin-twenty/.eslintrc.js
+++ b/packages/eslint-plugin-twenty/.eslintrc.js
@@ -65,5 +65,6 @@ module.exports = {
       "warn",
       { "vars": "all", "varsIgnorePattern": "^_", "args": "after-used", "argsIgnorePattern": "^_" }
     ],
+    "@typescript-eslint/consistent-type-imports": ["error", { "prefer": "no-type-imports" }],
   }
 };
diff --git a/packages/twenty-cli/.eslintrc.cjs b/packages/twenty-cli/.eslintrc.cjs
index 4523ce859..87201ac74 100644
--- a/packages/twenty-cli/.eslintrc.cjs
+++ b/packages/twenty-cli/.eslintrc.cjs
@@ -21,6 +21,7 @@ module.exports = {
       '@typescript-eslint/explicit-function-return-type': 'off',
       '@typescript-eslint/explicit-module-boundary-types': 'off',
       '@typescript-eslint/no-explicit-any': 'off',
+      "@typescript-eslint/consistent-type-imports": ["error", { "prefer": "no-type-imports" }],
     },
   };
   
\ No newline at end of file
diff --git a/server/.eslintrc.js b/server/.eslintrc.js
index 6e43b5862..12c42c1f8 100644
--- a/server/.eslintrc.js
+++ b/server/.eslintrc.js
@@ -75,5 +75,6 @@ module.exports = {
       },
     ],
     'unused-imports/no-unused-imports': 'warn',
+    "@typescript-eslint/consistent-type-imports": ["error", { "prefer": "no-type-imports" }],
   },
 };