Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore(docs): Be more vocal about not doing type checking #23397

Merged
merged 1 commit into from
Apr 23, 2020
Merged

chore(docs): Be more vocal about not doing type checking #23397

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion packages/gatsby-plugin-typescript/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# gatsby-plugin-typescript

Provides drop-in support for TypeScript and TSX.
Allows Gatsby to build TypeScript and TSX files. Does NOT run type checking during build (see Caveats).
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would even go so far as to bold the second sentence. This fact was a big pain point for my team.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not run type-check as part of CI?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you should! but this plugin doesn't do it


## Install

Expand All @@ -10,6 +10,7 @@ Provides drop-in support for TypeScript and TSX.

1. Include the plugin in your `gatsby-config.js` file.
1. Write your components in TSX or TypeScript.
1. Run TypeScript directly or with a build tool.
1. You're good to go.

`gatsby-config.js`
Expand Down