feat: rename browser export to 'core'

browser-tests/benchmark.html

@@ -103,7 +103,7 @@
             <script src="https://unpkg.com/[email protected]/dist/handlebars.min.js"></script>
             <!-- This is a fallback, since ../dist/ is not uploaded to GitHub -->
             <script src="https://unpkg.com/eta"></script>
-            <script type="module" src="../dist/browser.js"></script>
+            <script type="module" src="../dist/core.js"></script>
             <script src="https://unpkg.com/[email protected]"></script>
             <script src="https://unpkg.com/[email protected]/mustache.min.js"></script>
             <script src="https://pugjs.org/js/pug.js"></script>

browser-tests/demo.html

@@ -168,7 +168,7 @@ <h4>Template</h4>
 <% if (key === 'thirdchild') { %>
   <% for (var i = 0, arr = it.obj[key]; i < arr.length; i++) { %>
       Salutations! Index: <%= i %>, parent key: <%= key %>
-      
+
   <% } %>
 <% } %>
 <% } %>
@@ -200,7 +200,7 @@ <h4>Result</h4>
       </div>
     </div>
     <script type="module">
-      import { Eta } from "../dist/browser.module.mjs";
+      import { Eta } from "../dist/core.js";
 
       // TODO: add fallback using unpkg
 

package.json

@@ -19,13 +19,13 @@
       "import": "./dist/index.js",
       "types": "./index.d.ts"
     },
-    "./browser": {
-      "import": "./dist/browser.js",
-      "types": "./dist/browser.d.ts"
+    "./core": {
+      "import": "./dist/core.js",
+      "types": "./dist/core.d.ts"
     }
   },
   "types": "./dist/index.d.ts",
-  "browser": "./dist/browser.js",
+  "browser": "./dist/core.js",
   "sideEffects": false,
   "files": [
     "dist"
@@ -50,7 +50,7 @@
   },
   "size-limit": [
     {
-      "path": "dist/browser.js",
+      "path": "dist/core.js",
       "limit": "3.5 KB"
     }
   ],

src/compile-string.ts

@@ -1,5 +1,5 @@
 import type { Options } from "./config.ts";
