tldraw/scripts/lib
alex 6cb797a074
Better generated docs for react components (#3930)
Before:
![Screenshot 2024-06-12 at 12 57
26](https://github.com/tldraw/tldraw/assets/1489520/2a9f6098-ef2a-4f52-88f5-d6e4311c067d)

After:
![Screenshot 2024-06-12 at 12 59
16](https://github.com/tldraw/tldraw/assets/1489520/51733c2a-a2b4-4084-a89a-85bce5b47672)

React components in docs now list their props, and appear under a new
"Component" section instead of randomly under either `Function` or
`Variable`. In order to have our docs generate this, a few criteria need
to be met:
1. They need to be tagged with the `@react` tsdoc tag
2. Their props need to be a simple type alias, typically to an
interface.

Both of these rules are enforced with a new lint rule - any component
tagged as `@public` will have these rules enforced.

### Change Type

- [x] `docs` — Changes to the documentation, examples, or templates.
- [x] `improvement` — Improving existing features
2024-06-13 13:09:27 +00:00
..
add-extensions.ts transfer-out: transfer out 2023-04-25 12:01:25 +01:00
didAnyPackageChange.ts Fix patch release script (#3597) 2024-04-24 15:52:57 +00:00
eslint-plugin.ts Better generated docs for react components (#3930) 2024-06-13 13:09:27 +00:00
exec.ts Force interface instead of type for better docs (#3815) 2024-05-22 15:55:49 +00:00
file.ts allow changes 2024-02-29 18:09:30 +00:00
labels.ts Force interface instead of type for better docs (#3815) 2024-05-22 15:55:49 +00:00
makeEnv.ts unbrivate, dot com in (#2475) 2024-01-16 14:38:05 +00:00
nicelog.ts unbrivate, dot com in (#2475) 2024-01-16 14:38:05 +00:00
publishing.ts Force interface instead of type for better docs (#3815) 2024-05-22 15:55:49 +00:00
sort-unions.ts New migrations again (#3220) 2024-04-15 12:53:42 +00:00
workspace.ts Force interface instead of type for better docs (#3815) 2024-05-22 15:55:49 +00:00