@abreen/tada 1.8.1 → 1.9.0

package/bin/validators.ts

@@ -80,6 +80,6 @@ export function createSiteConfig({
     themeColor,
     tintHue: Number(tintHue),
     tintAmount: Number(tintAmount),
-    vars: {},
+    vars: { foobar: 123 },
   };
 }

package/build/templates.ts

@@ -122,8 +122,6 @@ export function compileTemplates(
       _.template(fs.readFileSync(filePath, 'utf-8'))({
         vars: siteVariables.vars || {},
         site: siteVariables,
-        base: siteVariables.base,
-        basePath: siteVariables.basePath,
       }),
     );
 

package/build/utils/render.ts

@@ -24,6 +24,7 @@ import {
   toPosix,
   toUrlPath,
 } from './paths';
+import { applySourceTemplate } from './source-template';
 import pkg from '../../package.json' with { type: 'json' };
 import { parseFrontMatterAndContent } from './front-matter';
 import { createMarkdown } from './markdown';
@@ -130,8 +131,6 @@ function createTemplateParameters({
     vars: siteVariables.vars || {},
     ...createGlobals(pageVariables, siteVariables, subPath),
     site: siteVariables,
-    base: siteVariables.base,
-    basePath: siteVariables.basePath,
     page: pageVariables,
     content,
     applyBasePath,
@@ -282,7 +281,8 @@ export function renderCodePageAsset({
   const subPath = toPosix(path.relative(contentDir, path.join(dir, name)));
   const applyBasePath = createApplyBasePath(siteVariables);
   const lang = siteVariables.codeLanguages![ext.slice(1).toLowerCase()];
-  const sourceCode = fs.readFileSync(filePath, 'utf-8');
+  const rawSource = fs.readFileSync(filePath, 'utf-8');
+  const sourceCode = applySourceTemplate(rawSource, siteVariables, filePath);
   const pageDirPath = toPosix(path.relative(contentDir, dir));
 
   log.info`Rendering code page ${B`${subPath + ext}`}`;
@@ -346,20 +346,26 @@ export function renderCopiedContentAsset({
 
   log.info`${label} ${B`${relPath}`}`;
 
-  if (filePath.endsWith('.java') && isFeatureEnabled(siteVariables, 'code')) {
-    const sourceCode = fs.readFileSync(filePath, 'utf-8');
+  if (!isFeatureEnabled(siteVariables, 'code')) {
+    return [{ assetPath: relPath, content: fs.readFileSync(filePath) }];
+  }
+
+  const rawSource = fs.readFileSync(filePath, 'utf-8');
+  const templated = applySourceTemplate(rawSource, siteVariables, filePath);
+
+  if (filePath.endsWith('.java')) {
     const pageDirPath = toPosix(
       path.relative(contentDir, path.dirname(filePath)),
     );
     const rewrittenLines = rewriteProseLinks(
-      sourceCode.split('\n'),
+      templated.split('\n'),
       siteVariables,
       pageDirPath,
     );
     return [{ assetPath: relPath, content: rewrittenLines.join('\n') }];
   }
 
-  return [{ assetPath: relPath, content: fs.readFileSync(filePath) }];
+  return [{ assetPath: relPath, content: templated }];
 }
 
 /** Parses the file, renders using template, returns HTML & params used to generate page */

package/build/utils/source-template.ts

@@ -0,0 +1,27 @@
+import _ from 'lodash';
+import type { SiteVariables } from '../types';
+
+/**
+ * Applies Lodash template syntax to a source code file's contents so that
+ * authors can interpolate site variables (like `<%= vars.fullCourseName %>`)
+ * in their source code. The template context mirrors the one used for JSON
+ * data files in `build/templates.ts`: `vars` and `site`. Invoked from
+ * `renderCodePageAsset` and `renderCopiedContentAsset` only when
+ * `features.code` is enabled.
+ */
+export function applySourceTemplate(
+  source: string,
+  siteVariables: SiteVariables,
+  filePath: string,
+): string {
+  const params = { vars: siteVariables.vars || {}, site: siteVariables };
+
+  try {
+    return _.template(source)(params);
+  } catch (err: unknown) {
+    throw new Error(
+      `${filePath}: Lodash template error in source code: ${(err as Error).message}`,
+      { cause: err },
+    );
+  }
+}

package/init/content/lectures/01/Rectangle.java

@@ -4,6 +4,8 @@
 /// by scaling using a _scale factor_ (a floating-point number between 0 and 1).
 ///
 /// See [`rectangle.py`](./rectangle.py) for a Python version of this class.
+///
+/// Here's `vars.foobar`: <%= vars.foobar %>
 public class Rectangle {
     private int width;
     private int height;

package/init/content/lectures/01/index.md

@@ -8,6 +8,12 @@ author: alex
 
 Here is a sample description of the topics covered at the first lecture.
 
+The value of `vars.foobar` is <%= vars.foobar %>.
+
+You can add any variables you want to the `site.dev.json` and `site.prod.json`
+files under the `"vars"` property and access them using Lodash template syntax
+from Markdown files, HTML files, and source code. (Lodash template subtitution
+only works in source code files when `features.code` is `true`.)
 
 ## Slides
 

package/init/content/lectures/01/rectangle.py

@@ -1,3 +1,8 @@
+#
+# rectangle.py
+#
+# Here's vars.foobar: <%= vars.foobar %>
+#
 class Rectangle:
     """A rectangle with integer side lengths.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abreen/tada",
-  "version": "1.8.1",
+  "version": "1.9.0",
   "type": "module",
   "description": "A static site generator",
   "license": "MIT",