rewrite build system to not have to run npm install

Author: gabrielmfern

packages/react-email/src/cli/commands/build.ts

@@ -12,7 +12,7 @@ import { cliPackageLocation } from '../utils';
 
 interface Args {
   dir: string;
-  packageManager: string;
+  packageManager?: string;
 }
 
 const buildPreviewApp = (absoluteDirectory: string) => {
@@ -40,12 +40,13 @@ const buildPreviewApp = (absoluteDirectory: string) => {
 
 const setNextEnvironmentVariablesForBuild = async (
   emailsDirRelativePath: string,
-  builtPreviewAppPath: string,
+  userProjectPath: string,
+  modifiedPreviewAppPath: string,
 ) => {
   const nextConfigContents = `
 const path = require('path');
 const emailsDirRelativePath = path.normalize('${emailsDirRelativePath}');
-const userProjectLocation = path.resolve(process.cwd(), '../');
+const userProjectLocation = '${userProjectPath}';
 /** @type {import('next').NextConfig} */
 module.exports = {
   env: {
@@ -78,7 +79,7 @@ module.exports = {
 }`;
 
   await fs.promises.writeFile(
-    path.resolve(builtPreviewAppPath, './next.config.js'),
+    path.resolve(modifiedPreviewAppPath, './next.config.js'),
     nextConfigContents,
     'utf8',
   );
@@ -170,61 +171,25 @@ const updatePackageJson = async (builtPreviewAppPath: string) => {
   };
   packageJson.scripts.build = 'next build';
   packageJson.scripts.start = 'next start';
-  delete packageJson.scripts.postbuild;
 
   packageJson.name = 'preview-server';
-  // We remove this one to avoid having resolve issues on our demo build process.
-  // This is only used in the `export` command so it's irrelevant to have it here.
-  //
-  // See `src/actions/render-email-by-path` for more info on how we render the
-  // email templates without `@react-email/render` being installed.
-  delete packageJson.devDependencies['@react-email/render'];
-  delete packageJson.devDependencies['@react-email/components'];
-  delete packageJson.scripts.prepare;
   await fs.promises.writeFile(
     packageJsonPath,
     JSON.stringify(packageJson),
     'utf8',
   );
 };
 
-const npmInstall = async (
-  builtPreviewAppPath: string,
-  packageManager: string,
-) => {
-  return new Promise<void>((resolve, reject) => {
-    const childProc = spawn(
-      packageManager,
-      [
-        'install',
-        packageManager === 'deno' ? '' : '--include=dev',
-        packageManager === 'deno' ? '--quiet' : '--silent',
-      ],
-      {
-        cwd: builtPreviewAppPath,
-        shell: true,
-      },
-    );
-    childProc.stdout.pipe(process.stdout);
-    childProc.stderr.pipe(process.stderr);
-    childProc.on('close', (code) => {
-      if (code === 0) {
-        resolve();
-      } else {
-        reject(
-          new Error(
-            `Unable to install the dependencies and it exited with code: ${code}`,
-          ),
-        );
-      }
-    });
-  });
-};
-
 export const build = async ({
   dir: emailsDirRelativePath,
   packageManager,
 }: Args) => {
+  if (packageManager !== undefined) {
+    console.warn(
+      'The --packageManager flag is deprecated and is currently ignored. It will be removed in the next major version',
+    );
+  }
+
   try {
     const spinner = ora({
       text: 'Starting build process...',
@@ -240,61 +205,81 @@ export const build = async ({
     const emailsDirPath = path.join(process.cwd(), emailsDirRelativePath);
     const staticPath = path.join(emailsDirPath, 'static');
 
+    const modifiedPreviewAppPath = path.resolve(
+      cliPackageLocation,
+      '../.react-email',
+    );
+    if (fs.existsSync(modifiedPreviewAppPath)) {
+      spinner.text = 'Deleting pre-existing modified preview app folder';
+      await fs.promises.rm(modifiedPreviewAppPath, { recursive: true });
+    }
     const builtPreviewAppPath = path.join(process.cwd(), '.react-email');
-
     if (fs.existsSync(builtPreviewAppPath)) {
-      spinner.text = 'Deleting pre-existing `.react-email` folder';
+      spinner.text = 'Deleting pre-existing .react-email folder';
       await fs.promises.rm(builtPreviewAppPath, { recursive: true });
     }
 
-    spinner.text = 'Copying preview app from CLI to `.react-email`';
-    await fs.promises.cp(cliPackageLocation, builtPreviewAppPath, {
+    spinner.text = 'Copying preview app from CLI to modify it';
+    await fs.promises.cp(cliPackageLocation, modifiedPreviewAppPath, {
       recursive: true,
       filter: (source: string) => {
-        // do not copy the CLI files
         return (
           !/(\/|\\)cli(\/|\\)?/.test(source) &&
           !/(\/|\\)\.next(\/|\\)?/.test(source) &&
-          !/(\/|\\)\.turbo(\/|\\)?/.test(source) &&
-          !/(\/|\\)node_modules(\/|\\)?$/.test(source)
+          !/(\/|\\)\.turbo(\/|\\)?/.test(source)
         );
       },
     });
 
     if (fs.existsSync(staticPath)) {
-      spinner.text =
-        'Copying `static` folder into `.react-email/public/static`';
-      const builtStaticDirectory = path.resolve(
-        builtPreviewAppPath,
+      spinner.text = 'Copying static directory';
+      const modifiedPreviewAppStaticDirectory = path.resolve(
+        modifiedPreviewAppPath,
         './public/static',
       );
-      await fs.promises.cp(staticPath, builtStaticDirectory, {
+      await fs.promises.cp(staticPath, modifiedPreviewAppStaticDirectory, {
         recursive: true,
       });
     }
 
-    spinner.text =
-      'Setting Next environment variables for preview app to work properly';
+    spinner.text = 'Setting Next environment variables';
     await setNextEnvironmentVariablesForBuild(
       emailsDirRelativePath,
-      builtPreviewAppPath,
+      process.cwd(),
+      modifiedPreviewAppPath,
     );
 
-    spinner.text = 'Setting server side generation for the email preview pages';
-    await forceSSGForEmailPreviews(emailsDirPath, builtPreviewAppPath);
+    spinner.text = 'Setting up server side generation';
+    await forceSSGForEmailPreviews(emailsDirPath, modifiedPreviewAppPath);
 
     spinner.text = "Updating package.json's build and start scripts";
-    await updatePackageJson(builtPreviewAppPath);
-
-    spinner.text = 'Installing dependencies on `.react-email`';
-    await npmInstall(builtPreviewAppPath, packageManager);
+    await updatePackageJson(modifiedPreviewAppPath);
 
     spinner.stopAndPersist({
-      text: 'Successfully prepared `.react-email` for `next build`',
+      text: 'Ready for next build',
       symbol: logSymbols.success,
     });
+    await buildPreviewApp(modifiedPreviewAppPath);
+
+    await fs.promises.mkdir(builtPreviewAppPath);
+    await fs.promises.cp(
+      path.join(modifiedPreviewAppPath, '.next'),
+      path.join(builtPreviewAppPath, '.next'),
+      {
+        recursive: true,
+      },
+    );
+    await fs.promises.cp(
+      path.join(modifiedPreviewAppPath, 'public'),
+      path.join(builtPreviewAppPath, 'public'),
+      {
+        recursive: true,
+      },
+    );
 
-    await buildPreviewApp(builtPreviewAppPath);
+    await fs.promises.rm(modifiedPreviewAppPath, {
+      recursive: true,
+    });
   } catch (error) {
     console.log(error);
     process.exit(1);

packages/react-email/src/cli/commands/start.ts

@@ -16,8 +16,9 @@ export const start = async () => {
       process.exit(1);
     }
 
-    const nextStart = spawn('npm', ['start'], {
+    const nextStart = spawn('npx', ['next', 'start'], {
       cwd: builtPreviewPath,
+      shell: true,
       stdio: 'inherit',
     });
 

packages/react-email/src/cli/index.ts

@@ -26,8 +26,7 @@ program
   .option('-d, --dir <path>', 'Directory with your email templates', './emails')
   .option(
     '-p --packageManager <name>',
-    'Package name to use on installation on `.react-email`',
-    'npm',
+    'Package manager to use when installing in .react-email (deprecated)',
   )
   .action(build);