atlassian / atlassian/extract-react-types

Prop opt out

Open
#141 1 comment 1 reaction 1 assignee Claimed by @danieldelcore View on GitHub
Dominant language
JavaScript
Stars
188
Forks
31
PR merge metrics
No merged PRs in 30d

Description

We are finding that our prop types are getting increasingly complex and sophisticated. At some point `extract-react-types` does not use the TypeScript compiler and it is not reasonable for it to understand the whole breadth of the language.

Can I suggest an opt out?

```ts
type Props = {
/* @readonly
….
*/
name: SomeSuperComplexType
}
```

Perhaps we could put some information in the jsdoc above a prop to tell `extract-react-types` to not bother trying to understand the type and just print it out as a raw string

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.