chore: introduce zx, corepack and setup script (#2754)

* chore: introduce corepack and setup script

* update docs

* Update lock

* Delete catch

* Add readme

* Improve readme

* Improve readme

* Improve readme

Author: hyf0

CONTRIBUTING.md

@@ -75,6 +75,14 @@ nvm alias default 16
 nvm use 16
 ```
 
+#### Running setup script
+
+Make sure you are under the workspace root
+
+```bash
+node ./scripts/meta/setup.mjs
+```
+
 #### Install Dependencies
 
 Install Node.js dependencies via [pnpm](https://pnpm.io/).

package.json

@@ -29,6 +29,7 @@
     "bump": "changeset version",
     "changeset": "changeset",
     "prepare": "is-ci || husky install",
+    "pnpm:devPreinstall": "is-ci || node ./scripts/meta/doctor.mjs",
     "test:example": "pnpm --filter \"example-*\" build",
     "test:unit": "pnpm --filter \"@rspack/*\" test",
     "test:e2e": "pnpm --filter \"@rspack-e2e/*\" test"

scripts/.gitignore

@@ -0,0 +1 @@
+node_modules

scripts/README.md

@@ -0,0 +1,23 @@
+Scripts here are related to development workflow of Rspack.
+
+## Usages
+
+```bash
+node ./scripts/xxxx.js
+```
+
+- Some scripts require executing under the folder of workspace root. Don't worries, they would validate the environment while executing.
+
+## Guidance
+
+### Writting scripts with zx
+
+[zx](https://github.com/google/zx) is a wonderful tool for writting scripts using JavaScript.
+
+There are many [ways](https://github.com/google/zx#documentation) to use zx. The way we recommended is import globals explicitly.
+
+```js
+import "zx/globals";
+```
+
+This allow us to execute every script(some of them might not use zx) in this folder by using the same way: `node ./scripts/xxxx.js`

scripts/build-npm.js

@@ -1,3 +1,4 @@
+// @ts-nocheck
 const path = require("path");
 const fs = require("fs");
 const assert = require("assert");

scripts/check_changeset.js

@@ -1,3 +1,4 @@
+// @ts-nocheck
 const { spawnSync } = require("child_process");
 const path = require("path");
 const util = require("util");

scripts/check_rust_dependency.js

@@ -1,3 +1,4 @@
+// @ts-nocheck
 const path = require("path");
 const fs = require("fs");
 const child_process = require("child_process");

scripts/cmd.js

@@ -1,3 +1,4 @@
+// @ts-nocheck
 const cp = require("child_process");
 const log = require("./log");
 const { Command } = require("commander");

scripts/log.js

@@ -1,3 +1,4 @@
+// @ts-nocheck
 const PREFIX = "[x] ";
 
 const COLOR = {

scripts/meta/doctor.mjs

@@ -0,0 +1 @@
+console.log("Yeah. Doctor here.");