@anja.codes/vitakit 0.1.0

package/dist/tex.mjs

@@ -0,0 +1,129 @@
+import { spawn } from 'node:child_process';
+import { mkdir, readFile, writeFile, rm, copyFile, rename } from 'node:fs/promises';
+import { existsSync } from 'node:fs';
+import process from 'node:process';
+import { join, delimiter } from 'node:path';
+import { l as loadContent, a as loadPublicationsSchema } from './shared/vitakit.CypCF-4Q.mjs';
+import { m as fail, n as isSitePath } from './shared/vitakit.BxcnlFGP.mjs';
+import { d as discoverDocuments, e as emitDocument, b as bundledTexDir, a as escapeTex, c as escapeUrl, S as SITE_PATH_HELP } from './shared/vitakit.BRhjqpAt.mjs';
+export { f as documentSchema, g as escapeRichTex, s as selectEntries } from './shared/vitakit.BRhjqpAt.mjs';
+import 'gray-matter';
+import 'yaml';
+import 'unified';
+import 'remark-parse';
+import 'remark-gfm';
+import 'remark-math';
+import 'remark-rehype';
+import 'rehype-katex';
+import 'rehype-raw';
+import 'rehype-stringify';
+import 'unist-util-visit';
+import '@behackl/citation-js-extras';
+import 'rehype-parse';
+import 'rehype-sanitize';
+import 'zod';
+import 'node:url';
+import 'eta';
+import './shared/index.mjs';
+import './shared/vitakit.BlU-p01e.mjs';
+
+const CLASS_FILE = "vitakit-cv.cls";
+function run(command, args, cwd, env = {}) {
+  return new Promise((resolve, reject) => {
+    const child = spawn(command, args, { cwd, stdio: "inherit", env: { ...process.env, ...env } });
+    child.on("error", (error) => reject(
+      error.code === "ENOENT" ? new Error(`${command} not found. Install a TeX distribution, or use --no-pdf to only generate .tex files.`) : error
+    ));
+    child.on("exit", (code) => code === 0 ? resolve() : reject(new Error(`${command} exited with code ${code}`)));
+  });
+}
+function profilePreamble(content) {
+  const { profile } = content;
+  const href = (url) => {
+    if (isSitePath(url)) fail("content/profile.yml", `links: ${url} ${SITE_PATH_HELP}`);
+    return escapeUrl(url);
+  };
+  const affiliation = profile.affiliation?.name ? escapeTex(profile.affiliation.name) : "";
+  const tagline = [profile.title && escapeTex(profile.title), affiliation].filter(Boolean).join(", ");
+  const contact = [
+    profile.email && `\\href{mailto:${escapeUrl(profile.email)}}{${escapeTex(profile.email)}}`,
+    ...profile.links.map((link) => `\\href{${href(link.url)}}{${escapeTex(link.label)}}`)
+  ].filter(Boolean).join(" \\quad ");
+  return [
+    "% Generated by vitakit. Do not edit; edit content/profile.yml instead.",
+    `\\vitaname{${escapeTex(profile.name)}}`,
+    `\\vitatagline{${tagline}}`,
+    `\\vitacontact{${contact}}`,
+    ...profile.url ? siteUrlSourcemap(profile.url) : [],
+    ""
+  ].join("\n");
+}
+function siteUrlSourcemap(siteUrl) {
+  const base = siteUrl.replace(/\/?$/, "/");
+  if (!/^https?:\/\/[\w.:/-]+$/.test(base)) {
+    fail("content/profile.yml", `url: ${siteUrl} may only contain letters, digits and - . _ : /`);
+  }
+  return [
+    "\\ifdefined\\DeclareSourcemap",
+    `  \\DeclareSourcemap{\\maps[datatype=bibtex]{\\map{\\step[fieldsource=url, match=\\regexp{\\A/}, replace={${base}}]}}}`,
+    "\\fi"
+  ];
+}
+async function buildDocument(document, content, options, cvDir) {
+  const outDir = join(cvDir, "generated", document.name);
+  await emitDocument({
+    sections: content.sections,
+    publications: content.publications,
+    siteUrl: content.profile.url,
+    options: document.options,
+    templateDir: join(cvDir, "templates"),
+    outDir
+  });
+  await writeFile(join(outDir, "profile.tex"), profilePreamble(content));
+  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);
+  if (options.noPdf) return;
+  const relativeOut = join("generated", document.name);
+  await run("latexmk", [
+    "-pdf",
+    "-halt-on-error",
+    "-interaction=nonstopmode",
+    `-outdir=${relativeOut}`,
+    `${document.name}.tex`
+  ], cvDir, {
+    // A trailing delimiter keeps the standard search paths.
+    TEXINPUTS: `.${delimiter}${relativeOut}${delimiter}${process.env.TEXINPUTS ?? ""}`
+  });
+  await rename(join(outDir, `${document.name}.pdf`), join(cvDir, `${document.name}.pdf`));
+}
+async function buildCv(options) {
+  const cvDir = join(options.rootDir, "cv-tex");
+  if (!existsSync(cvDir)) {
+    throw new Error(`no cv-tex/ directory in ${options.rootDir}`);
+  }
+  const content = await loadContent(options.rootDir, { strict: true, maxVisibility: "private", target: "pdf" });
+  const documents = await discoverDocuments(cvDir);
+  const groups = (await loadPublicationsSchema(options.rootDir)).groups.map((group) => group.id);
+  for (const document of documents) {
+    const unknown = (document.options.publications.groups ?? []).filter((id) => !groups.includes(id));
+    if (unknown.length) {
+      fail(`cv-tex/${document.name}.yml`, `publications.groups: unknown group ${unknown.join(", ")}; the groups are ${groups.join(", ")} (schemas/publications.ts)`);
+    }
+  }
+  const selected = options.only?.length ? documents.filter((document) => options.only.includes(document.name)) : documents;
+  if (!selected.length) {
+    const known = documents.map((document) => document.name).join(", ");
+    throw new Error(`no document matched ${options.only?.join(", ")}; available: ${known}`);
+  }
+  await mkdir(join(cvDir, "generated"), { recursive: true });
+  for (const document of selected) {
+    await buildDocument(document, content, options, cvDir);
+  }
+  return selected.map((document) => join(cvDir, `${document.name}.pdf`));
+}
+async function readGenerated(rootDir, document, section) {
+  return readFile(join(rootDir, "cv-tex", "generated", document, `${section}.tex`), "utf8");
+}
+
+export { buildCv, bundledTexDir, discoverDocuments, emitDocument, escapeTex, escapeUrl, readGenerated };

