Lint against strings without wrapping <Text>

[gaearon]

This adds a lint rule enforcing that JSX text has an immediate <Text> parent. There are a few nuances:

• It skips over <Trans> when looking upwards for <Text>. So <Text><Trans>text</Trans></Text> is OK.
• Aside from <Trans>, the parent has to be immediate. I.e. <Foo><Text>text</Text></Foo> is OK but <Text><Foo>text</Foo></Text> is not.
• It treats any component ending with -Text as a valid parent. E.g. <FooText>text</FooText> is OK. This is useful for the design system.
  • Our components don't currently follow this scheme so I also added a list of exceptions. I do want to narrow them down though. The advantage of the suffix is that we'll be able to lint for it too — i.e. we'd be able to enforce that a component named FooText must return Text. This would close the remaining loophole.
• It treats any prop called text (or ending with Text) as an implied guarantee it's wrapped. So <Foo bla={<Trans>hello</Trans>} /> is not OK but <Foo blaText={<Trans>hello</Trans>} /> is OK.
  • Our components don't currently follow this scheme so I also added a list of exceptions.
• Note that we don't validate literals. So <Foo>{'text'}</Foo> will pass despite being not OK. Only JSX text is validated. This leaves much less space for false positives, and is probably fine because we have to wrap stuff in <Trans> anyway.

This gets us pretty far.

Examples

Raw text in <View>

Raw text in a custom component

Raw text in a prop

[gaearon]

The goal is to get this list close to zero, maybe except H1..H6. For components that always return Text (e.g. links), I propose adding Text suffix and making the rule enforce that they actually return Text. Will need follow-up work.

[github-actions]

The Pull Request introduced fingerprint changes against the base commit: 8e393b1

Fingerprint diff

[
  {
    "type": "file",
    "filePath": "package.json",
    "reasons": [
      "expoConfigPlugins"
    ],
    "hash": "e63e4bc19f16de7405b22d617734da9061b47b13"
  }
]

---

Generated by PR labeler 🤖

[gaearon]

Don't forget to run yarn.

[github-actions]

Old size	New size	Diff
6.34 MB	6.34 MB	46 B (0.00%)

[haileyok]

Went through a bunch of test cases on this, works great. Really like the prop name idea as well.