tldraw/apps
alex f9ed1bf2c9
Force interface instead of type for better docs (#3815)
Typescript's type aliases (`type X = thing`) can refer to basically
anything, which makes it hard to write an automatic document formatter
for them. Interfaces on the other hand are only object, so they play
much nicer with docs. Currently, object-flavoured type aliases don't
really get expanded at all on our docs site, which means we have a bunch
of docs content that's not shown on the site.

This diff introduces a lint rule that forces `interface X {foo: bar}`s
instead of `type X = {foo: bar}` where possible, as it results in a much
better documentation experience:

Before:
<img width="437" alt="Screenshot 2024-05-22 at 15 24 13"
src="https://github.com/tldraw/tldraw/assets/1489520/32606fd1-6832-4a1e-aa5f-f0534d160c92">

After:
<img width="431" alt="Screenshot 2024-05-22 at 15 33 01"
src="https://github.com/tldraw/tldraw/assets/1489520/4e0d59ee-c38e-4056-b9fd-6a7f15d28f0f">


### Change Type

- [x] `sdk` — Changes the tldraw SDK
- [x] `docs` — Changes to the documentation, examples, or templates.
- [x] `improvement` — Improving existing features
2024-05-22 15:55:49 +00:00
..
apps-script google meet: add hardware whiteboard integration (#3765) 2024-05-20 14:52:05 +00:00
docs Force interface instead of type for better docs (#3815) 2024-05-22 15:55:49 +00:00
dotcom Force interface instead of type for better docs (#3815) 2024-05-22 15:55:49 +00:00
dotcom-asset-upload Bump the npm_and_yarn group group with 7 updates (#2982) 2024-03-04 12:20:23 +00:00
dotcom-bookmark-extractor bump typescript / api-extractor (#2949) 2024-02-25 11:43:17 +00:00
dotcom-worker Force interface instead of type for better docs (#3815) 2024-05-22 15:55:49 +00:00
examples Force interface instead of type for better docs (#3815) 2024-05-22 15:55:49 +00:00
health-worker Force interface instead of type for better docs (#3815) 2024-05-22 15:55:49 +00:00
huppy Force interface instead of type for better docs (#3815) 2024-05-22 15:55:49 +00:00
vscode Force interface instead of type for better docs (#3815) 2024-05-22 15:55:49 +00:00