Skip to content

Commit

Permalink
chore(docs): Clarify TS release doc (#35134)
Browse files Browse the repository at this point in the history
  • Loading branch information
LekoArts committed Mar 15, 2022
1 parent e0f8815 commit 35c4a93
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/docs/how-to/custom-configuration/typescript.md
Expand Up @@ -273,9 +273,11 @@ Gatsby natively supports JavaScript and TypeScript, you can change files from `.
- `gatsby-ssr.js` to `gatsby-ssr.tsx`
- Address any of the [current limitations](#current-limitations)

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).

## Current limitations

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.
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.

### Parcel TypeScript features

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

### Other

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

## Other Resources
Expand Down
6 changes: 6 additions & 0 deletions docs/docs/reference/release-notes/v4.9/index.md
Expand Up @@ -80,6 +80,12 @@ export const sourceNodes: GatsbyNode["sourceNodes"] = async ({

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!

### Migrating away from old workarounds

_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._

- [`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.

## Notable bugfixes & improvements

- `gatsby`
Expand Down

0 comments on commit 35c4a93

Please sign in to comment.