Enforce front project structure through ESLINT #7863
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| { | ||
| "$schema": "../../node_modules/eslint-plugin-project-structure/folderStructure.schema.json", | ||
| "regexParameters": { | ||
| "camelCase": "^[a-zA-Z]+([A-Z][a-z]+)+" | ||
| }, | ||
| "structure": [ | ||
| { | ||
| "name": "packages", | ||
| "children": [ | ||
| { | ||
| "name": "twenty-front", | ||
| "children": [ | ||
| { | ||
| "name": "src", | ||
| "children": [ | ||
| { "name": "*", "children": [] }, | ||
| { "name": "*" }, | ||
| { | ||
| "name": "modules", | ||
| "children": [{ "ruleId": "moduleFolderRule" }] | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| } | ||
| ], | ||
| "rules": { | ||
| "moduleFolderRule": { | ||
| "name": "^(?!utils$|hooks$|states|types|graphql|components|effect-components|constants|validation-schemas|context$)[a-z][a-z0-9]**(?:-[a-z0-9]+)**$", | ||
|
There was a problem hiding this comment. style: The regex for module folder names is complex and may be difficult to maintain. Consider simplifying or documenting it for clarity. |
||
| "folderRecursionLimit": 3, | ||
| "children": [ | ||
| { "ruleId": "moduleFolderRule" }, | ||
| { "name": "hooks", "ruleId": "hooksLeafFolderRule" }, | ||
| { "name": "utils", "ruleId": "utilsLeafFolderRule" }, | ||
| { "name": "states", "ruleId": "doNotCheckLeafFolderRule" }, | ||
|
There was a problem hiding this comment. I have added this rule for now we can progressively add the rules folder by folder once we have fixed the existing warnings (we have ~150), let's do it step by step There was a problem hiding this comment. I've actually fixed existing warnings but I don't want to move everything now, we will activate these rules progressively |
||
| { "name": "types", "ruleId": "doNotCheckLeafFolderRule" }, | ||
| { "name": "graphql", "ruleId": "doNotCheckLeafFolderRule" }, | ||
| { "name": "components", "ruleId": "doNotCheckLeafFolderRule" }, | ||
| { "name": "effect-components", "ruleId": "doNotCheckLeafFolderRule" }, | ||
| { "name": "constants", "ruleId": "doNotCheckLeafFolderRule" }, | ||
| { "name": "validation-schemas", "ruleId": "doNotCheckLeafFolderRule" }, | ||
| { "name": "context", "ruleId": "doNotCheckLeafFolderRule" } | ||
| ] | ||
| }, | ||
| "hooksLeafFolderRule": { | ||
| "folderRecursionLimit": 2, | ||
| "children": [ | ||
| { "name": "use{PascalCase}.(ts|tsx)" }, | ||
|
There was a problem hiding this comment. style: The naming convention for hooks files is strict. Ensure all existing hooks follow this pattern, or consider allowing more flexibility. |
||
| { | ||
| "name": "__tests__", | ||
| "children": [{ "name": "use{PascalCase}.test.(ts|tsx)" }] | ||
| }, | ||
| { "name": "internal", "ruleId": "hooksLeafFolderRule" } | ||
| ] | ||
| }, | ||
| "doNotCheckLeafFolderRule": { | ||
| "folderRecursionLimit": 1, | ||
| "children": [{ "name": "*" }, { "name": "*", "children": [] }] | ||
| }, | ||
| "utilsLeafFolderRule": { | ||
| "folderRecursionLimit": 1, | ||
| "children": [ | ||
| { "name": "{camelCase}.ts" }, | ||
| { | ||
| "name": "__tests__", | ||
| "children": [{ "name": "{camelCase}.test.ts" }] | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
style: Consider adding a comment explaining the purpose of the 'project-structure' plugin for future maintainers