package/package.json

@@ -0,0 +1,121 @@
+{
+  "name": "@anja.codes/vitakit",
+  "version": "0.1.0",
+  "description": "Structured CV data in, academic website and LaTeX CV out.",
+  "license": "MIT",
+  "keywords": [
+    "cv",
+    "academic",
+    "nuxt",
+    "nuxt-module",
+    "latex",
+    "bibtex",
+    "katex",
+    "static-site"
+  ],
+  "homepage": "https://github.com/anja-codes/vitakit#readme",
+  "bugs": {
+    "url": "https://github.com/anja-codes/vitakit/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/anja-codes/vitakit.git"
+  },
+  "type": "module",
+  "packageManager": "pnpm@10.29.1",
+  "engines": {
+    "node": ">=22.18"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs"
+    },
+    "./nuxt": {
+      "types": "./dist/nuxt.d.mts",
+      "import": "./dist/nuxt.mjs"
+    },
+    "./runtime/*": "./dist/runtime/*",
+    "./styles/*": "./dist/styles/*",
+    "./tex/*": "./dist/tex/*",
+    "./shared": {
+      "types": "./dist/shared/index.d.mts",
+      "import": "./dist/shared/index.mjs"
+    },
+    "./tex": {
+      "types": "./dist/tex.d.mts",
+      "import": "./dist/tex.mjs"
+    },
+    "./check": {
+      "types": "./dist/check.d.mts",
+      "import": "./dist/check.mjs"
+    },
+    "./cli": {
+      "types": "./dist/cli.d.mts",
+      "import": "./dist/cli.mjs"
+    }
+  },
+  "files": [
+    "dist",
+    "styles",
+    "src/bin",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "unbuild",
+    "prepare": "unbuild",
+    "dev": "unbuild --stub",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "typecheck": "tsc --noEmit",
+    "check": "pnpm typecheck && pnpm test && pnpm build && node scripts/check-dist.mjs && pnpm example:check",
+    "check:dist": "node scripts/check-dist.mjs",
+    "prepublishOnly": "pnpm check",
+    "example": "node scripts/generate-example.mjs",
+    "example:check": "node scripts/generate-example.mjs --check",
+    "check:deps": "node scripts/check-deps.mjs"
+  },
+  "dependencies": {
+    "@behackl/citation-js-extras": "^0.4.0",
+    "@types/hast": "^3.0.5",
+    "citation-js": "^0.7.22",
+    "eta": "^4.6.0",
+    "gray-matter": "^4.0.3",
+    "rehype-katex": "^7.0.1",
+    "rehype-parse": "^9.0.1",
+    "rehype-raw": "^7.0.0",
+    "rehype-sanitize": "^6.0.0",
+    "rehype-stringify": "^10.0.1",
+    "remark-gfm": "^4.0.1",
+    "remark-math": "^6.0.0",
+    "remark-parse": "^11.0.0",
+    "remark-rehype": "^11.1.2",
+    "unified": "^11.0.5",
+    "unist-util-visit": "^5.1.0",
+    "yaml": "^2.8.1",
+    "zod": "^4.5.4"
+  },
+  "peerDependencies": {
+    "@nuxt/kit": "^4.0.0",
+    "nuxt": "^4.0.0"
+  },
+  "devDependencies": {
+    "@nuxt/kit": "^4.5.2",
+    "@nuxt/schema": "^4.5.2",
+    "@types/node": "^26.4.1",
+    "nitropack": "^2.13.4",
+    "typescript": "^5.9.3",
+    "unbuild": "^3.6.1",
+    "vitest": "^5.0.0",
+    "vue": "^3.5.42"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "bin": {
+    "vitakit": "src/bin/vitakit.mjs",
+    "vitakit-check": "src/bin/vitakit-check.mjs",
+    "vitakit-build-cv": "src/bin/vitakit-build-cv.mjs"
+  }
+}

