Stop linking emails (#395)

* stop linking emails

* remove more files

* re-add emails

* stop eslinting for now

* fix

* cleanup

* get greens

* generate js instead

* fix link, exclude root emails directory

* Update packages/cli/src/util/generators.ts

Co-authored-by: Peter Sugihara <[email protected]>

* Apply suggestions from code review

Co-authored-by: Peter Sugihara <[email protected]>

Co-authored-by: Peter Sugihara <[email protected]>

.gitignore

@@ -1,3 +1,4 @@
+# Mailing
 dev-app
 tmp-testMailQueue.json
 dist
@@ -6,6 +7,7 @@ mailing.config.json
 previews_html
 out
 .mailing
+/emails
 
 # Logs
 logs
@@ -110,12 +112,6 @@ typings/
 # TernJS port file
 .tern-port
 
-# This gets generated by the CLI when we test locally
-emails
-!packages/cli/src/generator_templates/ts/emails/
-!packages/cli/src/generator_templates/js/emails/
-!packages/web/emails
-
 # E2E tests
 e2e/runs
 e2e/cache

.husky/pre-commit

@@ -1,6 +1,4 @@
 #!/usr/bin/env sh
 . "$(dirname "$0")/_/husky.sh"
 
-yarn lint:unlink
 yarn lint-staged
-yarn lint:link

.lintstagedrc

@@ -1,5 +1,5 @@
 {
   "*.{js,jsx,ts,tsx}": "eslint --fix",
   "*.rb": "rubocop --autocorrect",
-  "packages/cli/src/generator_templates/ts/**/*.{ts,tsx}": "scripts/build-js-templates"
+  "packages/cli/src/emails/**/*.{ts,tsx}": "scripts/build-js-templates"
 }

jest.config.ts

@@ -60,7 +60,6 @@ const nodeConfig = (): Config => {
     watchPathIgnorePatterns: [
       "<rootDir>/emails/",
       "<rootDir>/packages/cli/src/emails/",
-      "<rootDir>/packages/cli/src/generator_templates/ts/emails/",
       "<rootDir>/.mailing/",
       "tmp-testMailQueue.json",
     ],

jest.integration.config.ts

@@ -24,7 +24,6 @@ const config: Config = {
   watchPathIgnorePatterns: [
     "<rootDir>/emails/",
     "<rootDir>/packages/cli/src/emails/",
-    "<rootDir>/packages/cli/src/generator_templates/ts/emails/",
     "<rootDir>/.mailing/",
     "tmp-testMailQueue.json",
   ],

package.json

@@ -9,23 +9,19 @@
     "packages/*"
   ],
   "scripts": {
-    "lint": "yarn lint:unlink; eslint .; yarn lint:link",
-    "lint:unlink": "rm packages/cli/src/emails",
-    "lint:link": "ln -s 'generator_templates/ts/emails/' packages/cli/src/emails",
+    "lint": "eslint .",
     "dev": "cd packages/cli && yarn dev",
     "dev:web": "cd packages/web && yarn dev",
-    "dev:js": "yarn link:emails:js && yarn dev",
     "dev:init": "cd packages/cli && rm -rf previews_html; rm -rf .mailing emails mailing.config.json; src/dev.js",
     "dev:export-previews": "yarn link:emails; cd packages/cli && rm -rf .mailing && src/dev.js export-previews",
     "dev:server:build": "cd packages/cli && rm -rf .mailing && src/dev.js server build",
-    "link:emails": "rm -rf emails; ln -s packages/cli/src/generator_templates/ts/emails emails;",
-    "link:emails:js": "rm -rf emails; ln -s packages/cli/src/generator_templates/js/emails emails;",
+    "link:emails": "echo 'noop'",
     "build": "preconstruct build",
-    "test": "yarn link:emails; yarn jest",
-    "test:integration": "yarn integration:servers:start \"yarn link:emails; yarn jest -c jest.integration.config.ts $TEST_FLAGS\"",
-    "test:integration:watch": "yarn integration:servers:start \"yarn link:emails; yarn jest -c jest.integration.config.ts --watch\"",
+    "test": "yarn jest",
+    "test:integration": "yarn integration:servers:start \"yarn jest -c jest.integration.config.ts $TEST_FLAGS\"",
+    "test:integration:watch": "yarn integration:servers:start \"yarn jest -c jest.integration.config.ts --watch\"",
     "ci:test": "yarn test:servers:start test",
-    "ci:test:integration": "yarn integration:servers:start \"yarn link:emails; yarn jest -c jest.integration.config.ts\"",
+    "ci:test:integration": "yarn integration:servers:start \"yarn jest -c jest.integration.config.ts\"",
     "test:integration:cypress": "yarn integration:servers:start \"cd packages/cli && yarn cypress run -C cypressIntegration.config.ts\"",
     "test:integration:cypress:open": "yarn integration:servers:start \"cd packages/cli && yarn cypress open -C cypressIntegration.config.ts\"",
     "ci:cli": "cd packages/cli && yarn ci:server",

packages/cli/src/commands/__test__/exportPreviews.test.ts

@@ -18,6 +18,11 @@ describe("exportPreviews command", () => {
     }));
   });
 
