folderStructure.json refactor (#8088)

#7911 

If you encounter any issues or have any questions regarding the library,
feel free to write
[here](https://github.com/Igorkowalski94/eslint-plugin-project-structure/discussions/new?category=help),
I’d be happy to help.

.gitignore

@@ -9,7 +9,6 @@
 
 .nx/installation
 .nx/cache
-projectStructure.cache.json
 
 .pnp.*
 .yarn/*

package.json

@@ -296,7 +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.7.2",
+    "eslint-plugin-project-structure": "^3.9.1",
     "eslint-plugin-react": "^7.33.2",
     "eslint-plugin-react-hooks": "^4.6.0",
     "eslint-plugin-react-refresh": "^0.4.4",

packages/twenty-front/.gitignore

@@ -41,4 +41,7 @@ dist-ssr
 *.sw?
 
 .vite/
-.nyc_output/
+.nyc_output/
+
+# eslint-plugin-project-structure
+projectStructure.cache.json

packages/twenty-front/folderStructure.json

@@ -1,57 +1,45 @@
 {
   "$schema": "../../node_modules/eslint-plugin-project-structure/folderStructure.schema.json",
+  "projectRoot": "packages/twenty-front",
+  "structureRoot": "src",
   "regexParameters": {
-    "camelCase": "^[a-z]+[A-Za-z0-9]+"
+    "camelCase": "^[a-z]+([A-Za-z0-9]+)+",
+    "kebab-case": "[a-z][a-z0-9]*(?:-[a-z0-9]+)*"
   },
   "structure": [
-    {
+    { "name": "*" },
-      "name": "packages",
+    { "name": "*", "children": [] },
-      "children": [
+    { "name": "modules", "ruleId": "modulesFolderRule" }
-        {
-          "name": "twenty-front",
-          "children": [
-            { "name": "*", "children": [] },
-            { "name": "*" },
-            {
-              "name": "src",
-              "children": [
-                { "name": "*", "children": [] },
-                { "name": "*" },
-                {
-                  "name": "modules",
-                  "children": [
-                    { "ruleId": "moduleFolderRule" },
-                    { "name": "types", "ruleId": "doNotCheckLeafFolderRule" }
-                  ]
-                }
-              ]
-            }
-          ]
-        }
-      ]
-    }
   ],
   "rules": {
+    "modulesFolderRule": {
+      "children": [
+        { "ruleId": "moduleFolderRule" },
+        { "name": "types", "children": [] }
+      ]
+    },
+
     "moduleFolderRule": {
-      "name": "^(?!utils$|hooks$|states$|types$|graphql$|components$|effect-components$|constants$|validation-schemas$|contexts$|scopes$|services$|errors$)[a-z][a-z0-9]**(?:-[a-z0-9]+)**$",
+      "name": "{kebab-case}",
       "folderRecursionLimit": 6,
       "children": [
         { "ruleId": "moduleFolderRule" },
         { "name": "hooks", "ruleId": "hooksLeafFolderRule" },
         { "name": "utils", "ruleId": "utilsLeafFolderRule" },
-        { "name": "states", "ruleId": "doNotCheckLeafFolderRule" },
+        { "name": "states", "children": [] },
-        { "name": "types", "ruleId": "doNotCheckLeafFolderRule" },
+        { "name": "types", "children": [] },
-        { "name": "graphql", "ruleId": "doNotCheckLeafFolderRule" },
+        { "name": "graphql", "children": [] },
-        { "name": "components", "ruleId": "doNotCheckLeafFolderRule" },
+        { "name": "components", "children": [] },
-        { "name": "effect-components", "ruleId": "doNotCheckLeafFolderRule" },
+        { "name": "effect-components", "children": [] },
-        { "name": "constants", "ruleId": "doNotCheckLeafFolderRule" },
+        { "name": "constants", "children": [] },
-        { "name": "validation-schemas", "ruleId": "doNotCheckLeafFolderRule" },
+        { "name": "validation-schemas", "children": [] },
-        { "name": "contexts", "ruleId": "doNotCheckLeafFolderRule" },
+        { "name": "contexts", "children": [] },
-        { "name": "scopes", "ruleId": "doNotCheckLeafFolderRule" },
+        { "name": "scopes", "children": [] },
-        { "name": "services", "ruleId": "doNotCheckLeafFolderRule" },
+        { "name": "services", "children": [] },
-        { "name": "errors", "ruleId": "doNotCheckLeafFolderRule" }
+        { "name": "errors", "children": [] }
       ]
     },
+
     "hooksLeafFolderRule": {
       "folderRecursionLimit": 2,
       "children": [
@@ -63,12 +51,8 @@
         { "name": "internal", "ruleId": "hooksLeafFolderRule" }
       ]
     },
-    "doNotCheckLeafFolderRule": {
+
-      "folderRecursionLimit": 1,
-      "children": [{ "name": "*" }, { "name": "*", "children": [] }]
-    },
     "utilsLeafFolderRule": {
-      "folderRecursionLimit": 1,
       "children": [
         { "name": "{camelCase}.ts" },
         {

packages/twenty-front/src/index.css

@@ -10,6 +10,6 @@ html {
 }
 
 /* https://stackoverflow.com/questions/44543157/how-to-hide-the-google-invisible-recaptcha-badge */
-.grecaptcha-badge { 
+.grecaptcha-badge {
   visibility: hidden !important;
 }

packages/twenty-front/src/modules/favorites/hooks/__mocks__/useFavorites.ts

@@ -85,238 +85,238 @@ export const mocks = [
         mutation CreateOneFavorite($input: FavoriteCreateInput!) {
           createFavorite(data: $input) {
             __typename
-        company {
+            company {
-          __typename
+              __typename
-          accountOwnerId
+              accountOwnerId
-          address {
+              address {
-            addressStreet1
+                addressStreet1
-            addressStreet2
+                addressStreet2
-            addressCity
+                addressCity
-            addressState
+                addressState
-            addressCountry
+                addressCountry
-            addressPostcode
+                addressPostcode
-            addressLat
+                addressLat
-            addressLng
+                addressLng
-          }
+              }
-          annualRecurringRevenue {
+              annualRecurringRevenue {
-            amountMicros
+                amountMicros
-            currencyCode
+                currencyCode
-          }
+              }
-          createdAt
+              createdAt
-          createdBy {
+              createdBy {
-            source
+                source
+                workspaceMemberId
+                name
+              }
+              deletedAt
+              domainName {
+                primaryLinkUrl
+                primaryLinkLabel
+                secondaryLinks
+              }
+              employees
+              id
+              idealCustomerProfile
+              introVideo {
+                primaryLinkUrl
+                primaryLinkLabel
+                secondaryLinks
+              }
+              linkedinLink {
+                primaryLinkUrl
+                primaryLinkLabel
+                secondaryLinks
+              }
+              name
+              position
+              tagline
+              updatedAt
+              visaSponsorship
+              workPolicy
+              xLink {
+                primaryLinkUrl
+                primaryLinkLabel
+                secondaryLinks
+              }
+            }
+            companyId
+            createdAt
+            deletedAt
+            id
+            note {
+              __typename
+              body
+              createdAt
+              createdBy {
+                source
+                workspaceMemberId
+                name
+              }
+              deletedAt
+              id
+              position
+              title
+              updatedAt
+            }
+            noteId
+            opportunity {
+              __typename
+              amount {
+                amountMicros
+                currencyCode
+              }
+              closeDate
+              companyId
+              createdAt
+              createdBy {
+                source
+                workspaceMemberId
+                name
+              }
+              deletedAt
+              id
+              name
+              pointOfContactId
+              position
+              stage
+              updatedAt
+            }
+            opportunityId
+            person {
+              __typename
+              avatarUrl
+              city
+              companyId
+              createdAt
+              createdBy {
+                source
+                workspaceMemberId
+                name
+              }
+              deletedAt
+              emails {
+                primaryEmail
+                additionalEmails
+              }
+              id
+              intro
+              jobTitle
+              linkedinLink {
+                primaryLinkUrl
+                primaryLinkLabel
+                secondaryLinks
+              }
+              name {
+                firstName
+                lastName
+              }
+              performanceRating
+              phones {
+                primaryPhoneNumber
+                primaryPhoneCountryCode
+                additionalPhones
+              }
+              position
+              updatedAt
+              whatsapp {
+                primaryPhoneNumber
+                primaryPhoneCountryCode
+                additionalPhones
+              }
+              workPreference
+              xLink {
+                primaryLinkUrl
+                primaryLinkLabel
+                secondaryLinks
+              }
+            }
+            personId
+            position
+            rocket {
+              __typename
+              createdAt
+              createdBy {
+                source
+                workspaceMemberId
+                name
+              }
+              deletedAt
+              id
+              name
+              position
+              updatedAt
+            }
+            rocketId
+            task {
+              __typename
+              assigneeId
+              body
+              createdAt
+              createdBy {
+                source
+                workspaceMemberId
+                name
+              }
+              deletedAt
+              dueAt
+              id
+              position
+              status
+              title
+              updatedAt
+            }
+            taskId
+            updatedAt
+            view {
+              __typename
+              createdAt
+              deletedAt
+              icon
+              id
+              isCompact
+              kanbanFieldMetadataId
+              key
+              name
+              objectMetadataId
+              position
+              type
+              updatedAt
+            }
+            viewId
+            workflow {
+              __typename
+              createdAt
+              deletedAt
+              id
+              lastPublishedVersionId
+              name
+              position
+              statuses
+              updatedAt
+            }
+            workflowId
+            workspaceMember {
+              __typename
+              avatarUrl
+              colorScheme
+              createdAt
+              dateFormat
+              deletedAt
+              id
+              locale
+              name {
+                firstName
+                lastName
+              }
+              timeFormat
+              timeZone
+              updatedAt
+              userEmail
+              userId
+            }
             workspaceMemberId
-            name
-          }
-          deletedAt
-          domainName {
-            primaryLinkUrl
-            primaryLinkLabel
-            secondaryLinks
-          }
-          employees
-          id
-          idealCustomerProfile
-          introVideo {
-            primaryLinkUrl
-            primaryLinkLabel
-            secondaryLinks
-          }
-          linkedinLink {
-            primaryLinkUrl
-            primaryLinkLabel
-            secondaryLinks
-          }
-          name
-          position
-          tagline
-          updatedAt
-          visaSponsorship
-          workPolicy
-          xLink {
-            primaryLinkUrl
-            primaryLinkLabel
-            secondaryLinks
           }
         }
-        companyId
-        createdAt
-        deletedAt
-        id
-        note {
-          __typename
-          body
-          createdAt
-          createdBy {
-            source
-            workspaceMemberId
-            name
-          }
-          deletedAt
-          id
-          position
-          title
-          updatedAt
-        }
-        noteId
-        opportunity {
-          __typename
-          amount {
-            amountMicros
-            currencyCode
-          }
-          closeDate
-          companyId
-          createdAt
-          createdBy {
-            source
-            workspaceMemberId
-            name
-          }
-          deletedAt
-          id
-          name
-          pointOfContactId
-          position
-          stage
-          updatedAt
-        }
-        opportunityId
-        person {
-          __typename
-          avatarUrl
-          city
-          companyId
-          createdAt
-          createdBy {
-            source
-            workspaceMemberId
-            name
-          }
-          deletedAt
-          emails {
-            primaryEmail
-            additionalEmails
-          }
-          id
-          intro
-          jobTitle
-          linkedinLink {
-            primaryLinkUrl
-            primaryLinkLabel
-            secondaryLinks
-          }
-          name {
-            firstName
-            lastName
-          }
-          performanceRating
-          phones {
-            primaryPhoneNumber
-            primaryPhoneCountryCode
-            additionalPhones
-          }
-          position
-          updatedAt
-          whatsapp {
-            primaryPhoneNumber
-            primaryPhoneCountryCode
-            additionalPhones
-          }
-          workPreference
-          xLink {
-            primaryLinkUrl
-            primaryLinkLabel
-            secondaryLinks
-          }
-        }
-        personId
-        position
-        rocket {
-          __typename
-          createdAt
-          createdBy {
-            source
-            workspaceMemberId
-            name
-          }
-          deletedAt
-          id
-          name
-          position
-          updatedAt
-        }
-        rocketId
-        task {
-          __typename
-          assigneeId
-          body
-          createdAt
-          createdBy {
-            source
-            workspaceMemberId
-            name
-          }
-          deletedAt
-          dueAt
-          id
-          position
-          status
-          title
-          updatedAt
-        }
-        taskId
-        updatedAt
-        view {
-          __typename
-          createdAt
-          deletedAt
-          icon
-          id
-          isCompact
-          kanbanFieldMetadataId
-          key
-          name
-          objectMetadataId
-          position
-          type
-          updatedAt
-        }
-        viewId
-        workflow {
-          __typename
-          createdAt
-          deletedAt
-          id
-          lastPublishedVersionId
-          name
-          position
-          statuses
-          updatedAt
-        }
-        workflowId
-        workspaceMember {
-          __typename
-          avatarUrl
-          colorScheme
-          createdAt
-          dateFormat
-          deletedAt
-          id
-          locale
-          name {
-            firstName
-            lastName
-          }
-          timeFormat
-          timeZone
-          updatedAt
-          userEmail
-          userId
-        }
-        workspaceMemberId
-      }
-    }
       `,
       variables: {
         input: {

packages/twenty-front/src/modules/object-metadata/hooks/__mocks__/useDeleteOneRelationMetadataItem.ts

@@ -11,5 +11,5 @@ export const query = gql`
 export const variables = { idToDelete: 'idToDelete' };
 
 export const responseData = {
-  id: 'idToDelete'
+  id: 'idToDelete',
 };

packages/twenty-front/src/modules/object-metadata/hooks/__mocks__/useFieldMetadataItem.ts

@@ -2,7 +2,8 @@ import { gql } from '@apollo/client';
 import { FieldMetadataType } from '~/generated/graphql';
 
 export const FIELD_METADATA_ID = '2c43466a-fe9e-4005-8d08-c5836067aa6c';
-export const FIELD_RELATION_METADATA_ID = '4da0302d-358a-45cd-9973-9f92723ed3c1';
+export const FIELD_RELATION_METADATA_ID =
+  '4da0302d-358a-45cd-9973-9f92723ed3c1';
 export const RELATION_METADATA_ID = 'f81d4fae-7dec-11d0-a765-00a0c91e6bf6';
 
 const baseFields = `
@@ -29,12 +30,12 @@ export const queries = {
     }
   `,
   deleteMetadataFieldRelation: gql`
-  mutation DeleteOneRelationMetadataItem($idToDelete: UUID!) {
+    mutation DeleteOneRelationMetadataItem($idToDelete: UUID!) {
-    deleteOneRelation(input: { id: $idToDelete }) {
+      deleteOneRelation(input: { id: $idToDelete }) {
-      id
+        id
+      }
     }
-  }
+  `,
-`,
   activateMetadataField: gql`
     mutation UpdateOneFieldMetadataItem(
       $idToUpdate: UUID!
@@ -94,7 +95,7 @@ export const variables = {
   deactivateMetadataField: {
     idToUpdate: FIELD_METADATA_ID,
     updatePayload: { isActive: false, label: undefined },
-  }
+  },
 };
 
 const defaultResponseData = {
@@ -127,4 +128,3 @@ export const responseData = {
     options: [],
   },
 };
-

packages/twenty-front/src/modules/object-record/hooks/__mocks__/personFragments.ts

@@ -45,7 +45,7 @@ export const PERSON_FRAGMENT_WITH_DEPTH_ZERO_RELATIONS = `
         primaryLinkLabel
         secondaryLinks
       }
-`
+`;
 
 export const PERSON_FRAGMENT_WITH_DEPTH_ONE_RELATIONS = `
       __typename
@@ -324,4 +324,4 @@ export const PERSON_FRAGMENT_WITH_DEPTH_ONE_RELATIONS = `
         primaryLinkLabel
         secondaryLinks
       }
-`
+`;

packages/twenty-front/src/modules/object-record/hooks/__mocks__/useFetchAllRecordIds.ts

@@ -3,10 +3,19 @@ import { gql } from '@apollo/client';
 
 import { peopleQueryResult } from '~/testing/mock-data/people';
 
-
 export const query = gql`
-  query FindManyPeople($filter: PersonFilterInput, $orderBy: [PersonOrderByInput], $lastCursor: String, $limit: Int) {
+  query FindManyPeople(
-    people(filter: $filter, orderBy: $orderBy, first: $limit, after: $lastCursor){
+    $filter: PersonFilterInput
+    $orderBy: [PersonOrderByInput]
+    $lastCursor: String
+    $limit: Int
+  ) {
+    people(
+      filter: $filter
+      orderBy: $orderBy
+      first: $limit
+      after: $lastCursor
+    ) {
       edges {
         node {
           __typename
@@ -27,38 +36,51 @@ export const query = gql`
 
 export const mockPageSize = 2;
 
-export const peopleMockWithIdsOnly: RecordGqlConnection = { ...peopleQueryResult.people,edges: peopleQueryResult.people.edges.map((edge) => ({ ...edge, node: { __typename: 'Person', id: edge.node.id } })) };
+export const peopleMockWithIdsOnly: RecordGqlConnection = {
+  ...peopleQueryResult.people,
+  edges: peopleQueryResult.people.edges.map((edge) => ({
+    ...edge,
+    node: { __typename: 'Person', id: edge.node.id },
+  })),
+};
 
-export const firstRequestLastCursor = peopleMockWithIdsOnly.edges[mockPageSize].cursor;
+export const firstRequestLastCursor =
-export const secondRequestLastCursor = peopleMockWithIdsOnly.edges[mockPageSize * 2].cursor;
+  peopleMockWithIdsOnly.edges[mockPageSize].cursor;
-export const thirdRequestLastCursor = peopleMockWithIdsOnly.edges[mockPageSize * 3].cursor;
+export const secondRequestLastCursor =
+  peopleMockWithIdsOnly.edges[mockPageSize * 2].cursor;
+export const thirdRequestLastCursor =
+  peopleMockWithIdsOnly.edges[mockPageSize * 3].cursor;
 
 export const variablesFirstRequest = {
   filter: undefined,
   limit: mockPageSize,
-  orderBy: undefined
+  orderBy: undefined,
 };
 
 export const variablesSecondRequest = {
   filter: undefined,
   limit: mockPageSize,
   orderBy: undefined,
-  lastCursor: firstRequestLastCursor
+  lastCursor: firstRequestLastCursor,
 };
 
 export const variablesThirdRequest = {
   filter: undefined,
   limit: mockPageSize,
   orderBy: undefined,
-  lastCursor: secondRequestLastCursor
+  lastCursor: secondRequestLastCursor,
-}
+};
 
-const paginateRequestResponse = (response: RecordGqlConnection, start: number, end: number, hasNextPage: boolean, totalCount: number) => {
+const paginateRequestResponse = (
+  response: RecordGqlConnection,
+  start: number,
+  end: number,
+  hasNextPage: boolean,
+  totalCount: number,
+) => {
   return {
     ...response,
-    edges: [
+    edges: [...response.edges.slice(start, end)],
-      ...response.edges.slice(start, end)
-    ],
     pageInfo: {
       ...response.pageInfo,
       startCursor: response.edges[start].cursor,
@@ -66,17 +88,35 @@ const paginateRequestResponse = (response: RecordGqlConnection, start: number, e
       hasNextPage,
     } satisfies RecordGqlConnection['pageInfo'],
     totalCount,
-  }
+  };
-}
+};
 
 export const responseFirstRequest = {
-  people: paginateRequestResponse(peopleMockWithIdsOnly, 0, mockPageSize, true, 6),
+  people: paginateRequestResponse(
+    peopleMockWithIdsOnly,
+    0,
+    mockPageSize,
+    true,
+    6,
+  ),
 };
 
 export const responseSecondRequest = {
-  people: paginateRequestResponse(peopleMockWithIdsOnly, mockPageSize, mockPageSize * 2, true, 6),
+  people: paginateRequestResponse(
+    peopleMockWithIdsOnly,
+    mockPageSize,
+    mockPageSize * 2,
+    true,
+    6,
+  ),
 };
 
 export const responseThirdRequest = {
-  people: paginateRequestResponse(peopleMockWithIdsOnly, mockPageSize * 2, mockPageSize * 3, false, 6),
+  people: paginateRequestResponse(
+    peopleMockWithIdsOnly,
+    mockPageSize * 2,
+    mockPageSize * 3,
+    false,
+    6,
+  ),
 };

packages/twenty-front/src/modules/object-record/record-field/__mocks__/fieldDefinitions.ts

@@ -5,7 +5,7 @@ import {
   FieldFullNameMetadata,
   FieldRatingMetadata,
   FieldSelectMetadata,
-  FieldTextMetadata
+  FieldTextMetadata,
 } from '@/object-record/record-field/types/FieldMetadata';
 import { FieldMetadataType } from '~/generated-metadata/graphql';
 import { generatedMockObjectMetadataItems } from '~/testing/mock-data/generatedMockObjectMetadataItems';
@@ -29,7 +29,6 @@ if (!mockedPersonObjectMetadataItem) {
   throw new Error('Person object metadata item not found');
 }
 
-
 const relationFieldMetadataItem = mockedPersonObjectMetadataItem?.fields?.find(
   ({ name }) => name === 'company',
 );
@@ -110,4 +109,4 @@ export const actorFieldDefinition: FieldDefinition<FieldActorMetadata> = {
   metadata: {
     fieldName: 'actor',
   },
-};
+};

packages/twenty-front/src/modules/object-record/record-table/record-table-cell/hooks/__mocks__/cell.ts

@@ -15,7 +15,7 @@ export const recordTableRow: RecordTableRowContextProps = {
   isPendingRow: false,
 };
 
-export const recordTableCell:RecordTableCellContextProps= {
+export const recordTableCell: RecordTableCellContextProps = {
   columnIndex: 3,
   columnDefinition: {
     size: 1,

packages/twenty-front/src/modules/settings/data-model/fields/preview/components/SettingsDataModelFieldPreviewCard.tsx

@@ -1,8 +1,7 @@
 import styled from '@emotion/styled';
 
 import {
-  // eslint-disable-next-line prettier/prettier
+  SettingsDataModelFieldPreview,
-    SettingsDataModelFieldPreview,
   SettingsDataModelFieldPreviewProps,
 } from '@/settings/data-model/fields/preview/components/SettingsDataModelFieldPreview';
 import { SettingsDataModelObjectSummary } from '@/settings/data-model/objects/components/SettingsDataModelObjectSummary';

yarn.lock

@@ -25835,16 +25835,16 @@ __metadata:
   languageName: node
   linkType: hard
 
-"eslint-plugin-project-structure@npm:^3.7.2":
+"eslint-plugin-project-structure@npm:^3.9.1":
-  version: 3.7.2
+  version: 3.9.1
-  resolution: "eslint-plugin-project-structure@npm:3.7.2"
+  resolution: "eslint-plugin-project-structure@npm:3.9.1"
   dependencies:
     "@typescript-eslint/utils": "npm:^8.8.0"
     comment-json: "npm:^4.2.5"
     js-yaml: "npm:^4.1.0"
     jsonschema: "npm:^1.4.1"
     micromatch: "npm:^4.0.8"
-  checksum: 10c0/bb5d972cb2f24eceae0b5eefc7ccfaed1e0802977bc5ea33d3eb105521b590b5a69b36adcd3124ae67367af6b7798a05b17f06d085deaf9059e53b0839e3621e
+  checksum: 10c0/be37a67298568931ae7fa29b4afe2ad97f945652ea0e595fcc2dd6ce2e09d9e5bb981a99b6b5e1e9a807655a26924c19b640b69a72828ba5bf0aa2ebbfa79df4
   languageName: node
   linkType: hard
 
@@ -44484,7 +44484,7 @@ __metadata:
     eslint-plugin-jsx-a11y: "npm:^6.8.0"
     eslint-plugin-prefer-arrow: "npm:^1.2.3"
     eslint-plugin-prettier: "npm:^5.1.2"
-    eslint-plugin-project-structure: "npm:^3.7.2"
+    eslint-plugin-project-structure: "npm:^3.9.1"
     eslint-plugin-react: "npm:^7.33.2"
     eslint-plugin-react-hooks: "npm:^4.6.0"
     eslint-plugin-react-refresh: "npm:^0.4.4"