Add typescript plugin #1211
Add typescript plugin #1211
Conversation
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/pikapkg/snowpack/mirgrxf5o |
| ['WORKER_MSG', {level: 'log', msg: 'TEST_CLEAR_MESSAGE'}], | ||
| ]); | ||
| }); | ||
| }); |
| function typescriptPlugin() { | ||
| return { | ||
| name: '@snowpack/plugin-typescript', | ||
| async run({isDev, log}) { |
There was a problem hiding this comment.
I’m really liking the evolution of this humble run() method. On the one hand, it’s just a wrapper around a CLI command. But on the other, it does provide a pretty clean experience to leverage libraries without Snowpack having to do to much. I’m into it!
| @@ -35,6 +35,7 @@ For starter apps and templates, see [create-snowpack-app](./create-snowpack-app) | |||
| ### Dev Environment | |||
|
|
|||
| - [@snowpack/plugin-dotenv](./plugins/plugin-dotenv) | |||
| - [@snowpack/plugin-typescript](./plugins/plugin-typescript) | |||
There was a problem hiding this comment.
Is this more of a “build” plugin (not in method called, but to the user)?
There was a problem hiding this comment.
Since this is only doing type checking, it felt like a "dev environment" plugin. Maybe make this more clear? Maybe add a new "Lint" section?
| return { | ||
| name: '@snowpack/plugin-typescript', | ||
| async run({isDev, log}) { | ||
| const workerPromise = execa.command(`tsc --noEmit ${isDev ? '--watch' : ''}`, { |
There was a problem hiding this comment.
Would you like to use the programmatic API instead of parsing the output?
There was a problem hiding this comment.
Not opposed to the JS API, but in the past I know that the project has always treated the JS API as secondary to the CLI itself.
On top of that, the CLI gives us the formatted output for free. Since the dev console just wants formatted output and a simple pass/fail, the tsc CLI is enough for our use-case and lets the tsc CLI handle all of the complexity of config loading, file watching, etc.
There was a problem hiding this comment.
So tsc is only used for type checking, not file emitting?
There was a problem hiding this comment.
reading over the README, we could probably make that difference even more clear
There was a problem hiding this comment.
Oh I noticed the --noEmit. IMO it's a bit wasty to use multiple tool to parse the source code. In my project I mainly don't use babel and do everything only with TypeScript compiler.
There was a problem hiding this comment.
If you wanted to build a typescript build plugin, that would be exciting to see!
Snowpack doesn't run the TypeScript compiler as a part of the default build step, we use esbuild which can parse TS code successfully. So this plugin only exists to do that typechecking for you.
Changes
Testing
Docs