Skip to content

Commit 35c4a93

Browse files
authored
chore(docs): Clarify TS release doc (#35134)
1 parent e0f8815 commit 35c4a93

File tree

2 files changed

+10
-2
lines changed

2 files changed

+10
-2
lines changed

docs/docs/how-to/custom-configuration/typescript.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -273,9 +273,11 @@ Gatsby natively supports JavaScript and TypeScript, you can change files from `.
273273
- `gatsby-ssr.js` to `gatsby-ssr.tsx`
274274
- Address any of the [current limitations](#current-limitations)
275275

276+
If you've used other ways of using TypeScript in the past, you'll also want to read [migrating away from old workarounds](/docs/reference/release-notes/v4.9/#migrating-away-from-old-workarounds).
277+
276278
## Current limitations
277279

278-
There are some limitations currently that you need to be aware of. We'll do our best to mitigate them in our code or through contributions to upstream dependencies.
280+
There are some limitations currently that you need to be aware of. We'll do our best to mitigate them in our code, through contributions to upstream dependencies, and updates to our documentation.
279281

280282
### Parcel TypeScript features
281283

@@ -324,7 +326,7 @@ Progress on this is tracked in [Parcel #6925](https://github.com/parcel-bundler/
324326

325327
### Other
326328

327-
- Workspaces (e.g. Yarn) are not supported yet.
329+
- Workspaces (e.g. Yarn) are not supported. We'll add documentation on how to use this feature inside a workspace soon.
328330
- When changing `siteMetadata` in `gatsby-config` no hot-reloading will occur during `gatsby develop`. A restart is needed at the moment.
329331

330332
## Other Resources

docs/docs/reference/release-notes/v4.9/index.md

+6
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,12 @@ export const sourceNodes: GatsbyNode["sourceNodes"] = async ({
8080

8181
You can also check out the [using-typescript](https://github.com/gatsbyjs/gatsby/tree/master/examples/using-typescript) and [using-vanilla-extract](https://github.com/gatsbyjs/gatsby/tree/master/examples/using-vanilla-extract) examples!
8282

83+
### Migrating away from old workarounds
84+
85+
_This list is probably incomplete. If you've used another workaround in the past, add it to this document by using the "Edit on GitHub" button at the bottom._
86+
87+
- [`ts-node`](https://typestrong.org/ts-node/): By having both a `gatsby-config.js` and `gatsby-config.ts` (where `gatsby-config.js` registers `ts-node`) you were able to use TypeScript. You'll need to remove the `gatsby-config.js` file, `ts-node` dependency, and address any of the [current limitations](/docs/how-to/custom-configuration/typescript/#current-limitations). When both a `gatsby-config.js` and `gatsby-config.ts` exist the `.ts` file will now always take precedence.
88+
8389
## Notable bugfixes & improvements
8490

8591
- `gatsby`

0 commit comments

Comments
 (0)