Improve error message of collocated fragments. #7
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
robinpokorny
approved these changes
Aug 18, 2023
| 'needs this information, that module should directly define a ' + | ||
| 'fragment querying for that data, colocated next to where the ' + | ||
| 'data is used.\n' | ||
| `this module does not use it directly or it the fragment is named incorrectly. If a different module ` + |
There was a problem hiding this comment.
I'd even remove the first part of the error message. Let's make it clear that the problem is a) name of the imported component and b) the underscore.
jaroslav-kubicek
approved these changes
Aug 18, 2023
| `needs the data from this fragment, that module should directly define it's own fragment ` + | ||
| `to query for it's own data, and such fragment should be spread in the parent component.` + | ||
| `The naming convention should be <nameOfComponentCamelCase>_<optionalSuffix>. ` + | ||
| `The <nameOfComponentCamelCase> should match the import name. Optinal suffix should be separated ` + |
There was a problem hiding this comment.
Suggested change
| `The <nameOfComponentCamelCase> should match the import name. Optinal suffix should be separated ` + | |
| `The <nameOfComponentCamelCase> should match the import name. The optional suffix should be separated ` + |
| 'needs this information, that module should directly define a ' + | ||
| 'fragment querying for that data, colocated next to where the ' + | ||
| 'data is used.\n' | ||
| `this module does not use it directly or it the fragment is named incorrectly. If a different module ` + |
There was a problem hiding this comment.
Suggested change
| `this module does not use it directly or it the fragment is named incorrectly. If a different module ` + | |
| `this module does not use it directly or the fragment is named incorrectly. If a different module ` + |
huv1k
reviewed
Aug 18, 2023
Comment on lines
+162
to
+163
| `The <nameOfComponentCamelCase> must match the import name. The optional suffix should be separated ` + | ||
| `by underscore (usually when you need to pass multiple fragments to the same component).\n` |
There was a problem hiding this comment.
Why we didn't make it explicit? We have information about the names of fragments right? This could be better for DX 🙌
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.
It took us some debugging to find out that the problem is that we need to have
_in the name of a fragment :-) Tried to improve the error message. If a better error message comes to your mind, I am all ears! :-)