no-unnecessary-components: Add support for Text size and weight, and improve spread object typechecking
#210
Conversation
|
| // Check if the spread type has a string index signature - this could hide an allowed property | ||
| if (typeChecker.getIndexTypeOfType(spreadType, IndexKind.String) !== undefined) return |
There was a problem hiding this comment.
I switched these checks around since theoretically getIndexOfType should be slightly faster than getPropertiesOfType so we can potentially short-circuit a little bit faster and save some time.
|
This PR can safely skip changeset since it will go out in the same release as the PR that created the rule |
After primer/react#4834,
<Text size="..." />and<Text weight="..." />are valid uses of theTextcomponent. But theno-unnecessary-componentsrule is currently only checking forsxand styled-system props, so these would get flagged.This PR fixes that by adding a set of "allowed" props to each component. If any of these props are used, the component is considered valid. Also adds tests for this.
In addition, this PR improves the spread props typechecking: instead of just checking for allowed props, we extract all the property names, then check if each one is allowed. Because we don't have access to an array of styled-system property names, this is the only way to check for styled-system props in the spread props object -- something we weren't doing at all before. So this should make the rule slightly more accurate for a rare edge case, and also makes the code cleaner.