Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gauben/svelte-emails

Create emails with Svelte and Vite!
https://github.com/gauben/svelte-emails

Last synced: 12 days ago
JSON representation

Create emails with Svelte and Vite!

Awesome Lists containing this project

README 

        
![Rendering emails with Svelte](https://raw.githubusercontent.com/GauBen/svelte-emails/main/docs/cover.png)



# Rendering emails with Svelte



**Emails are the cornerstone of automated internet communication.** Create an account on a website? Email. Receive an invoice? Email. Sign up for an event? Email. As a developer, you will need to send emails at some point. And you will end up working with some of the most legacy web technologies.



We, at Escape, recently **rebuilt our whole email stack from scratch to improve the developer experience:** we used to send emails to preview them, whereas now, **we have an instant feedback loop,** leveraging a [SvelteKit](https://kit.svelte.dev/)-powered dev server.



## Emails are written with 2003 HTML



If you started web development before 2000, chances are you worked on websites designed with ``-based layouts. It was [_the_ way](https://thehistoryoftheweb.com/tables-layout-absurd/) to design complex two-dimensional layouts.



![ everywhere meme made with imgflip](https://i.imgflip.com/72vkka.jpg)



Well, unfortunately for us, email clients are still stuck in the dark ages. We, therefore, have four possibilities to write emails:



- **Write them by hand** and learn the quirks of the old ``-based layout system with loads of `

     ${body}

   `;

   const html = mjml2html(document(mail({ name: "World" })));

   ```



4. We would send the resulting HTML:



   ```js

   let transporter = nodemailer.createTransport();



   await transporter.sendMail({

     from: "[email protected]",

     to: "[email protected]",

     subject: "Hello!",

     html,

   });

   ```



Apart from that, we also want:



- A way to preview the emails, and the easiest way to get live-reload in a Svelte project is to use [SvelteKit](https://kit.svelte.dev/).

- Compile-time type checking for props, which is made possible by [svelte2tsx](https://www.npmjs.com/package/svelte2tsx).



Our setup will be in two parts:



- Setting up a development server to create and preview emails.

- Setting up a build pipeline to compile emails to HTML strings.



## The dev server



[SvelteKit](https://kit.svelte.dev) offers a fantastic developer experience to work with Svelte and was just released as stable, so it is a no-brainer to use it.



You can clone the whole experiment [from GitHub](https://github.com/GauBen/svelte-emails). We will go through the most interesting parts in the rest of the article.



You will find a complete SvelteKit project in [`packages/svelte-emails`](https://github.com/GauBen/svelte-emails/tree/main/packages/svelte-emails):



- [`index.ts`](https://github.com/GauBen/svelte-emails/blob/main/packages/svelte-emails/src/index.ts): This is our library entry point.



  ```ts

  // Export the renderer

  export { render } from "./lib/index.js";



  // Also export compiled Svelte components

  export * from "./mails/index.js";

  ```



- `lib/`



  - [`Header.svelte`](https://github.com/GauBen/svelte-emails/blob/main/packages/svelte-emails/src/lib/Header.svelte): This is our common email header. MJML offers a [lot of components](https://documentation.mjml.io/#standard-body-components) out of the box.



    ```svelte

    

      

        

          

          

        

        

      

    

    ```



  - [`index.ts`](https://github.com/GauBen/svelte-emails/blob/main/packages/svelte-emails/src/lib/index.ts): It contains the MJML rendering logic.



    ```ts

    /** Renders a Svelte component as email-ready HTML. */

    export const render = (

      component: new (...args) => SvelteComponentTyped,

      props: Props

    ) => {

      // Render the component to MJML

      const { html: body, css, head } = component.render(props);



      const mjml = `

        

          ${head}

          ${css.code}

        

        ${body}

      `;



      // Render MJML to HTML

      const { html } = mjml2html(mjml);



      return html;

    };

    ```



- `mails/`: This is the root HTTP directory, and it will also contain our emails.



  - [`index.ts`](https://github.com/GauBen/svelte-emails/blob/main/packages/svelte-emails/src/mails/index.ts): This file reexports all the emails.



    ```ts

    export { default as HelloWorld } from "./hello-world/Mail.svelte";

    ```



  - `hello-world/`



    - [`Mail.svelte`](https://github.com/GauBen/svelte-emails/blob/main/packages/svelte-emails/src/mails/hello-world/Mail.svelte): Make a guess!



      ```svelte

      

        import Header from "$lib/Header.svelte";

        export let name: string;

      



      Hello {name}!



      

        

          

            Learn Svelte

          

        

      

      ```



    - [`+page.server.ts`](https://github.com/GauBen/svelte-emails/blob/main/packages/svelte-emails/src/mails/hello-world/%2Bpage.server.ts) and [`+page.svelte`](https://github.com/GauBen/svelte-emails/blob/main/packages/svelte-emails/src/mails/hello-world/%2Bpage.svelte): These are our development email previews, powered by [Vite](https://vitejs.dev/).



      ```ts

      export const load = async () => ({

        email: render(Mail, {

          // This is type-checked!

          name: "World",

        }),

      });

      ```



That is quite a lot of code! Let's try it out:



```bash

# Start the dev server

yarn dev

```



Go to [localhost:5173/hello-world](http://localhost:5173/hello-world) to see the email preview, and edit anything to see it update in real-time.



![A screenshot of the resulting email, with a title and a button](https://raw.githubusercontent.com/GauBen/svelte-emails/main/docs/screenshot.png)



## The build pipeline



We now have a working development environment, but we need to build our emails for production. We will use [Rollup](https://rollupjs.org/) to bundle our emails, and [svelte2tsx](https://www.npmjs.com/package/svelte2tsx) to emit type declarations.



The [`rollup.config.js`](https://github.com/GauBen/svelte-emails/blob/main/packages/svelte-emails/rollup.config.js) file defines our build pipeline:



```js

export default {

  input: "src/mails/index.ts",

  plugins: [

    {

      /** Export component's types at the end of the build. */

      name: "rollup-plugin-svelte2dts",

      async buildEnd() {

        const require = createRequire(import.meta.url);



        // All the heavy lifting is done by svelte2tsx

        await emitDts({

          svelteShimsPath: require.resolve("svelte2tsx/svelte-shims.d.ts"),

          declarationDir: "build",

        });



        // We need to replace `.svelte` with `.svelte.js` for types to be resolved

        const index = "build/mails/index.d.ts";

        const code = await readFile(index, "utf-8");

        await writeFile(index, code.replaceAll(".svelte", ".svelte.js"));

      },

    },

    svelte({

      ...svelteConfig,

      compilerOptions: { generate: "ssr" },

      emitCss: false,

    }),

  ],

};

```



Run `yarn build` to transform the Svelte emails components into raw JavaScript.



## Wrapping up



Using our built emails in a NodeJS app is as simple as:



```ts

import { render, HelloWorld } from "svelte-emails";



const html = render(HelloWorld, {

  // This is type-checked!

  name: "World",

});

console.log(html);

```



There is a [demo](https://github.com/GauBen/svelte-emails/tree/main/packages/demo) package in the repo for you to try out.



---



This concludes this experiment. We are still tinkering with a few things to make it easier to use, but we hope you enjoyed this article. Feel free to ask questions or give feedback on how you are currently developing emails, we are eager to hear from you!