package/src/bin/vitakit-build-cv.mjs

@@ -0,0 +1,50 @@
+#!/usr/bin/env node
+/**
+ * Render content/ into cv-tex/generated/ and typeset it.
+ */
+import process from 'node:process'
+import { buildCv } from '../../dist/tex.mjs'
+
+const HELP = `vitakit-build-cv — build the PDF documents in cv-tex/
+
+Usage
+  pnpm build:cv [document...] [options]
+
+Renders content/ into cv-tex/generated/<document>/, one .tex file per section,
+then runs latexmk. The finished PDF is written next to its source, as
+cv-tex/<document>.pdf; everything else stays in the generated directory.
+
+  pnpm build:cv                  every document in cv-tex/
+  pnpm build:cv cv               just cv.tex
+  pnpm build:cv cv application   several
+
+Options
+  --no-pdf     write the .tex files but do not run latexmk. Useful without a
+               TeX installation, and to inspect what was generated.
+  --help       this text
+
+A document is a .tex file you own; a copy of cv.tex is a new document. What it
+contains is decided by an optional cv-tex/<document>.yml (visibility, which
+entries, how many). See docs/cv-documents.md.
+
+Requires latexmk and biber, from any current TeX distribution.`
+
+const args = process.argv.slice(2)
+
+if (args.includes('--help') || args.includes('-h')) {
+  console.log(HELP)
+  process.exit(0)
+}
+
+const noPdf = args.includes('--no-pdf')
+const only = args.filter(argument => !argument.startsWith('-'))
+
+try {
+  const outputs = await buildCv({ rootDir: process.cwd(), only, noPdf })
+  console.log(noPdf
+    ? `vitakit: generated .tex for ${only.length ? only.join(', ') : 'all documents'}`
+    : `vitakit: built ${outputs.join(', ')}`)
+} catch (error) {
+  console.error(`\nvitakit: ${error instanceof Error ? error.message : String(error)}\n`)
+  process.exit(1)
+}

package/src/bin/vitakit-check.mjs

