@anja.codes/vitakit 0.4.0 → 0.5.0

package/dist/chunks/build.mjs

@@ -1,8 +1,8 @@
 import { spawn } from 'node:child_process';
 import { mkdir, readFile, writeFile, rm, copyFile, rename } from 'node:fs/promises';
-import { existsSync } from 'node:fs';
+import { existsSync, readFileSync } from 'node:fs';
 import process from 'node:process';
-import { join, delimiter, resolve } from 'node:path';
+import { join, delimiter, resolve, extname } from 'node:path';
 import { l as loadContent } from '../shared/vitakit.DteA9vLy.mjs';
 import { f as fail } from '../shared/vitakit.DCK90zq4.mjs';
 import { discoverDocuments, validateDocumentSections, selectEntries } from './documents.mjs';
@@ -74,7 +74,7 @@ Full log: ${log}` : ""}`));
     });
   });
 }
-function profilePreamble(content, document, lists) {
+function profilePreamble(content, document, lists, cvDir) {
   const { profile } = content;
   const href = (url) => {
     if (isSitePath(url)) fail("content/profile.yml", `links: ${url} ${SITE_PATH_HELP}`);
@@ -91,6 +91,7 @@ function profilePreamble(content, document, lists) {
     `\\vitaname{${escapeTex(profile.name)}}`,
     `\\vitatagline{${tagline}}`,
     `\\vitacontact{${contact}}`,
+    ...portraitLine(content, document, cvDir),
     ...profile.url ? siteUrlSourcemap(profile.url) : [],
     ...Object.entries(content.sections).flatMap(([id, entries]) => {
       const title = document.options.sections[id]?.title;
@@ -103,6 +104,30 @@ function profilePreamble(content, document, lists) {
     ""
   ].join("\n");
 }
+const PORTRAIT_FORMATS = [".jpg", ".jpeg", ".png", ".pdf"];
+function portraitLine(content, document, cvDir) {
+  const option = document.options.portrait;
+  if (option === false) return [];
+  const where = `cv-tex/${document.name}.yml`;
+  const path = option === true ? content.profile.avatar : option;
+  if (!path) {
+    fail(where, "portrait: true shows avatar from content/profile.yml, which has none; add one there, or give the image here, e.g. portrait: /img/portrait.jpg");
+  }
+  const what = option === true ? `portrait: true shows avatar ${path} (content/profile.yml)` : `portrait: ${path}`;
+  const format = extname(path).toLowerCase();
+  if (!PORTRAIT_FORMATS.includes(format)) {
+    fail(where, `${what}, but LaTeX cannot include ${format ? `a ${format} file` : "a file without an extension"}; use a JPG, PNG or PDF${option === true ? ", e.g. portrait: /img/portrait.jpg" : ""}`);
+  }
+  if (!/^[\w./-]+$/.test(path) || path.split("/").includes("..")) {
+    fail(where, `${what}: the path may only contain letters, digits and - . _ /`);
+  }
+  if (!existsSync(join(cvDir, "..", "public", path))) fail(where, `${what}: public${path} does not exist`);
+  const ejected = join(cvDir, CLASS_FILE);
+  if (existsSync(ejected) && !readFileSync(ejected, "utf8").includes("\\vitaportrait")) {
+    fail(where, `portrait needs \\vitaportrait, which cv-tex/${CLASS_FILE} does not define: it was ejected from an earlier vitakit. Run vitakit eject vitakit-cv.cls --force for the current class (your copy is kept as a backup), or remove portrait`);
+  }
+  return [`\\vitaportrait{../public${path}}`];
+}
 function siteUrlSourcemap(siteUrl) {
   const base = siteUrl.replace(/\/?$/, "/");
   if (!/^https?:\/\/[\w.:/-]+$/.test(base)) {
@@ -125,7 +150,7 @@ async function buildDocument(document, content, options, cvDir) {
     templateDir: join(cvDir, "templates"),
     outDir
   });
-  await writeFile(join(outDir, "profile.tex"), profilePreamble(content, document, lists));
+  await writeFile(join(outDir, "profile.tex"), profilePreamble(content, document, lists, cvDir));
   const generatedClass = join(outDir, CLASS_FILE);
   if (existsSync(join(cvDir, CLASS_FILE))) await rm(generatedClass, { force: true });
   else await copyFile(join(bundledTexDir, CLASS_FILE), generatedClass);

package/dist/chunks/documents.mjs

@@ -38,6 +38,13 @@ const documentSchema = z.strictObject({
    * build (see `vitakit verify`), and the website renders CV data directly.
    */
   visibility: z.enum(["public", "cv", "private"]).default("cv"),
+  /**
+   * A portrait beside the header: `true` for `avatar` from
+   * `content/profile.yml`, or a path below `public/` for another image, e.g.
+   * a print version. Off by default: whether a CV shows a photo depends on
+   * where it is sent, so each document decides.
+   */
+  portrait: z.union([z.boolean(), z.string().startsWith("/")]).default(false),
   sections: z.record(z.string(), sectionOptions).default({})
 });
 const DEFAULTS = documentSchema.parse({});

package/dist/tex/vitakit-cv.cls

@@ -27,6 +27,7 @@
 \RequirePackage{xcolor}
 \RequirePackage{titlesec}
 \RequirePackage{amsmath,amssymb}
+\RequirePackage{graphicx}
 \RequirePackage{hyperref}
 
 %% --- bibliography ---------------------------------------------------------
@@ -76,13 +77,38 @@
 \newcommand{\vitaname}[1]{\def\vita@name{#1}}
 \newcommand{\vitatagline}[1]{\def\vita@tagline{#1}}
 \newcommand{\vitacontact}[1]{\def\vita@contact{#1}}
-\vitaname{} \vitatagline{} \vitacontact{}
+%% `portrait` in the document's .yml: the image, relative to cv-tex/.
+\newcommand{\vitaportrait}[1]{\def\vita@portrait{#1}}
+\vitaname{} \vitatagline{} \vitacontact{} \vitaportrait{}
 
-\newcommand{\vitaheader}{%
-  \begingroup
+%% The portrait's height in \vitaheader. It is never wider than a quarter of
+%% the line. \setlength{\vitaportraitheight}{4cm} in preamble.tex changes it.
+\newlength{\vitaportraitheight}
+\setlength{\vitaportraitheight}{3cm}
+\newsavebox{\vita@portraitbox}
+
+\newcommand{\vita@headertext}{%
   \noindent{\LARGE\bfseries\vita@name}\par
   \ifx\vita@tagline\empty\else\vspace{0.2em}\noindent{\color{vitamuted}\vita@tagline}\par\fi
-  \ifx\vita@contact\empty\else\vspace{0.2em}\noindent{\small\vita@contact}\par\fi
+  \ifx\vita@contact\empty\else\vspace{0.2em}\noindent{\small\vita@contact}\par\fi}
+
+%% Name, tagline and contact line; with a portrait, those on the left and the
+%% portrait on the right, both aligned at the top.
+\newcommand{\vitaheader}{%
+  \begingroup
+  \ifx\vita@portrait\empty
+    \vita@headertext
+  \else
+    \sbox{\vita@portraitbox}{\includegraphics[height=\vitaportraitheight,
+      width=0.25\linewidth, keepaspectratio]{\vita@portrait}}%
+    \noindent
+    \begin{minipage}[t]{\dimexpr\linewidth-\wd\vita@portraitbox-1.5em\relax}
+      \vspace{0pt}\vita@headertext
+    \end{minipage}\hfill
+    \begin{minipage}[t]{\wd\vita@portraitbox}
+      \vspace{0pt}\usebox{\vita@portraitbox}
+    \end{minipage}\par
+  \fi
   \vspace{1em}\hrule\vspace{1.5em}
   \endgroup}
 

package/dist/tex.d.mts

@@ -59,6 +59,7 @@ declare const documentSchema: z.ZodObject<{
         cv: "cv";
         private: "private";
     }>>;
+    portrait: z.ZodDefault<z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>>;
     sections: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodObject<{
         where: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>]>>>;
         limit: z.ZodOptional<z.ZodNumber>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@anja.codes/vitakit",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Structured CV data in, academic website and LaTeX CV out.",
   "license": "MIT",
   "keywords": [