feat(react-email): email-dev package for linking globally (#2258)

Co-authored-by: Bu Kinoshita <[email protected]>

Author: gabrielmfern

packages/react-email/dev/index.js

@@ -0,0 +1,40 @@
+import child_process from 'node:child_process';
+import path from 'node:path';
+import url from 'node:url';
+
+const filename = url.fileURLToPath(import.meta.url);
+const dirname = path.dirname(filename);
+
+const root = path.resolve(dirname, '../src/index.ts');
+
+const tsxPath = path.resolve(dirname, './node_modules/.bin/tsx');
+
+const tsx = child_process.spawn(tsxPath, [root, ...process.argv.slice(2)], {
+  shell: true,
+  cwd: process.cwd(),
+  stdio: 'inherit',
+});
+
+process.on('uncaughtExceptionMonitor', () => {
+  tsx.kill();
+});
+
+process.on('exit', (code) => {
+  tsx.kill(code);
+});
+
+process.on('SIGINT', () => {
+  tsx.kill('SIGINT');
+});
+
+process.on('SIGTERM', () => {
+  tsx.kill('SIGTERM');
+});
+
+process.on('SIGUSR1', () => {
+  tsx.kill('SIGUSR1');
+});
+
+process.on('SIGUSR2', () => {
+  tsx.kill('SIGUSR2');
+});

packages/react-email/dev/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "email-dev",
+  "version": "0.0.0",
+  "bin": "index.js",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "start": "node ."
+  },
+  "dependencies": {
+    "tsx": "4.19.3"
+  }
+}

packages/react-email/readme.md

@@ -39,6 +39,22 @@ Generates the plain HTML files of your emails into a `out` directory.
 npx react-email export
 ```
 
+## Setting Up the Environment
+
+When working in the CLI, a lot of friction can get introduced with installing it and rebuilding for every change. To avoid that, we have a script that can be linked globally to directly run the source code of the CLI. You can use it the same as you would the standard CLI.
+
+### 1. Link `react-email` globally
+
+```sh
+pnpm link ./dev -g
+```
+
+### 2. Run the CLI
+
+```sh
+email-dev [command] [flags]
+```
+
 ## License
 
 MIT License

pnpm-lock.yaml

@@ -1,4 +1,5 @@
 packages:
   - "apps/*"
   - "packages/*"
+  - "packages/react-email/dev"
   - "benchmarks/*"