Skip to content

Commit 2e031e8

Browse files
docs: #226 document new minimum NodeJS version 22.18.0 (#233)
1 parent 0766b75 commit 2e031e8

3 files changed

Lines changed: 40 additions & 7 deletions

File tree

src/pages/docs/introduction/setup.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ tocHeading: 2
88

99
Greenwood has a few options for getting a new project started. You can also check out our [_Getting Started_ guide](/guides/getting-started/) for a full walk-through of creating a simple blog site with Greenwood.
1010

11+
Greenwood supports NodeJS LTS version >= 22.18.0.
12+
1113
## Init
1214

1315
The recommended way to start a new Greenwood project, our **init** CLI will scaffold out a starter project for you. Just run a single command and then follow the prompts. Make sure you have the [latest LTS version of Node](https://nodejs.org/en/download) installed.
@@ -87,3 +89,32 @@ The CLI supports three commands, that can be easily mapped to npm scripts in you
8789
</app-ctc-block>
8890

8991
<!-- prettier-ignore-end -->
92+
93+
## Troubleshooting
94+
95+
### Rollup Linux x64 GNU
96+
97+
<!-- if / when Greenwood bumps up Node 24, we can remove this message -->
98+
99+
If using npm, depending on the version, if you see an error like this in GitHub Actions or any hosting provider:
100+
101+
```shell
102+
Error: Cannot find module @rollup/rollup-linux-x64-gnu. npm has a bug related to optional dependencies (https://github.com/npm/cli/issues/4828). Please try `npm i` again after removing both package-lock.json and node_modules directory.
103+
```
104+
105+
Add [**@rollup/rollup-linux-x64-gnu**](https://www.npmjs.com/package/@rollup/rollup-linux-x64-gnu) as an [optional dependency to your _package.json_](https://stackoverflow.com/questions/79048814/github-action-is-failing-due-to-rollup-rollup-linux-x64-gnu):
106+
107+
<!-- prettier-ignore-start -->
108+
<app-ctc-block variant="snippet" heading="package.json">
109+
110+
```json
111+
{
112+
"optionalDependencies": {
113+
"@rollup/rollup-linux-x64-gnu": "^4.50.0"
114+
}
115+
}
116+
```
117+
118+
</app-ctc-block>
119+
120+
<!-- prettier-ignore-end -->

src/pages/docs/resources/typescript.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ Greenwood provides built-in support for TypeScript, either through type-strippin
1616

1717
The below steps will help you get up and running with TypeScript in your Greenwood project, and are the [same settings](https://github.com/ProjectEvergreen/greenwood/blob/master/packages/init/src/template-base-ts/tsconfig.json) you'll get running [Greenwood's **init** package with TypeScript enabled](/docs/introduction/setup/#init). The general recommendation is to use type-stripping during development for faster live reload, and then run TypeScript during CI (e.g. GitHub Actions) to check and enforce all types, e.g. `tsc --project tsconfig.json`.
1818

19-
1. You will need to use Node **>= 22.6.0** and set the `--experimental-strip-types` flag
2019
1. Install TypeScript into your project, e.g. `npm i typescript --save-dev`
2120
1. Create a _tsconfig.json_ file at the root of your project with the below minimum configuration settings.
2221
1. We also recommend additional configurations like [`verbatimModuleSyntax`](https://www.typescriptlang.org/tsconfig/#verbatimModuleSyntax) and [`erasableSyntaxOnly` setting](https://www.typescriptlang.org/tsconfig/#erasableSyntaxOnly)
@@ -49,8 +48,6 @@ The below steps will help you get up and running with TypeScript in your Greenwo
4948

5049
<!-- prettier-ignore-end -->
5150

52-
> _If you're feeling adventurous, you can use **>=23.x** and omit the `--experimental-strip-types` flag_. Keep an eye on [this PR](https://github.com/nodejs/node/pull/57298) for when unflagged type-stripping support may come to Node LTS **22.x**. 👀
53-
5451
## Types
5552

5653
### Configuration

src/pages/guides/getting-started/index.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,14 @@ This _Getting Started_ guide will walk you through creating a basic static conte
2020

2121
You will need the following installed on your machine:
2222

23-
1. [**NodeJS LTS**](https://nodejs.org/en/download) (required) - We recommend using a Node version manager (like NVM) to install the latest stable version of Node
24-
1. [**Git**](https://git-scm.com/) (optional) - Can be useful for [cloning and inspecting](https://github.com/ProjectEvergreen/greenwood-getting-started) the companion repo for this guide, or otherwise managing your Greenwood project through version control
23+
1. Latest [**NodeJS LTS**](https://nodejs.org/en/download) version (required) - We recommend using a Node version manager (like [**NVM**](https://github.com/nvm-sh/nvm)) to manage local node installations.
24+
1. [**Git**](https://git-scm.com/) (optional) - Can be useful for [cloning and inspecting](https://github.com/ProjectEvergreen/greenwood-getting-started) the companion repo for this guide, or otherwise managing your Greenwood project through version control.
2525

2626
You can verify that NodeJS has been installed correctly by checking its version from the command line:
2727

2828
```bash
2929
$ node -v
30-
v22.13.0
30+
v22.18.0
3131
```
3232

3333
## Setup
@@ -85,12 +85,17 @@ Then setup some npm scripts in your _package.json_ for running Greenwood and mak
8585

8686
<!-- prettier-ignore-end -->
8787

88-
## Jump Right In
88+
<!-- Looking for Stackblitz alternatives -->
89+
<!-- https://github.com/ProjectEvergreen/www.greenwoodjs.dev/discussions/248 -->
90+
91+
<!-- ## Jump Right In
8992
9093
If you want to jump to the final results right away, you can browse [the companion repo](https://github.com/ProjectEvergreen/greenwood-getting-started) or play around with it directly in your browser on [Stackblitz](https://stackblitz.com/github/projectevergreen/greenwood-getting-started).
9194
9295
<iframe class="stackblitz" src="https://stackblitz.com/github/projectevergreen/greenwood-getting-started?embed=1" loading="lazy"></iframe>
9396
97+
-->
98+
9499
## Next Section
95100

96101
With that all out of the way, let's move onto the [next section](/guides/getting-started/key-concepts/).

0 commit comments

Comments
 (0)