+  afterEach(() => {
+    fsExtra.removeSync("./out");
+    fsExtra.removeSync("./packages/cli/previews_html");
+  });
+
   it("outputs html files to outDir", async () => {
     await handler({
       outDir: "./out",

packages/cli/src/commands/__test__/init.test.ts

@@ -3,7 +3,6 @@ import fsExtra, { removeSync } from "fs-extra";
 import { handler, InitArguments } from "../init";
 import { log } from "../../util/serverLogger";
 
-jest.useFakeTimers();
 jest.mock("../../util/serverLogger");
 jest.mock("../preview/preview", () => ({ handler: jest.fn() }));
 
@@ -15,6 +14,9 @@ describe("init command", () => {
       .mockImplementation((path) =>
         /package\.json/.test(path.toString()) ? "{}" : ""
       );
+  });
+
+  afterEach(() => {
     removeSync("/tmp/src/emails");
   });
 

packages/cli/src/commands/init.ts

@@ -62,7 +62,9 @@ export const handler = buildHandler(
     if (undefined === argv.emailsDir)
       throw new Error("emailsDir option not set");
 
-    if (!existsSync(resolve(argv.emailsDir, "previews"))) {
+    if (existsSync(resolve(argv.emailsDir, "previews"))) {
+      log("Using emails directory", argv.emailsDir);
+    } else {
       const options = {
         isTypescript: argv.typescript,
         emailsDir: argv.emailsDir,

packages/cli/src/util/generators.ts

@@ -4,24 +4,23 @@ import tree from "tree-node-cli";
 import { log } from "./serverLogger";
 
 export async function generateEmailsDirectory({
-  isTypescript,
   emailsDir,
+  isTypescript,
 }: {
-  isTypescript: boolean;
   emailsDir: string;
+  isTypescript: boolean;
 }) {
-  // copy the emails dir template in!
-  const path = `generator_templates/${isTypescript ? "ts" : "js"}/emails`;
   const srcDir =
     process.env.MM_DEV || process.env.NODE_ENV === "test"
       ? __dirname + "/.."
       : __dirname + "/../src";
-  await copy(resolve(srcDir, path), emailsDir, {
-    overwrite: false,
+
+  // copy the emails dir template in!
+  const srcEmails = isTypescript ? "emails" : "emails-js";
+  await copy(resolve(srcDir, srcEmails), emailsDir, { overwrite: false });
+
+  const fileTree = tree(emailsDir, {
+    exclude: [/node_modules|\.mailing|yarn\.lock|yalc\.lock/],
   });
-  log(
-    `generated your emails dir at ${emailsDir}:\n${tree(emailsDir, {
-      exclude: [/node_modules|\.mailing|yarn\.lock|yalc\.lock/],
-    })}`
-  );
+  log(`generated your emails dir at ${emailsDir}:\n${fileTree}`);
 }

packages/web/pages/docs/templates.mdx

@@ -4,7 +4,7 @@
 - Lancey [Demo](https://lancey-mailing.vercel.app/) / [Source](https://github.com/sofn-xyz/mailing-templates/tree/main/lancey)
 - Fynn [Demo](https://fynn-mailing.vercel.app/) / [Source](https://github.com/sofn-xyz/mailing-templates/tree/main/fynn)
 - Mailing [Demo](https://emails.mailing.run/) / [Source](https://github.com/sofn-xyz/mailing/tree/main/packages/web/emails)
-- BookBook [Demo](https://demo.mailing.run/) / [Source](https://github.com/sofn-xyz/mailing/tree/main/packages/cli/src/generator_templates/ts/emails)
+- BookBook [Demo](https://book-book-mailing.vercel.app/) / [Source](https://github.com/sofn-xyz/mailing-templates/tree/main/book-book)
 
 Built some cool templates you want to share? Submit a PR adding it to [the list](https://github.com/sofn-xyz/mailing/blob/main/packages/web/pages/docs/templates.mdx).
 

scripts/generate-emails-js

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+
+# Generate JS templates from TS Templates
+npx tsc \
+--allowSyntheticDefaultImports true \
+--moduleResolution node \
+--jsx preserve \
+--target es2020 \
+--outDir packages/cli/src/emails-js \
+--noEmit false \
+packages/cli/src/emails/**/*.tsx \
+packages/cli/src/emails/*.tsx \
+packages/cli/src/emails/*.ts
+
+# Format the generated JS templates
+npx prettier --write packages/cli/src/emails-js/*
+yarn eslint --fix --ext .jsx,.js packages/cli/src/emails-js/*
+
+# Add the generated JS templates to git
+git add packages/cli/src/emails-js/*