Clarify supported node versions across project (wpengine#1409)

* Chore: Add Engines in package.json and updated Readme. * Chore: Changeset
WebDevStudios · May 5, 2023 · 200bdb8 · 200bdb8
1 parent 854ecea
commit 200bdb8
Show file tree

Hide file tree

Showing 7 changed files with 38 additions and 3 deletions.
diff --git a/.changeset/silent-eagles-enjoy.md b/.changeset/silent-eagles-enjoy.md
@@ -0,0 +1,7 @@
+---
+'@faustwp/blocks': patch
+'@faustwp/cli': patch
+'@faustwp/core': patch
+---
+
+Add min engines declaration in package.json
diff --git a/README.md b/README.md
@@ -26,6 +26,11 @@ Faust.js aims to be framework agnostic, so it can be used with any front-end fra
 
 As we work towards our first release, we will be introducing support for other frameworks.
 
+## System Requirements
+
+- Node.js v16.0.0 or newer (v16.8.0 when using Next.js 13).
+- MacOS, Windows (including WSL), and Linux are supported.
+
 ## Documentation
 
 Visit [https://faustjs.org/docs/getting-started](https://faustjs.org/docs/getting-started) to view the full documentation.

diff --git a/examples/next/faustwp-getting-started/package.json b/examples/next/faustwp-getting-started/package.json
@@ -20,5 +20,9 @@
     "react": "^17.0.2",
     "react-dom": "^17.0.2",
     "sass": "^1.54.9"
+  },
+  "engines": {
+    "node": ">=16",
+    "npm": ">=8"
   }
 }
diff --git a/internal/faustjs.org/docs/getting-started.mdx b/internal/faustjs.org/docs/getting-started.mdx
@@ -5,6 +5,13 @@ title: Getting Started with Faust
 
 # Getting Started with Faust
 
+## System Requirements
+
+First, make sure your development environment meets the following requirements:
+
+- Node.js v16.0.0 or newer (v16.8.0 when using Next.js 13).
+- MacOS, Windows (including WSL), and Linux are supported.
+
 ## Quick Start
 
 To create a Faust project, run:

diff --git a/packages/blocks/package.json b/packages/blocks/package.json
@@ -41,5 +41,9 @@
   "bugs": {
     "url": "https://github.com/wpengine/faustjs/issues"
   },
-  "homepage": "https://github.com/wpengine/faustjs#readme"
+  "homepage": "https://github.com/wpengine/faustjs#readme",
+  "engines": {
+    "node": ">=16",
+    "npm": ">=8"
+  }
 }
diff --git a/packages/faustwp-cli/package.json b/packages/faustwp-cli/package.json
@@ -46,5 +46,9 @@
   "bugs": {
     "url": "https://github.com/wpengine/faustjs/issues"
   },
-  "homepage": "https://github.com/wpengine/faustjs#readme"
+  "homepage": "https://github.com/wpengine/faustjs#readme",
+  "engines": {
+    "node": ">=16",
+    "npm": ">=8"
+  }
 }
diff --git a/packages/faustwp-core/package.json b/packages/faustwp-core/package.json
@@ -69,5 +69,9 @@
   "bugs": {
     "url": "https://github.com/wpengine/faustjs/issues"
   },
-  "homepage": "https://github.com/wpengine/faustjs#readme"
+  "homepage": "https://github.com/wpengine/faustjs#readme",
+  "engines": {
+    "node": ">=16",
+    "npm": ">=8"
+  }
 }