chore(docs): Be more vocal about not doing type checking #23397
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I hope this isn't too heavy-handed, but I think that philosophically, this plugin doesn't provide "support" for typescript at all, it just disables it. Typescript _is_ type checking! I admit I don't really understand the purpose of this plugin, but I'm aware of a great number of people who were tricked by this into thinking gatsby was doing type checking on build after installing this plugin.
skondrashov
changed the title
mawills
reviewed
Apr 23, 2020
| @@ -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). | |||
There was a problem hiding this comment.
I would even go so far as to bold the second sentence. This fact was a big pain point for my team.
There was a problem hiding this comment.
Why not run type-check as part of CI?
There was a problem hiding this comment.
you should! but this plugin doesn't do it
laurieontech
added
the
type: documentation
|
Thanks for the PR! Including something like this makes a lot of sense. And we'll be sure to remove it when the plugin functionality grows! |
|
Holy buckets, @tkondrashov — we just merged your PR to Gatsby! 💪💜 Gatsby is built by awesome people like you. Let us say “thanks” in two ways:
If there’s anything we can do to help, please don’t hesitate to reach out to us: tweet at @gatsbyjs and we’ll come a-runnin’. Thanks again! |
pvhee
added a commit
to marzeelabs/gatsby
that referenced
this pull request
Apr 24, 2020
* 'master' of github.com:gatsbyjs/gatsby: (64 commits) Fix recipe test problems (gatsbyjs#23347) create blog post announcing extended deadline for Virtual Gatsby Days… (gatsbyjs#23430) Correct CFP deadline date on Virtual Gatsby Days registration announcement (gatsbyjs#23432) fix(gatsby-recipes): Raise an error when an unknown resource is used (gatsbyjs#23428) feat(gatsby-recipes): While apply a step, show the time elapsed after 10 seconds (gatsbyjs#23362) markdownASTToHTMLAst isn't async (gatsbyjs#23427) Be more vocal about not doing type checking (gatsbyjs#23397) docs(gatsby-remark-images): mark `sizeByPixelDensity` as deprecated (gatsbyjs#23387) chore(all): Improve renovate (gatsbyjs#23411) chore(gatsby): count sift hits in telemetry (gatsbyjs#23416) chore(showcase): add GeneOS and COVID KPI (gatsbyjs#23405) feat(analytics): defer google analytics script (gatsbyjs#22806) docs: mention passing the .tsx file to createPage (gatsbyjs#23329) fix(www): tweak docsearch to init algolia when tabbed into (gatsbyjs#23040) chore(docs): Fix typo in url (gatsbyjs#23394) chore(gatsby-preset-gatsby-package): Remove tsconfig.json (gatsbyjs#23388) fix(gatsby-recipes): link to the raw gist of .estlintrc.js (gatsbyjs#23390) docs: Create gitlab-continuous-integration.md (gatsbyjs#23367) chore(doc): switch zeit now to Vercel Now for Gatsby deployment (gatsbyjs#23346) chore(showcase): add Resume on the Web (gatsbyjs#23371) ...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
I hope this isn't too heavy-handed, but I think that philosophically, this plugin doesn't provide "support" for typescript at all, it just disables it. Typescript is type checking! I admit I don't fully understand the scope of this plugin, but I'm aware of a great number of people on unrelated projects who thought gatsby was doing type checking on build after installing this plugin.
Documentation
This is it :)
Related Issues
Native TypeScript support #18983