Components: Fix "next" component types #28571
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
sarayourfriend
requested review from
ajitbohra and
chrisvanpatten
as code owners
|
Size Change: -14 B (0%) Total Size: 1.37 MB
ℹ️ View Unchanged
|
gziolo
added
[Type] Code Quality
sirreal
reviewed
Jan 29, 2021
| export function ComponentSystemProvider( { | ||
| __unstableNextInclude = [], | ||
| children, | ||
| value = {}, | ||
| } ) { | ||
| // @ts-ignore | ||
| if ( process.env.COMPONENT_SYSTEM_PHASE === 1 ) { |
There was a problem hiding this comment.
I know this isn't introduced here, but adding arbitrary process.env[ whatever ] checks to code that will ship to the browser makes it more difficult for third parties to use the package. It's fine in Gutenberg because the build system is set up for it. The problem is that it forces others to have the same build setup to use the packages containing this code. They must have this or similar:
Lines 118 to 136 in ec83961
It should be clearly mentioned in the package README.
It's the same case as this PR: #16679
sirreal
approved these changes
Jan 29, 2021
packages/components/src/__next/context/component-system-provider.js
Outdated
Show resolved
Hide resolved
| @@ -116,6 +123,7 @@ export function createHighlighterText( { | |||
| ? Object.assign( {}, highlightStyle, activeStyle ) | |||
| : highlightStyle; | |||
|
|
|||
| /** @type {Record<string, any>} */ | |||
There was a problem hiding this comment.
Is this better than the inferred type? It's a pretty weak type and uses any, I'm curious why it needed to be added.
There was a problem hiding this comment.
Becuase of highlightIndex being conditionally added below... I could update it to read:
* @type {{
children: string;
className: string;
key: number;
style: import('react').CSSProperties;
"data-g2-component": any;
highlightIndex?: number;
}} */
const props = {
...ui.$( 'TextHighlight' ),
children: text,
className: highlightClassNames,
key: index,
style: highlightStyles,
};But that felt really silly for something that is just being passed directly to createElement two statements below.
sarayourfriend
force-pushed
the
fix/g2-context-types
branch
from
1e900ac to
1dc55c8
Compare
|
👍 from me! Thank you @saramarcondes + @sirreal 🙏 |
noisysocks
pushed a commit
that referenced
this pull request
Feb 2, 2021
* fix: Components types * Fix global process type and refine others
ItsJonQ
changed the title
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.
Description
Fix various G2 type problems
How has this been tested?
Typecheck.
Types of changes
Bug fixes
Checklist: