@webiny/system-requirements 5.42.0-beta.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Webiny
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,6 @@
+# `@webiny/system-requirements`
+
+This package contains utilities for checking system requirements for Webiny projects.
+
+> [!NOTE]
+> This package is included in every Webiny project by default, and it's not meant to be used as a standalone package.

package/SystemRequirements.js

@@ -0,0 +1,77 @@
+const semver = require("semver");
+const execa = require("execa");
+const constraints = require("./constraints.json");
+
+class SystemRequirements {
+    static validate() {
+        const nodeVersion = SystemRequirements.getNodeVersion();
+        const yarnVersion = SystemRequirements.getYarnVersion();
+        const npmVersion = SystemRequirements.getNpmVersion();
+        const npxVersion = SystemRequirements.getNpxVersion();
+
+        const systemRequirements = {
+            valid: false,
+            node: {
+                currentVersion: nodeVersion,
+                requiredVersion: constraints.node,
+                valid: semver.satisfies(nodeVersion, constraints.node)
+            },
+            npm: {
+                currentVersion: npmVersion,
+                requiredVersion: constraints.npm,
+                valid: semver.satisfies(npmVersion, constraints.npm)
+            },
+            npx: {
+                currentVersion: npxVersion,
+                requiredVersion: constraints.npx,
+                valid: semver.satisfies(npxVersion, constraints.npx)
+            },
+            yarn: {
+                currentVersion: yarnVersion,
+                requiredVersion: constraints.yarn,
+                valid: semver.satisfies(yarnVersion, constraints.yarn)
+            }
+        };
+
+        systemRequirements.valid =
+            systemRequirements.node.valid &&
+            systemRequirements.npm.valid &&
+            systemRequirements.npx.valid &&
+            systemRequirements.yarn.valid;
+
+        return systemRequirements;
+    }
+
+    static getNodeVersion() {
+        return process.versions.node;
+    }
+
+    static getNpmVersion() {
+        try {
+            const { stdout } = execa.sync("npm", ["--version"]);
+            return stdout;
+        } catch (err) {
+            return "";
+        }
+    }
+
+    static getNpxVersion() {
+        try {
+            const { stdout } = execa.sync("npx", ["--version"]);
+            return stdout;
+        } catch (err) {
+            return "";
+        }
+    }
+
+    static getYarnVersion() {
+        try {
+            const { stdout } = execa.sync("yarn", ["--version"]);
+            return stdout;
+        } catch (err) {
+            return "";
+        }
+    }
+}
+
+module.exports = { SystemRequirements };

package/constraints.json

@@ -0,0 +1,6 @@
+{
+  "npm": ">=10",
+  "npx": ">=10",
+  "yarn": ">=1.22.21 || >=3",
+  "node": ">=20"
+}

package/ensureSystemRequirements.js

@@ -0,0 +1,93 @@
+const ensureSystemRequirements = () => {
+    // Just in case, we want to allow users to skip the system requirements check.
+    const skipSystemRequirementsCheck = process.argv.includes("--no-system-requirements-check");
+    if (skipSystemRequirementsCheck) {
+        return;
+    }
+
+    const { SystemRequirements } = require("./SystemRequirements");
+
+    const systemRequirements = SystemRequirements.validate();
+    if (systemRequirements.valid) {
+        return;
+    }
+
+    const chalk = require("chalk");
+
+    console.log(
+        [
+            "One or more system requirements are not met.",
+            "Please make sure to install the required versions of the following tools:"
+        ].join("\n\n")
+    );
+
+    const Table = require("cli-table3");
+
+    // Create a table instance
+    const table = new Table({
+        head: ["", "Current version", "Required version", "Valid"],
+        style: { head: ["bold"] },
+        colWidths: [10, 20, 20, 10]
+    });
+
+    const IS_VALID_TEXT = `${chalk.green("\u2713")} Yes`;
+    const IS_INVALID_TEXT = `${chalk.red("\u2717")} No`;
+
+    // Define the rows
+    const { node, npm, npx, yarn } = systemRequirements;
+
+    const rows = [
+        [
+            "Node.js",
+            node.currentVersion,
+            node.requiredVersion,
+            node.valid ? IS_VALID_TEXT : IS_INVALID_TEXT
+        ].map(v => {
+            return node.valid ? v : chalk.red(v);
+        }),
+        [
+            "NPM",
+            npm.currentVersion,
+            npm.requiredVersion,
+            npm.valid ? IS_VALID_TEXT : IS_INVALID_TEXT
+        ].map(v => {
+            return npm.valid ? v : chalk.red(v);
+        }),
+        [
+            "NPX",
+            npx.currentVersion,
+            npx.requiredVersion,
+            npx.valid ? IS_VALID_TEXT : IS_INVALID_TEXT
+        ].map(v => {
+            return npx.valid ? v : chalk.red(v);
+        }),
+        [
+            "Yarn",
+            yarn.currentVersion,
+            yarn.requiredVersion,
+            yarn.valid ? IS_VALID_TEXT : IS_INVALID_TEXT
+        ].map(v => {
+            return yarn.valid ? v : chalk.red(v);
+        })
+    ];
+
+    // Add rows to the table
+    rows.forEach(row => table.push(row));
+
+    // Print the table to the console
+    console.log(table.toString());
+
+    console.log(
+        [
+            "If you think this is a mistake, you can also try skipping",
+            "the system requirements checks by appending the",
+            `${chalk.red("--no-system-requirements-check")} flag.`
+        ].join(" ")
+    );
+
+    console.log();
+    console.log("For more information, please visit https://webiny.link/prerequisites.");
+    process.exit();
+};
+
+module.exports = { ensureSystemRequirements };

package/index.js

@@ -0,0 +1,4 @@
+const { SystemRequirements } = require("./SystemRequirements");
+const { ensureSystemRequirements } = require("./ensureSystemRequirements");
+
+module.exports = { SystemRequirements, ensureSystemRequirements };

package/package.json

@@ -0,0 +1,27 @@
+{
+	"name": "@webiny/system-requirements",
+	"version": "5.42.0-beta.0",
+	"main": "index.js",
+	"bin": {
+		"webiny": "./bin.js"
+	},
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/webiny/webiny-js.git",
+		"directory": "packages/cli"
+	},
+	"author": "Webiny Ltd.",
+	"description": "Contains utilities for checking system requirements for Webiny projects",
+	"dependencies": {
+		"chalk": "4.1.2",
+		"cli-table3": "0.6.5",
+		"execa": "5.1.1",
+		"semver": "7.6.3"
+	},
+	"license": "MIT",
+	"publishConfig": {
+		"access": "public",
+		"directory": "."
+	},
+	"gitHead": "ebf90f62ed3f28114ffdb012b7e5f80988af53d3"
+}