tldraw/scripts
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
..
lib Better generated docs for react components (#3930) 2024-06-13 13:09:27 +00:00
vercel Don't check api.json files into git (#3565) 2024-04-24 15:58:26 +00:00
api-check.ts security: enforce use of our fetch function and its default referrerpolicy (#3884) 2024-06-11 13:59:25 +00:00
build-api.ts Composable custom UI (#2796) 2024-02-15 12:10:09 +00:00
build-package.ts [chore] update lazyrepo (#1211) 2023-05-02 12:25:26 +00:00
CHANGELOG.md transfer-out: transfer out 2023-04-25 12:01:25 +01:00
check-scripts.ts tldraw_final_v6_final(old version).docx.pdf (#2998) 2024-02-29 16:06:19 +00:00
check-tsconfigs.ts tldraw_final_v6_final(old version).docx.pdf (#2998) 2024-02-29 16:06:19 +00:00
clean.sh Fix yarn clean (#2620) 2024-01-24 16:36:24 +00:00
deploy.ts assets: make option to transform urls dynamically / LOD (#3827) 2024-06-11 14:17:09 +00:00
license-report.ts [internal] Add license report scripts (#2751) 2024-04-01 13:36:40 +00:00
lint.ts [dx] Allow vscode to search inside md files by default (#3105) 2024-03-11 14:08:04 +00:00
package.json Fix deploy script (#3550) 2024-04-22 15:33:25 +00:00
postpack.sh transfer-out: transfer out 2023-04-25 12:01:25 +01:00
prepack.ts use native structuredClone on node, cloudflare workers, and in tests (#3166) 2024-03-18 17:16:09 +00:00
prune-preview-deploys.ts Force interface instead of type for better docs (#3815) 2024-05-22 15:55:49 +00:00
publish-canary.ts [infra] fix canary dist tag (#3048) 2024-03-04 09:39:19 +00:00
publish-manual.ts [infra] Patch release scripting (#3072) 2024-03-05 16:05:22 +00:00
publish-new.ts [docs] Sync docs deploy with npm deploy (#3153) 2024-03-14 14:43:32 +00:00
publish-patch.ts Fix release eliding (#3156) 2024-03-14 15:41:55 +00:00
purge-css.ts [tweak] dark mode colors (#2469) 2024-01-14 16:27:16 +00:00
refresh-assets.ts Force interface instead of type for better docs (#3815) 2024-05-22 15:55:49 +00:00
tsconfig.json transfer-out: transfer out 2023-04-25 12:01:25 +01:00
typecheck.ts replace console.log with nicelog (#1496) 2023-06-01 18:01:49 +00:00
update-pr-template.ts [DX] PR labels revamp (#3112) 2024-03-12 14:53:57 +00:00