Merge pull request #524 from msutkowski/docs/ts-clarification

Docs: TypeScript docs updates

README.md

@@ -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) or [nvm-windows](https://github.com/coreybutler/nvm-windows).
+
 Then build the tutorial and doc pages (after you've installed all dependencies with `yarn install`):
 
     yarn build

docs/typescript.md

@@ -1,6 +1,5 @@
 # Typescript
 
-
 > TypeScript support is in development: The ability to use TypeScript is one of our main points of focus, check out our [TypeScript Project Board](https://github.com/redwoodjs/redwood/projects/2) to follow the progress.
 
 Redwood does not use the TypeScript compiler; instead, we use babel, which strips out the types before transpiling them.
@@ -12,6 +11,7 @@ Redwood does not use the TypeScript compiler; instead, we use babel, which strip
 ### API
 
 Create a `./api/tsconfig.json` file:
+
 ```json
 {
   "compilerOptions": {
@@ -25,9 +25,10 @@ Create a `./api/tsconfig.json` file:
     "paths": {
       "src/*": ["./src/*"]
     },
-    "typeRoots": ["../.redwood"]
+    "typeRoots": ["../.redwood"],
+    "types": []
   },
-  "include": ["src"],
+  "include": ["src"]
 }
 ```
 
@@ -36,6 +37,7 @@ You should now have type definitions, you can rename your files from `.js` to `.
 ### WEB
 
 Create a `./web/tsconfig.json` file:
+
 ```json
 {
   "compilerOptions": {
@@ -50,12 +52,24 @@ Create a `./web/tsconfig.json` file:
     "paths": {
       "src/*": ["./src/*"]
     },
-    "typeRoots": ["../.redwood"]
+    "typeRoots": ["../.redwood"],
+    "types": []
   },
-  "include": ["src"],
+  "include": ["src"]
 }
 ```
 
 You should now have type definitions, you can rename your files from `.js` to `.ts`, and the files that contain JSX to `.tsx`.
 
+#### Getting types for `jest` in test files
+
+If you're adding tests, you'll want to include the types for `jest` in your `tsconfig`.
+
+```diff
+-"types": []
++"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 `yarn add -D @types/jest` in the `web` folder and they will resolve.
+
 If you have any problems please open an issue and let us know.