[ESLint plugin] Add a rule to enforce folder architecture on frontend

twentyhq · Oct 7, 2024 · 6a42d58 · 6a42d58
1 parent 491fe80
commit 6a42d58
Show file tree

Hide file tree

Showing 4 changed files with 582 additions and 0 deletions.
diff --git a/package.json b/package.json
@@ -296,6 +296,7 @@
     "eslint-plugin-jsx-a11y": "^6.8.0",
     "eslint-plugin-prefer-arrow": "^1.2.3",
     "eslint-plugin-prettier": "^5.1.2",
+    "eslint-plugin-project-structure": "^3.0.1",
     "eslint-plugin-react": "^7.33.2",
     "eslint-plugin-react-hooks": "^4.6.0",
     "eslint-plugin-react-refresh": "^0.4.4",

diff --git a/packages/twenty-front/.eslintrc.cjs b/packages/twenty-front/.eslintrc.cjs
@@ -1,3 +1,4 @@
+const folderStructureConfig = require('./project-structure.cjs');
 module.exports = {
   extends: ['../../.eslintrc.cjs', '../../.eslintrc.react.cjs'],
   ignorePatterns: [
@@ -15,6 +16,10 @@ module.exports = {
     'tsup.ui.index.tsx',
     '__mocks__',
   ],
+  plugins: ['project-structure'],
+  rules: {
+    'project-structure/folder-structure': ['warn', folderStructureConfig],
+  },
   overrides: [
     {
       files: ['*.ts', '*.tsx'],