Docs: TypeScript docs updates #524
Conversation
README.md
Outdated
| @@ -10,6 +10,8 @@ Other documentation is pulled from various READMEs in the main [redwoodjs/redwoo | |||
|
|
|||
| This codebase is built with https://cameronjs.com and relies on plain HTML pages and Javascript with a couple helpers built in to abstract things like partials and layouts. We use https://stimulusjs.org for the few sprinkles of interactivity throughout the site. | |||
|
|
|||
| First, make sure that you are running Node 14+. If you're not sure of how to manage your node versions, see [nvm](https://github.com/nvm-sh/nvm). | |||
There was a problem hiding this comment.
Maybe mention https://github.com/coreybutler/nvm-windows for windows users. Unfortunately I haven't used it myself, so I can't vouch for it.
There was a problem hiding this comment.
I can vouch that it works as I do use it myself, but I figured someone would've made their way down that rabbit hole.
Just an FYI, the only major difference is that the node version is set globally when using nvm-windows, unlike normal nvm where it's per shell 😓
docs/typescript.md
Outdated
| +"types": ["jest"] | ||
| ``` | ||
|
|
||
| Currently, these are added to `node_modules` by `@redwoodjs/core` and the above approach should just work. If this is not the case, you can `npm i -D @types/jest` in the `web` folder and they will resolve. |
There was a problem hiding this comment.
Should we use yarn instead of npm here?
There was a problem hiding this comment.
Noted and updated!
There was a problem hiding this comment.
also might be worth saying tsconfig in web or api as we make two and you want to make sure they put it in the right place.
There was a problem hiding this comment.
@burnsy Thanks for the feedback! This is under the WEB section, but I guess it wouldn't hurt to add additional clarification language?
It might be a good idea to just add in a quick cli generator for tsconfigs that adds to the root and extends in the respective directories for overrides? I'm not sure if that's already a thing in the TS support meta tracker though.
|
@msutkowski Thanks for this! Great input 👍 I just left a couple of comments. @peterp can you have a look as well please? |
Just to follow up on this - I went down the 🐰 🕳️ of the TS repo trying to figure out what actually happens with this change... and long story short is that it probably doesn't matter. Any TS user is going to include additional types (as shown with the Jest comment) , but maybe I'm wrong :D . If I am, please let me know, thanks! 🎉 |
jestThere is an additional issue here when working with scaffolded code and the file structure, but I don't know if it is worth addressing with this PR. redwoodjs/redwood#234 (comment) regarding the DirectoryName convention. TS users would just have to:
index.tstosrc/components/WhateverComponent'export { default as default } from './WhateverComponent'As a side note, I didn't see any specific plan for handling this in the tracking issue: redwoodjs/redwood#523
Thanks!