Add Guidelines for components #70
Merged
Conversation
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
mwiencek
reviewed
May 19, 2022
mwiencek
reviewed
Jun 2, 2022
- This will be automatically handled by eslint and prettier now.
reosarevok
approved these changes
Jun 2, 2022
guidelines/component-usage.md
Outdated
| 1. #### Naming Style **[⬆](#table-of-content)** | ||
|
|
||
| * Always use the `.js` extension. | ||
| * Use UpperCamelCase as a components name. |
There was a problem hiding this comment.
component's I guess? or "for component names", to match "for prop names" below.
guidelines/component-usage.md
Outdated
| * Use UpperCamelCase as a components name. | ||
| * Use lowerCamelCase for prop names. | ||
| * Component name should be the same as the file name. This means that the use of `index` files is forbidden for components. It's easier to find components by filename rather than by folder name. | ||
| * Component filenames should be in UpperCamelCase. It's allowed to use dots (`.`) to explicitly mention type of component: `Dashboard.component.js`. |
There was a problem hiding this comment.
What's the point of the dot notation? Also, you already say "Use UpperCamelCase as a components name" and "[The] Component name should be the same as the file name", so isn't this redundant?
guidelines/component-usage.md
Outdated
| * Always use the `.js` extension. | ||
| * Use UpperCamelCase as a components name. | ||
| * Use lowerCamelCase for prop names. | ||
| * Component name should be the same as the file name. This means that the use of `index` files is forbidden for components. It's easier to find components by filename rather than by folder name. |
guidelines/component-usage.md
Outdated
| * Component name should be the same as the file name. This means that the use of `index` files is forbidden for components. It's easier to find components by filename rather than by folder name. | ||
| * Component filenames should be in UpperCamelCase. It's allowed to use dots (`.`) to explicitly mention type of component: `Dashboard.component.js`. | ||
| * Props and state interface definitions shouldn't be prefixed with `I`. Use UpperCamelCase instead. | ||
| * Exported props or state types should have a descriptive name and a `Props` or `State` suffix: `ProgressBarProps`, `EntityDialogState`. Non-exported types are recommended to be named `Props` and `State` respectively. |
There was a problem hiding this comment.
Maybe add "If more than one non-exported set of props is needed, give all but the main one a name matching their component"? At least in MB we have several cases where there's a main Props and then something like SmallComponentProps for a SmallComponent defined and used only on that same file.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
A proper guideline for adding components has been added.