refactor(buildContext): added displayName and fixed useInnerContext branch handling#277
Open
refactor(buildContext): added displayName and fixed useInnerContext branch handling#277
Conversation
There was a problem hiding this comment.
Pull Request Overview
This pull request refactors the buildContext utility function to improve type safety and debugging experience. The changes address issues with null handling in TypeScript generics and enhance developer experience with better Provider naming.
- Fixed TypeScript type inconsistencies by standardizing on
nullinstead of mixingnullandundefined - Added displayName to Provider components for better debugging in React DevTools
- Updated documentation examples to use proper default values instead of
null
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/utils/buildContext/buildContext.tsx | Core implementation with type safety fixes and displayName addition |
| src/utils/buildContext/buildContext.md | Updated English documentation example |
| src/utils/buildContext/ko/buildContext.md | Updated Korean documentation example |
Comments suppressed due to low confidence (1)
src/utils/buildContext/buildContext.tsx:17
- The JSDoc example still shows
nullas the second parameter, but this is now invalid according to the updated function signature. This should be updated to match the corrected examples in the documentation files, such as{ title: '' }.
* const [Provider, useContext] = buildContext<{ title: string }>('TestContext', null);
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #277 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 37 37
Lines 1093 1094 +1
Branches 324 324
=========================================
+ Hits 1093 1094 +1 🚀 New features to boost your workflow:
|
This file contains hidden or 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
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.
Overview
buildContextexample documentIn the example,
nullis passed as the second argument, but since the signature ofbuildContextis as follows,nullcannot be passed.Also, since we used the
<{ title: string }>generic type, we cannot initialize it withnull.Currently, it is difficult to debug because there is no displayName for Provider, so the displayName is specified using the
contextNameprop.Since the type declaration of Context is as follows, when reading the Context with
useContext, it is inferred asContextValuesType | undefined.However, if there are no values received as props within the Provider,
nullis returned. If props exist, the received props are returned.Therefore, when reading
useContext,ContextValuesType | nullis actually returned, but the type system infersContextValuesType | undefined.To solve this complex and tangled type problem, the type of context was unified to
ContextValuesType | nullso that onlynullcan be handled.Since the type of
defaultContextValuesis<ContextValuesType extends object> | undefined,nullcannot be provided, so there is no need to handle the case ofnull.Checklist
yarn run fixto format and lint the code and docs?yarn run test:coverageto make sure there is no uncovered line?