-import type { Eta } from "./core.ts";
+import type { Eta } from "./internal.ts";
 import type { AstObject } from "./parse.ts";
 
 /**

src/compile.ts

@@ -1,6 +1,6 @@
 import type { EtaConfig, Options } from "./config.ts";
-import type { Eta } from "./core.ts";
 import { EtaParseError } from "./err.ts";
+import type { Eta } from "./internal.ts";
 
 export type TemplateFunction = (
   this: Eta,

src/core.ts

@@ -1,83 +1,3 @@
-import type { TemplateFunction } from "./compile.ts";
-import { compile } from "./compile.ts";
-import { compileBody, compileToString } from "./compile-string.ts";
-import type { EtaConfig, Options } from "./config.ts";
-import { defaultConfig } from "./config.ts";
-import { EtaError, RuntimeErr } from "./err.ts";
-import { parse } from "./parse.ts";
-import {
-  render,
-  renderAsync,
-  renderString,
-  renderStringAsync,
-} from "./render.ts";
-import { Cacher } from "./storage.ts";
+import { Eta as EtaCore } from "./internal.ts";
 
-export class Eta {
-  constructor(customConfig?: Partial<EtaConfig>) {
-    if (customConfig) {
-      this.config = { ...defaultConfig, ...customConfig };
-    } else {
-      this.config = { ...defaultConfig };
-    }
-  }
-
-  config: EtaConfig;
-
-  RuntimeErr = RuntimeErr;
-
-  compile = compile;
-  compileToString = compileToString;
-  compileBody = compileBody;
-  parse = parse;
-  render = render;
-  renderAsync = renderAsync;
-  renderString = renderString;
-  renderStringAsync = renderStringAsync;
-
-  filepathCache: Record<string, string> = {};
-  templatesSync: Cacher<TemplateFunction> = new Cacher<TemplateFunction>({});
-  templatesAsync: Cacher<TemplateFunction> = new Cacher<TemplateFunction>({});
-
-  // resolvePath takes a relative path from the "views" directory
-  resolvePath:
-    | null
-    | ((this: Eta, template: string, options?: Partial<Options>) => string) =
-    null;
-  readFile: null | ((this: Eta, path: string) => string) = null;
-
-  // METHODS
-
-  configure(customConfig: Partial<EtaConfig>) {
-    this.config = { ...this.config, ...customConfig };
-  }
-
-  withConfig(customConfig: Partial<EtaConfig>): this & { config: EtaConfig } {
-    return { ...this, config: { ...this.config, ...customConfig } };
-  }
-
-  loadTemplate(
-    name: string,
-    template: string | TemplateFunction, // template string or template function
-    options?: { async: boolean },
-  ): void {
-    if (typeof template === "string") {
-      const templates = options?.async
-        ? this.templatesAsync
-        : this.templatesSync;
-
-      templates.define(name, this.compile(template, options));
-    } else {
-      let templates = this.templatesSync;
-
-      if (template.constructor.name === "AsyncFunction" || options?.async) {
-        templates = this.templatesAsync;
-      }
-
-      templates.define(name, template);
-    }
-  }
-}
-
-// for instance checking against thrown errors
-export { EtaError };
+export class Eta extends EtaCore {}

src/file-handling.ts

@@ -2,8 +2,8 @@ import * as fs from "node:fs";
 import * as path from "node:path";
 
 import type { Options } from "./config.ts";
-import type { Eta as EtaCore } from "./core.ts";
 import { EtaFileResolutionError } from "./err.ts";
+import type { Eta as EtaCore } from "./internal.ts";
 
 export function readFile(this: EtaCore, path: string): string {
   let res = "";

src/index.ts

@@ -1,5 +1,5 @@
-import { Eta as EtaCore } from "./core.ts";
 import { readFile, resolvePath } from "./file-handling.ts";
+import { Eta as EtaCore } from "./internal.ts";
 
 export type { EtaConfig, Options } from "./config.ts";
 export {

src/internal.ts

@@ -0,0 +1,83 @@
+import type { TemplateFunction } from "./compile.ts";
+import { compile } from "./compile.ts";
+import { compileBody, compileToString } from "./compile-string.ts";
+import type { EtaConfig, Options } from "./config.ts";
+import { defaultConfig } from "./config.ts";
+import { EtaError, RuntimeErr } from "./err.ts";
+import { parse } from "./parse.ts";
+import {
+  render,
+  renderAsync,
+  renderString,
+  renderStringAsync,
+} from "./render.ts";
+import { Cacher } from "./storage.ts";
+
+export class Eta {
+  constructor(customConfig?: Partial<EtaConfig>) {
+    if (customConfig) {
+      this.config = { ...defaultConfig, ...customConfig };
+    } else {
+      this.config = { ...defaultConfig };
+    }
+  }
+
+  config: EtaConfig;
+
+  RuntimeErr = RuntimeErr;
+
+  compile = compile;
+  compileToString = compileToString;
+  compileBody = compileBody;
+  parse = parse;
+  render = render;
+  renderAsync = renderAsync;
+  renderString = renderString;
+  renderStringAsync = renderStringAsync;
+
+  filepathCache: Record<string, string> = {};
+  templatesSync: Cacher<TemplateFunction> = new Cacher<TemplateFunction>({});
+  templatesAsync: Cacher<TemplateFunction> = new Cacher<TemplateFunction>({});
+
+  // resolvePath takes a relative path from the "views" directory
+  resolvePath:
+    | null
+    | ((this: Eta, template: string, options?: Partial<Options>) => string) =
+    null;
+  readFile: null | ((this: Eta, path: string) => string) = null;
+
+  // METHODS
+
+  configure(customConfig: Partial<EtaConfig>) {
+    this.config = { ...this.config, ...customConfig };
+  }
+
+  withConfig(customConfig: Partial<EtaConfig>): this & { config: EtaConfig } {
+    return { ...this, config: { ...this.config, ...customConfig } };
+  }
+
+  loadTemplate(
+    name: string,
+    template: string | TemplateFunction, // template string or template function
+    options?: { async: boolean },
+  ): void {
+    if (typeof template === "string") {
+      const templates = options?.async
+        ? this.templatesAsync
+        : this.templatesSync;
+
+      templates.define(name, this.compile(template, options));
+    } else {
+      let templates = this.templatesSync;
+
+      if (template.constructor.name === "AsyncFunction" || options?.async) {
+        templates = this.templatesAsync;
+      }
+
+      templates.define(name, template);
+    }
+  }
+}
+
+// for instance checking against thrown errors
+export { EtaError };

src/parse.ts

@@ -1,5 +1,5 @@
-import type { Eta } from "./core.ts";
 import { ParseErr } from "./err.ts";
+import type { Eta } from "./internal.ts";
 import { trimWS } from "./utils.ts";
 
 export type TagType = "r" | "e" | "i" | "";

src/render.ts

@@ -2,8 +2,8 @@ import type { TemplateFunction } from "./compile.ts";
 
 /* TYPES */
 import type { Options } from "./config.ts";
-import type { Eta } from "./core.ts";
 import { EtaNameResolutionError } from "./err.ts";
+import type { Eta } from "./internal.ts";
 
 /* END TYPES */
 

tsdown.config.ts

@@ -8,7 +8,7 @@ export default defineConfig([
     sourcemap: true,
   },
   {
-    entry: ["./src/browser.ts"],
+    entry: ["./src/core.ts"],
     platform: "browser",
     dts: true,
     minify: true,