@@ -0,0 +1,57 @@
+#!/usr/bin/env node
+/**
+ * Assert that the generated site is complete and correct.
+ */
+import process from 'node:process'
+import { checkStatic } from '../../dist/check.mjs'
+
+const HELP = `vitakit-check — verify the generated site
+
+Usage
+  pnpm check:static [--out <dir>]
+
+Run after \`nuxt generate\`; \`pnpm check\` does both. Checks the built HTML,
+not your content, because a schema cannot catch a renderer that silently did
+nothing:
+
+  - every page in content/pages/ was generated
+  - mathematics was typeset, and KaTeX reported no errors
+  - the site was built for the deployment base path (NUXT_APP_BASE_URL), and
+    every link and asset (href, src, srcset, poster, …) stays inside it
+  - every link into the site leads to a file or page that was generated,
+    e.g. slides: /slides/talk.pdf to public/slides/talk.pdf
+  - no entry marked \`visibility: cv\` or \`private\` appears anywhere in the site
+  - the bibliography is fully formatted wherever it is shown
+
+Options
+  --out <dir>      the generated site; defaults to .output/public
+  --no-leak-check  skip the check for cv and private entries. It compares their
+                   titles with the text of every page, so a title that is
+                   legitimately public elsewhere looks like a leak.
+  --help           this text
+
+Reports every problem and exits non-zero if there is one, so it can gate a
+deployment.`
+
+const args = process.argv.slice(2)
+
+if (args.includes('--help') || args.includes('-h')) {
+  console.log(HELP)
+  process.exit(0)
+}
+
+const outIndex = args.indexOf('--out')
+
+const { checked, failures } = await checkStatic({
+  rootDir: process.cwd(),
+  outDir: outIndex === -1 ? undefined : args[outIndex + 1],
+  skipLeakCheck: args.includes('--no-leak-check'),
+})
+
+for (const line of checked) console.log(`  ok  ${line}`)
+if (failures.length) {
+  console.error(`\nvitakit-check: ${failures.length} problem(s):`)
+  for (const failure of failures) console.error(`  \u2716 ${failure}`)
+  process.exit(1)
+}
+console.log('\nvitakit-check: generated site looks correct.')

package/src/bin/vitakit.mjs

