Documentation about ts in snowpack is WAAAY too sparse.

[Johnrobmiller]

Given how great of a build tool Snowpack is, I wish that it were published with a more detailed documentation, especially when it comes to getting Typescript up and running.

In my project, trying to use the "@snowpack/plugin-typescript" plugin out of the box gives the difficult-to-decipher error:

• [@snowpack/plugin-typescript] Command exited with error code: Error: Command failed with exit code 1: tsc --noEmit --watch

From my point of view as someone who is new to all of this, the obvious thing to do here might be to simply google "snowpack typescript ts" to look for instructions on how to get this up and running... Unfortunately, as of 1/31/20, I could not find anything useful. A more thorough documentation might definitely be able to save people like me a bit of frustration.

[David-Else]

Version 2.x worked out of the box with TypeScript, no need to install any plugins. I think "@snowpack/plugin-typescript" is set-up automatically for you when you use a template. I used:

npx create-snowpack-app [name-of-directory-for-app] --template @snowpack/app-template-blank-typescript

Unless you have an unusual build requirement, the new version 3 should be able to create a fully minified optimized production build all out of the box. The only thing missing is source maps, BUT they have been promised for the next release :)

[Johnrobmiller]

David, thank you for your response.

Unless you have an unusual build requirement

React and Typescript

Version 2.x worked out of the box with TypeScript, no need to install any plugins.

When I first tried using typescript out-of-the-box, I remember that I tried a) following the instructions in this link (https://www.snowpack.dev/tutorials/react), and then b) making a simple React component using the .tsx file extention. Then, when running it via "npm start", I ran into a dependency error. If this is because of a bug, then the negative claims I have made about the sparseness of the documentation are not valid. However, if this is because I was supposed to have installed additional plugins, then, understandably so, one might see why I am frustrated with the documentation and tutorial pages for failing to mention these things.

I think "@snowpack/plugin-typescript" is set-up automatically for you when you use a template

In a figurative way, I think this summarizes the reason why I posted this thread to begin with. If "@snowpack/plugin-typescript" is not set-up automatically (without using a Template), then there needs to be instructions written on how to configure it. Furthermore, these instructions need to be easily discoverable on the "npmjs.com/..." page that houses the plugin.

I installed the correct template and everything works fine now, so I am thankful for that. However, there is still more to say here. When new users try snowpack for the first time, there are certain pages that they tend to find themselves on, such as the tutorial linked above. This tutorial mentions templates, but I wish it were more explicit about what they are, why they are useful, and how to install them. Furthermore, the GIT pages' "README.md" files do not do this either, but they really ought to. These onboarding pages are very important in terms of getting the word out about templates. If new users do not learn about templates there, then where else would they learn them?

[David-Else]

I hear what you are saying. I think the templates are very important and should be the basis of all the tutorials and general usage instructions.

Once the user knows they exist then they will use them by default. Looking at the opening page https://www.snowpack.dev/ it doesn't mention that there are 'create react app' style templates for setting everything up, this is MASSIVE and needs to be stated upfront.

Out-of-the-box support
Enjoy Snowpack's built-in support for JSX, TypeScript, React, Preact, CSS Modules and more.

could read something like:

Out-of-the-box support
Using 'create react app' style templates you can instantly configure your project. Enjoy built-in support for JSX, TypeScript, React, Preact, Svelte, Vue, CSS Modules and more.

[melissamcewen]

I agree, I think we were trying to figure out CSA's future and how to handle examples in the repo and we got like 25% there without committing one way or another.

I will flag this as an issue and try to see if I can work on it soon.

[melissamcewen]

Hi @Johnrobmiller I totally agree. I will push to get a typescript starting guide/tutorial out.

[Johnrobmiller]

👍Thank you!