@travetto/email-compiler 8.0.0-alpha.2 → 8.0.0-alpha.20

package/README.md

@@ -53,15 +53,24 @@ The module provides [Command Line Interface](https://github.com/travetto/travett
 ## CLI Compilation
 The module provides [Command Line Interface](https://github.com/travetto/travetto/tree/main/module/cli#readme "CLI infrastructure for Travetto framework") support for email template compilation also. Running
 
-**Terminal: Running template compilation**
+## CLI - email:compile
+
+**Terminal: Help for email:compile**
 ```bash
-$ trv email:compile -h
+$ trv email:compile --help
 
 Usage: email:compile [options]
 
+Description:
+  Compile all email templates into generated runtime artifacts.
+
+  The command discovers templated inputs (for example, `.email.html`) and emits
+  compiled outputs used at runtime (html/text/subject variants). With watch
+  enabled, recompilation runs automatically on matching template changes.
+
 Options:
-  -w, --watch  Compile in watch mode
-  -h, --help   display help for command
+  -w, --watch  Recompile templates whenever source templates change.
+  --help       display help for command
 ```
 
 Will convert all `.email.html` files into the appropriate `.compiled.html`, `.compiled.text` and `.compiled.subject` files.  These will be used during the running of the application.  By default these files are added to the `.gitignore` as they are generally not intended to be saved but to be generated during the build process.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/email-compiler",
-  "version": "8.0.0-alpha.2",
+  "version": "8.0.0-alpha.20",
   "type": "module",
   "description": "Email compiling module",
   "keywords": [
@@ -27,20 +27,20 @@
     "directory": "module/email-compiler"
   },
   "dependencies": {
-    "@travetto/config": "^8.0.0-alpha.1",
-    "@travetto/di": "^8.0.0-alpha.1",
-    "@travetto/email": "^8.0.0-alpha.1",
-    "@travetto/image": "^8.0.0-alpha.1",
-    "@travetto/runtime": "^8.0.0-alpha.1",
-    "@travetto/worker": "^8.0.0-alpha.1",
+    "@travetto/config": "^8.0.0-alpha.19",
+    "@travetto/di": "^8.0.0-alpha.18",
+    "@travetto/email": "^8.0.0-alpha.19",
+    "@travetto/image": "^8.0.0-alpha.18",
+    "@travetto/runtime": "^8.0.0-alpha.18",
+    "@travetto/worker": "^8.0.0-alpha.18",
     "@types/inline-css": "^3.0.4",
     "html-entities": "^2.6.0",
     "inline-css": "^4.0.3",
     "purgecss": "^8.0.0",
-    "sass": "^1.97.3"
+    "sass": "^1.100.0"
   },
   "peerDependencies": {
-    "@travetto/cli": "^8.0.0-alpha.2"
+    "@travetto/cli": "^8.0.0-alpha.25"
   },
   "peerDependenciesMeta": {
     "@travetto/cli": {

package/src/util.ts

@@ -185,7 +185,7 @@ export class EmailCompileUtil {
   static async applyStyles(html: string, options: EmailTemplateResource): Promise<string> {
     const styles = [
       options.globalStyles ?? '',
-      await options.loader.readText('/email/main.scss').catch(() => '')
+      await options.loader.readUTF8('/email/main.scss').catch(() => '')
     ]
       .filter(line => !!line)
       .join('\n');

package/support/bin/config.ts

@@ -51,7 +51,7 @@ export class EditorConfig {
 
   static async ensureConfig(): Promise<string> {
     const resolved = Runtime.workspaceRelative(CONFIG_FILE);
-    if (!(await fs.stat(resolved).catch(() => { }))) {
+    if (!(await fs.stat(resolved, { throwIfNoEntry: false }))) {
       await ManifestFileUtil.bufferedFileWrite(resolved, this.getDefaultConfig());
     }
     return resolved;

package/support/cli.email_compile.ts

@@ -6,12 +6,16 @@ import { EmailCompiler } from '../src/compiler.ts';
 import { EmailCompileUtil } from '../src/util.ts';
 
 /**
- * CLI Entry point for running the email server
+ * Compile all email templates into generated runtime artifacts.
+ *
+ * The command discovers templated inputs (for example, `.email.html`) and emits
+ * compiled outputs used at runtime (html/text/subject variants). With watch
+ * enabled, recompilation runs automatically on matching template changes.
  */
 @CliCommand()
 export class EmailCompileCommand implements CliCommandShape {
 
-  /** Compile in watch mode */
+  /** Recompile templates whenever source templates change. */
   watch?: boolean;
 
   finalize(): void {

package/support/cli.email_editor.ts

@@ -5,7 +5,12 @@ import { DependencyRegistryIndex } from '@travetto/di';
 
 import { EditorService } from './bin/editor.ts';
 
-/** The email editor compilation service and output serving */
+/**
+ * Start the email template editor service for interactive preview and testing.
+ *
+ * The editor compiles templates on demand and hosts the preview/test workflow
+ * used during local template authoring.
+ */
 @CliCommand()
 export class EmailEditorCommand {
 

package/support/cli.email_test.ts

@@ -8,7 +8,10 @@ import { Env } from '@travetto/runtime';
 import { EditorService } from './bin/editor.ts';
 
 /**
- * CLI Entry point for running the email server
+ * Render and send a template file to a target recipient for quick validation.
+ *
+ * This command is useful during template development to verify real delivery and
+ * formatting without running the full editor workflow.
  */
 @CliCommand()
 export class EmailTestCommand implements CliCommandShape {