@@ -0,0 +1,158 @@
+#!/usr/bin/env node
+/**
+ * The vitakit command. Three subcommands, each of which only writes files you
+ * could have written yourself — see docs/cli.md for why there are not more.
+ */
+import process from 'node:process'
+import { relative } from 'node:path'
+import { addSection, eject, listEjectable } from '../../dist/cli.mjs'
+
+const USAGE = `vitakit — files for a vitakit project
+
+Usage
+  pnpm vitakit <command> [options]
+
+Commands
+  add <name>        set up a new section: content file, schema, component
+  list              show everything that can be ejected
+  eject <name>      copy a package default into your project
+
+Run a command with --help for details and examples.
+
+Related commands, from the same package:
+  pnpm build:cv     render content/ into cv-tex/ and run latexmk
+  pnpm check        typecheck, generate the site, and verify the output
+`
+
+const HELP = {
+  add: `vitakit add <name> — set up a new section
+
+A section is a file in content/, a schema describing what it may contain, and
+usually a component deciding how it looks. This writes whichever of those are
+missing; it never overwrites a file you have.
+
+  pnpm vitakit add outreach
+
+  content/outreach.yml                 your data — edit this first
+  schemas/outreach.ts                  the shape of an entry
+  app/components/OutreachSection.vue   how the entries look
+
+If content/<name>.yml already exists, the schema is drafted from it: field
+types are guessed from your data — dates, URLs, enums, and which fields are
+optional — so you correct a draft instead of writing one.
+
+  pnpm vitakit add outreach            # after writing content/outreach.yml
+
+Options
+  --no-component    do not write a component; the section then renders through
+                    <VitaSection>, which is a fallback rather than a design
+
+Notes
+  The name becomes a file name: lowercase, kebab-case (research-stays).
+  For a built-in section (education, employment, teaching, talks,
+  supervision) you do not need this: create content/<name>.yml and it works.
+  To change what a built-in section may contain, use \`vitakit eject <name>\`.
+
+Afterwards
+  Show it on a page with <OutreachSection /> in app/pages/, or put
+  \\vitasection{outreach} in cv-tex/cv.tex to add it to the PDF.`,
+
+  list: `vitakit list — show everything that can be ejected
+
+Prints each item, what kind of thing it is, and where a copy would land:
+
+  VitaSection       component  -> app/components/VitaSection.vue
+  talks.eta         template   -> cv-tex/templates/talks.eta
+  teaching          schema     -> schemas/teaching.ts
+  publications      schema     -> schemas/publications.ts
+  publications.csl  style      -> content/publications.csl
+  vitakit-cv.cls    class      -> cv-tex/vitakit-cv.cls
+
+  component   how a section looks on the website
+  schema      what a section may contain; for publications, the groups,
+              the links after each reference and the fields passed on
+  template    how a section is written into the PDF
+  style       how publications.bib is formatted on the website (CSL)
+  class       the LaTeX document class: fonts, spacing, the entry macros`,
+
+  eject: `vitakit eject <name> — copy a package default into your project
+
+The copy wins from then on: vitakit always prefers a file in your project over
+its own. This is the only command that exists purely for convenience — the
+files live inside node_modules/.pnpm/…, at a path that changes with every
+update, so copying them by hand is impractical.
+
+  pnpm vitakit eject VitaSection       # restyle how sections look
+  pnpm vitakit eject teaching          # add or remove fields of a section
+  pnpm vitakit eject talks.eta         # change how talks appear in the PDF
+  pnpm vitakit eject publications.csl  # change the citation style of the website
+  pnpm vitakit eject vitakit-cv.cls    # take over the LaTeX document class
+
+Use \`vitakit list\` to see the names.
+
+Options
+  --force           overwrite an existing file
+
+Trade-off
+  An ejected file is yours forever: later improvements to it in vitakit will
+  not reach you. Everything that can carry a bug — validation, rendering,
+  sorting, escaping — stays in the package, so this is usually the right
+  trade, but eject deliberately rather than by default.
+
+Before ejecting a component, check whether CSS is enough: the classes
+(vita-entry, vita-entry__date, …) are styled in app/assets/css/main.css.`,
+}
+
+const [command, ...rest] = process.argv.slice(2)
+const wantsHelp = rest.includes('--help') || rest.includes('-h')
+const root = process.cwd()
+const pascal = name => name.split('-').map(part => part[0].toUpperCase() + part.slice(1)).join('')
+
+try {
+  if (!command || command === '--help' || command === '-h' || command === 'help') {
+    console.log(USAGE)
+    process.exit(command ? 0 : 1)
+  }
+
+  if (!HELP[command]) {
+    throw new Error(`unknown command "${command}".\n\n${USAGE}`)
+  }
+
+  if (wantsHelp) {
+    console.log(HELP[command])
+    process.exit(0)
+  }
+
+  if (command === 'add') {
+    const name = rest.find(argument => !argument.startsWith('-'))
+    if (!name) throw new Error(`missing name.\n\n${HELP.add}`)
+    const written = await addSection(name, root, { component: !rest.includes('--no-component') })
+    for (const file of written) console.log(`  ${file.path.padEnd(34)} ${file.note}`)
+    console.log(`\nShow it with <${pascal(name)}Section /> on a page,`)
+    console.log(`or add \\vitasection{${name}} to cv-tex/cv.tex for the PDF.`)
+  } else if (command === 'list') {
+    const items = await listEjectable()
+    const width = Math.max(...items.map(item => item.name.length))
+    for (const item of items) {
+      console.log(`${item.name.padEnd(width)}  ${item.kind.padEnd(9)}  -> ${item.target}`)
+    }
+    console.log('\nCopy one with `pnpm vitakit eject <name>`; see --help for what each kind does.')
+  } else if (command === 'eject') {
+    const name = rest.find(argument => !argument.startsWith('-'))
+    if (!name) throw new Error(`missing name. Run \`pnpm vitakit list\` to see the options.`)
+    const { item, path } = await eject(name, root, { force: rest.includes('--force') })
+    console.log(`vitakit: wrote ${relative(root, path)}`)
+    const hints = {
+      publications: '  Edit it to change the publication groups, badges or fields; the website,\n'
+        + '  vitakit-check and the PDF all read it from now on.',
+      schema: '  Edit it to change what this section may contain; it now defines the section.',
+      style: '  Edit it, or replace it with any CSL style (e.g. from zotero.org/styles);\n'
+        + '  it formats content/publications.bib on the website from now on.',
+    }
+    const hint = item.kind === 'schema' && item.name === 'publications' ? hints.publications : hints[item.kind]
+    console.log(hint ?? '  It takes precedence over the package copy from now on.')
+  }
+} catch (error) {
+  console.error(`\nvitakit: ${error instanceof Error ? error.message : String(error)}\n`)
+  process.exit(1)
+}