adjust pull-request contribution instructions (#1872)

README.md

@@ -44,12 +44,13 @@ We welcome contributions via pull requests! Here are some guidelines to help you
 3. Ensure you have the required dependencies installed by running: `pnpm install` (assuming pnpm version `8.x`).
 4. Make your desired changes and, if applicable, include tests to validate your modifications.
 5. Run the following commands to ensure the integrity of your changes:
+   - `pnpm codegen`: Re-generate the package entrypoints in case you have changed the structure of a package or introduced a new module.
    - `pnpm check`: Verify that the code compiles.
    - `pnpm test`: Execute the tests.
    - `pnpm circular`: Confirm there are no circular imports.
    - `pnpm lint`: Check for code style adherence (if you happen to encounter any errors during this process, you can use `pnpm lint-fix` to automatically fix some of these style issues).
    - `pnpm dtslint`: Run type-level tests.
-   - `pnpm docgen`: Update the automatically generated documentation.
+   - `pnpm docgen`: Check the integrity of the generated documentation.
 6. Create a changeset for your changes: before committing your changes, create a changeset to document the modifications. This helps in tracking and communicating the changes effectively. To create a changeset, run the following command: `pnpm changeset`. Always choose the `patch` option when prompted (please note that we are currently in pre-release mode).
 7. Commit your changes: after creating the changeset, commit your changes with a descriptive commit message: `git commit -am 'Add some feature'`.
 8. Push your changes to your fork: `git push origin my-new-feature`.

package.json

@@ -7,6 +7,7 @@
   ],
   "scripts": {
     "clean": "node scripts/clean.mjs",
+    "codegen": "pnpm --recursive --parallel run codegen",
     "build": "tsc -b tsconfig.build.json && pnpm --recursive --parallel run build",
     "circular": "madge --extensions ts --circular --no-color --no-spinner packages/*/src",
     "test": "vitest",

packages/cli/package.json

@@ -28,8 +28,8 @@
     "directory": "dist"
   },
   "scripts": {
-    "build": "pnpm build-prepare && pnpm build-esm && pnpm build-cjs && pnpm build-annotate && build-utils pack-v2",
-    "build-prepare": "build-utils prepare-v2",
+    "codegen": "build-utils prepare-v2",
+    "build": "pnpm codegen && pnpm build-esm && pnpm build-cjs && pnpm build-annotate && build-utils pack-v2",
     "build-esm": "tsc -b tsconfig.build.json",
     "build-cjs": "babel build/esm --plugins @babel/transform-export-namespace-from --plugins @babel/transform-modules-commonjs --out-dir build/cjs --source-maps",
     "build-annotate": "babel build --plugins annotate-pure-calls --out-dir build --source-maps",

packages/effect/package.json

@@ -28,8 +28,8 @@
     "directory": "dist"
   },
   "scripts": {
-    "build": "pnpm build-prepare && pnpm build-esm && pnpm build-cjs && pnpm build-annotate && build-utils pack-v2",
-    "build-prepare": "build-utils prepare-v2",
+    "codegen": "build-utils prepare-v2",
+    "build": "pnpm codegen && pnpm build-esm && pnpm build-cjs && pnpm build-annotate && build-utils pack-v2",
     "build-esm": "tsc -b tsconfig.build.json",
     "build-cjs": "babel build/esm --plugins @babel/transform-export-namespace-from --plugins @babel/transform-modules-commonjs --out-dir build/cjs --source-maps",
     "build-annotate": "babel build --plugins annotate-pure-calls --out-dir build --source-maps",

packages/experimental/package.json

@@ -28,8 +28,8 @@
     "directory": "dist"
   },
   "scripts": {
-    "build": "pnpm build-prepare && pnpm build-esm && pnpm build-cjs && pnpm build-annotate && build-utils pack-v2",
-    "build-prepare": "build-utils prepare-v2",
+    "codegen": "build-utils prepare-v2",
+    "build": "pnpm codegen && pnpm build-esm && pnpm build-cjs && pnpm build-annotate && build-utils pack-v2",
     "build-esm": "tsc -b tsconfig.build.json",
     "build-cjs": "babel build/esm --plugins @babel/transform-export-namespace-from --plugins @babel/transform-modules-commonjs --out-dir build/cjs --source-maps",
     "build-annotate": "babel build --plugins annotate-pure-calls --out-dir build --source-maps",

packages/opentelemetry/package.json

@@ -28,8 +28,8 @@
     "directory": "dist"
   },
   "scripts": {
-    "build": "pnpm build-prepare && pnpm build-esm && pnpm build-cjs && pnpm build-annotate && build-utils pack-v2",
-    "build-prepare": "build-utils prepare-v2",
+    "codegen": "build-utils prepare-v2",
+    "build": "pnpm codegen && pnpm build-esm && pnpm build-cjs && pnpm build-annotate && build-utils pack-v2",
     "build-esm": "tsc -b tsconfig.build.json",
     "build-cjs": "babel build/esm --plugins @babel/transform-export-namespace-from --plugins @babel/transform-modules-commonjs --out-dir build/cjs --source-maps",
     "build-annotate": "babel build --plugins annotate-pure-calls --out-dir build --source-maps",

packages/platform-browser/package.json

@@ -28,8 +28,8 @@
     "directory": "dist"
   },
   "scripts": {
-    "build": "pnpm build-prepare && pnpm build-esm && pnpm build-cjs && pnpm build-annotate && build-utils pack-v2",
-    "build-prepare": "build-utils prepare-v2",
+    "codegen": "build-utils prepare-v2",
+    "build": "pnpm codegen && pnpm build-esm && pnpm build-cjs && pnpm build-annotate && build-utils pack-v2",
     "build-esm": "tsc -b tsconfig.build.json",
     "build-cjs": "babel build/esm --plugins @babel/transform-export-namespace-from --plugins @babel/transform-modules-commonjs --out-dir build/cjs --source-maps",
     "build-annotate": "babel build --plugins annotate-pure-calls --out-dir build --source-maps",

packages/platform-bun/package.json

@@ -28,8 +28,8 @@
     "directory": "dist"
   },
   "scripts": {
-    "build": "pnpm build-prepare && pnpm build-esm && pnpm build-cjs && pnpm build-annotate && build-utils pack-v2",
-    "build-prepare": "build-utils prepare-v2",
+    "codegen": "build-utils prepare-v2",
+    "build": "pnpm codegen && pnpm build-esm && pnpm build-cjs && pnpm build-annotate && build-utils pack-v2",
     "build-esm": "tsc -b tsconfig.build.json",
     "build-cjs": "babel build/esm --plugins @babel/transform-export-namespace-from --plugins @babel/transform-modules-commonjs --out-dir build/cjs --source-maps",
     "build-annotate": "babel build --plugins annotate-pure-calls --out-dir build --source-maps",

packages/platform-node/package.json

@@ -31,8 +31,8 @@
     "node": ">=18.0.0"
   },
   "scripts": {
-    "build": "pnpm build-prepare && pnpm build-esm && pnpm build-cjs && pnpm build-annotate && build-utils pack-v2",
-    "build-prepare": "build-utils prepare-v2",
+    "codegen": "build-utils prepare-v2",
+    "build": "pnpm codegen && pnpm build-esm && pnpm build-cjs && pnpm build-annotate && build-utils pack-v2",
     "build-esm": "tsc -b tsconfig.build.json",
     "build-cjs": "babel build/esm --plugins @babel/transform-export-namespace-from --plugins @babel/transform-modules-commonjs --out-dir build/cjs --source-maps",
     "build-annotate": "babel build --plugins annotate-pure-calls --out-dir build --source-maps",

packages/printer-ansi/package.json

@@ -28,8 +28,8 @@
     "directory": "dist"
   },
   "scripts": {
-    "build": "pnpm build-prepare && pnpm build-esm && pnpm build-cjs && pnpm build-annotate && build-utils pack-v2",
-    "build-prepare": "build-utils prepare-v2",
+    "codegen": "build-utils prepare-v2",
+    "build": "pnpm codegen && pnpm build-esm && pnpm build-cjs && pnpm build-annotate && build-utils pack-v2",
     "build-esm": "tsc -b tsconfig.build.json",
     "build-cjs": "babel build/esm --plugins @babel/transform-export-namespace-from --plugins @babel/transform-modules-commonjs --out-dir build/cjs --source-maps",
     "build-annotate": "babel build --plugins annotate-pure-calls --out-dir build --source-maps",

packages/printer/package.json

@@ -28,8 +28,8 @@
     "directory": "dist"
   },
   "scripts": {
-    "build": "pnpm build-prepare && pnpm build-esm && pnpm build-cjs && pnpm build-annotate && build-utils pack-v2",
-    "build-prepare": "build-utils prepare-v2",
+    "codegen": "build-utils prepare-v2",
+    "build": "pnpm codegen && pnpm build-esm && pnpm build-cjs && pnpm build-annotate && build-utils pack-v2",
     "build-esm": "tsc -b tsconfig.build.json",
     "build-cjs": "babel build/esm --plugins @babel/transform-export-namespace-from --plugins @babel/transform-modules-commonjs --out-dir build/cjs --source-maps",
     "build-annotate": "babel build --plugins annotate-pure-calls --out-dir build --source-maps",

packages/rpc-http-node/package.json

@@ -28,8 +28,8 @@
     "directory": "dist"
   },
   "scripts": {
-    "build": "pnpm build-prepare && pnpm build-esm && pnpm build-cjs && pnpm build-annotate && build-utils pack-v2",
-    "build-prepare": "build-utils prepare-v2",
+    "codegen": "build-utils prepare-v2",
+    "build": "pnpm codegen && pnpm build-esm && pnpm build-cjs && pnpm build-annotate && build-utils pack-v2",
     "build-esm": "tsc -b tsconfig.build.json",
     "build-cjs": "babel build/esm --plugins @babel/transform-export-namespace-from --plugins @babel/transform-modules-commonjs --out-dir build/cjs --source-maps",
     "build-annotate": "babel build --plugins annotate-pure-calls --out-dir build --source-maps",

packages/rpc-http/package.json

@@ -28,8 +28,8 @@
     "directory": "dist"
   },
   "scripts": {
-    "build": "pnpm build-prepare && pnpm build-esm && pnpm build-cjs && pnpm build-annotate && build-utils pack-v2",
-    "build-prepare": "build-utils prepare-v2",
+    "codegen": "build-utils prepare-v2",
+    "build": "pnpm codegen && pnpm build-esm && pnpm build-cjs && pnpm build-annotate && build-utils pack-v2",
     "build-esm": "tsc -b tsconfig.build.json",
     "build-cjs": "babel build/esm --plugins @babel/transform-export-namespace-from --plugins @babel/transform-modules-commonjs --out-dir build/cjs --source-maps",
     "build-annotate": "babel build --plugins annotate-pure-calls --out-dir build --source-maps",

packages/rpc-nextjs/package.json

@@ -28,8 +28,8 @@
     "directory": "dist"
   },
   "scripts": {
-    "build": "pnpm build-prepare && pnpm build-esm && pnpm build-cjs && pnpm build-annotate && build-utils pack-v2",
-    "build-prepare": "build-utils prepare-v2",
+    "codegen": "build-utils prepare-v2",
+    "build": "pnpm codegen && pnpm build-esm && pnpm build-cjs && pnpm build-annotate && build-utils pack-v2",
     "build-esm": "tsc -b tsconfig.build.json",
     "build-cjs": "babel build/esm --plugins @babel/transform-export-namespace-from --plugins @babel/transform-modules-commonjs --out-dir build/cjs --source-maps",
     "build-annotate": "babel build --plugins annotate-pure-calls --out-dir build --source-maps",

packages/rpc-workers/package.json

@@ -28,8 +28,8 @@
     "directory": "dist"
   },
   "scripts": {
-    "build": "pnpm build-prepare && pnpm build-esm && pnpm build-cjs && pnpm build-annotate && build-utils pack-v2",
-    "build-prepare": "build-utils prepare-v2",
+    "codegen": "build-utils prepare-v2",
+    "build": "pnpm codegen && pnpm build-esm && pnpm build-cjs && pnpm build-annotate && build-utils pack-v2",
     "build-esm": "tsc -b tsconfig.build.json",
     "build-cjs": "babel build/esm --plugins @babel/transform-export-namespace-from --plugins @babel/transform-modules-commonjs --out-dir build/cjs --source-maps",
     "build-annotate": "babel build --plugins annotate-pure-calls --out-dir build --source-maps",

packages/rpc/package.json

@@ -28,8 +28,8 @@
     "directory": "dist"
   },
   "scripts": {
-    "build": "pnpm build-prepare && pnpm build-esm && pnpm build-cjs && pnpm build-annotate && build-utils pack-v2",
-    "build-prepare": "build-utils prepare-v2",
+    "codegen": "build-utils prepare-v2",
+    "build": "pnpm codegen && pnpm build-esm && pnpm build-cjs && pnpm build-annotate && build-utils pack-v2",
     "build-esm": "tsc -b tsconfig.build.json",
     "build-cjs": "babel build/esm --plugins @babel/transform-export-namespace-from --plugins @babel/transform-modules-commonjs --out-dir build/cjs --source-maps",
     "build-annotate": "babel build --plugins annotate-pure-calls --out-dir build --source-maps",

packages/schema/package.json

@@ -32,8 +32,8 @@
     "directory": "dist"
   },
   "scripts": {
-    "build": "pnpm build-prepare && pnpm build-esm && pnpm build-cjs && pnpm build-annotate && build-utils pack-v2",
-    "build-prepare": "build-utils prepare-v2",
+    "codegen": "build-utils prepare-v2",
+    "build": "pnpm codegen && pnpm build-esm && pnpm build-cjs && pnpm build-annotate && build-utils pack-v2",
     "build-esm": "tsc -b tsconfig.build.json",
     "build-cjs": "babel build/esm --plugins @babel/transform-export-namespace-from --plugins @babel/transform-modules-commonjs --out-dir build/cjs --source-maps",
     "build-annotate": "babel build --plugins annotate-pure-calls --out-dir build --source-maps",

packages/typeclass/package.json

@@ -30,8 +30,8 @@
     "directory": "dist"
   },
   "scripts": {
-    "build": "pnpm build-prepare && pnpm build-esm && pnpm build-cjs && pnpm build-annotate && build-utils pack-v2",
-    "build-prepare": "build-utils prepare-v2",
+    "codegen": "build-utils prepare-v2",
+    "build": "pnpm codegen && pnpm build-esm && pnpm build-cjs && pnpm build-annotate && build-utils pack-v2",
     "build-esm": "tsc -b tsconfig.build.json",
     "build-cjs": "babel build/esm --plugins @babel/transform-export-namespace-from --plugins @babel/transform-modules-commonjs --out-dir build/cjs --source-maps",
     "build-annotate": "babel build --plugins annotate-pure-calls --out-dir build --source-maps",