@anja.codes/vitakit 0.1.0 → 0.3.0

package/src/bin/vitakit.mjs

@@ -1,158 +1,8 @@
 #!/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.
+ * The vitakit command; see `pnpm vitakit --help` or docs/cli/.
  */
 import process from 'node:process'
-import { relative } from 'node:path'
-import { addSection, eject, listEjectable } from '../../dist/cli.mjs'
+import { main } 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)
-}
+process.exitCode = await main(process.argv.slice(2))

package/dist/shared/vitakit.BRhjqpAt.mjs

@@ -1,250 +0,0 @@
-import { readdir, readFile, mkdir, writeFile } from 'node:fs/promises';
-import { existsSync } from 'node:fs';
-import { basename, join } from 'node:path';
-import { Eta } from 'eta';
-import { m as fail, p as formatZodIssues, k as atMost, o as resolveAsset, n as isSitePath } from './vitakit.BxcnlFGP.mjs';
-import { entrySecondaryParts, entryTitleField, formatDateRange } from './index.mjs';
-import { r as richSource } from './vitakit.BlU-p01e.mjs';
-import { parse } from 'yaml';
-import { z } from 'zod';
-
-const REPLACEMENTS = {
-  "\\": "\\textbackslash{}",
-  "&": "\\&",
-  "%": "\\%",
-  $: "\\$",
-  "#": "\\#",
-  _: "\\_",
-  "{": "\\{",
-  "}": "\\}",
-  "~": "\\textasciitilde{}",
-  "^": "\\textasciicircum{}"
-};
-const TYPOGRAPHY = [
-  // Directional quotes: "..." -> ``...''
-  [/"([^"]*)"/g, "``$1''"],
-  // An en dash written literally
-  [/\u2013/g, "--"],
-  [/\u2014/g, "---"],
-  [/\u2026/g, "\\ldots{}"],
-  [/\u00a0/g, "~"]
-];
-function escapeTex(value, { typography = true, source } = {}) {
-  if (source !== void 0 && /(?<!\\)\$/.test(value)) {
-    throw new Error(`unbalanced math delimiters in: ${source}`);
-  }
-  let result = value.replace(/[\\&%$#_{}~^]/g, (character) => REPLACEMENTS[character]);
-  if (typography) {
-    for (const [pattern, replacement] of TYPOGRAPHY) result = result.replace(pattern, replacement);
-  }
-  return result;
-}
-function escapeRichTex(value) {
-  const parts = [];
-  const pattern = /\$\$[\s\S]*?\$\$|\$(?:\\.|[^$\\])*\$/g;
-  let index = 0;
-  for (const match of value.matchAll(pattern)) {
-    const start = match.index;
-    parts.push(escapeTex(value.slice(index, start), { source: value }));
-    parts.push(match[0]);
-    index = start + match[0].length;
-  }
-  parts.push(escapeTex(value.slice(index), { source: value }));
-  return parts.join("");
-}
-const URL_SPECIAL = /%[0-9A-Fa-f]{2}|[%\\{}^ #&]/g;
-function escapeUrl(value) {
-  return value.replace(URL_SPECIAL, (match) => {
-    if (match.length === 3 || match === "#" || match === "&") return `\\${match}`;
-    return `\\%${match.charCodeAt(0).toString(16).toUpperCase().padStart(2, "0")}`;
-  });
-}
-
-const sectionOptions = z.strictObject({
-  /**
-   * Keep entries whose field equals the value, or one of several values:
-   *
-   * ```yaml
-   * where: { kind: invited }
-   * where: { kind: [invited, seminar] }
-   * ```
-   */
-  where: z.record(z.string(), z.union([z.string(), z.array(z.string()).min(1)])).default({}),
-  /** Keep only the newest N entries. */
-  limit: z.number().int().positive().optional(),
-  /** Drop entries starting before this year. */
-  since: z.number().int().optional(),
-  /** Drop entries starting after this year. */
-  until: z.number().int().optional(),
-  /** Heading used by `\vitasection`; defaults to the section id, capitalised. */
-  title: z.string().min(1).optional()
-});
-const documentSchema = z.strictObject({
-  /**
-   * Highest visibility level this document may include. Defaults to `cv`,
-   * because a CV is the reason the `cv` level exists; use `private` for an
-   * application containing a cover letter, address or referees.
-   *
-   * There is no "publish this PDF" option: PDFs are never part of the website
-   * build (see `vitakit-check`), and the website renders CV data directly.
-   */
-  visibility: z.enum(["public", "cv", "private"]).default("cv"),
-  sections: z.record(z.string(), sectionOptions).default({}),
-  publications: z.strictObject({
-    groups: z.array(z.string()).optional()
-  }).default({})
-});
-const DEFAULTS = documentSchema.parse({});
-async function discoverDocuments(cvDir) {
-  const files = (await readdir(cvDir).catch(() => fail("cv-tex/", "directory is missing"))).filter((name) => name.endsWith(".tex")).sort();
-  const documents = [];
-  for (const file of files) {
-    const name = basename(file, ".tex");
-    const source = await readFile(join(cvDir, file), "utf8");
-    if (!/\\begin\{document\}/.test(source)) continue;
-    const optionsFile = join(cvDir, `${name}.yml`);
-    const raw = await readFile(optionsFile, "utf8").catch(() => void 0);
-    let options = DEFAULTS;
-    if (raw !== void 0) {
-      const parsed = documentSchema.safeParse(parse(raw) ?? {});
-      if (!parsed.success) fail(`cv-tex/${name}.yml`, `invalid
-${formatZodIssues(parsed.error)}`);
-      options = parsed.data;
-    }
-    documents.push({ name, texFile: join(cvDir, file), options });
-  }
-  if (!documents.length) fail("cv-tex/", "no .tex file contains \\begin{document}");
-  return documents;
-}
-function valueOf(entry, field) {
-  if (field === "year") return entry.date?.from?.year;
-  const value = entry[field];
-  if (typeof value === "object" && value !== null && "text" in value) return value.text;
-  if (typeof value === "object" && value !== null && "name" in value) return value.name;
-  return value;
-}
-function selectEntries(entries, options, sectionId) {
-  const section = options.sections[sectionId] ?? { where: {} };
-  let result = entries.filter((entry) => atMost(entry.visibility, options.visibility));
-  if (section.since !== void 0) {
-    result = result.filter((entry) => Number(valueOf(entry, "year") ?? 0) >= section.since);
-  }
-  if (section.until !== void 0) {
-    result = result.filter((entry) => Number(valueOf(entry, "year") ?? Infinity) <= section.until);
-  }
-  for (const [field, expected] of Object.entries(section.where ?? {})) {
-    const wanted = new Set(Array.isArray(expected) ? expected : [expected]);
-    result = result.filter((entry) => wanted.has(String(valueOf(entry, field) ?? "")));
-  }
-  return section.limit ? result.slice(0, section.limit) : result;
-}
-
-const bundledTexDir = resolveAsset("tex");
-const eta = new Eta({ autoEscape: false, autoTrim: [false, false] });
-function tidy(body) {
-  return body.replace(/[ \t]+$/gm, "").replace(/\n{2,}/g, "\n").trim();
-}
-const SITE_PATH_HELP = "is a path on the website, and the PDF can only link it with the address the site is published at: add it to content/profile.yml, e.g. `url: https://jane.example.org/`";
-function helpers(where, source) {
-  const tex = (value) => value === void 0 || value === null ? "" : escapeTex(String(value));
-  const rich = (value) => {
-    if (value === void 0 || value === null) return "";
-    const source2 = richSource(value);
-    try {
-      return escapeRichTex(source2);
-    } catch (error) {
-      return fail(where, error instanceof Error ? error.message : String(error));
-    }
-  };
-  const href = (value) => {
-    if (isSitePath(value)) fail(source, `${value} ${SITE_PATH_HELP}`);
-    return escapeUrl(value);
-  };
-  const url = (value) => value ? href(String(value)) : "";
-  const inst = (value) => {
-    const institution = value;
-    if (!institution?.name) return "";
-    return institution.url ? `\\href{${href(institution.url)}}{${escapeTex(institution.name)}}` : escapeTex(institution.name);
-  };
-  const linkOrText = (value) => {
-    if (typeof value === "string") return escapeTex(value);
-    const item = value;
-    if (!item?.label) return "";
-    return item.url ? `\\href{${href(item.url)}}{${escapeTex(item.label)}}` : escapeTex(item.label);
-  };
-  const date = (value) => escapeTex(formatDateRange(value));
-  const term = (entry) => typeof entry.term === "string" ? escapeTex(entry.term) : date(entry.date);
-  const titleOf = (entry) => {
-    const field = entryTitleField(entry);
-    return field ? entry[field] : "";
-  };
-  const secondaryOf = (entry) => entrySecondaryParts(entry, entryTitleField(entry)).map((part) => part.kind === "institution" ? inst(part.institution) : escapeTex(part.text)).filter(Boolean).join(", ");
-  const bibgroup = (group) => {
-    const unsafe = /[\s%#\\{},~]/;
-    const bad = [group.id, ...group.entries.map((entry) => entry.key)].find((value) => !value || unsafe.test(value));
-    if (bad !== void 0) {
-      fail(where, `"${bad}" cannot be used as a citation key or group id in LaTeX; use letters, digits and - _ : . / +`);
-    }
-    return `\\vitabibgroup{${group.id}}{${group.entries.map((entry) => entry.key).join(",")}}`;
-  };
-  return { tex, rich, url, inst, linkOrText, date, term, titleOf, secondaryOf, bibgroup };
-}
-async function resolveTemplate(id, userDir) {
-  const candidates = [join(userDir, `${id}.eta`), join(bundledTexDir, "templates", `${id}.eta`), join(bundledTexDir, "templates", "_generic.eta")];
-  for (const path of candidates) {
-    if (existsSync(path)) return { path, source: await readFile(path, "utf8") };
-  }
-  throw new Error(`vitakit: no template for section ${id}`);
-}
-async function assertTemplatesAreUsed(templateDir, ids) {
-  const files = await readdir(templateDir).catch(() => []);
-  const known = /* @__PURE__ */ new Set([...ids, "publications", "_generic"]);
-  for (const file of files.filter((name) => name.endsWith(".eta")).sort()) {
-    const id = file.slice(0, -".eta".length);
-    if (known.has(id)) continue;
-    const suggestion = ids.find((candidate) => candidate.startsWith(id) || id.startsWith(candidate));
-    fail(
-      `cv-tex/templates/${file}`,
-      `no section is called "${id}", so this template is never used${suggestion ? `; did you mean ${suggestion}.eta?` : ""}
-  sections: ${ids.join(", ") || "(none)"}`
-    );
-  }
-}
-async function emitDocument(emit) {
-  await mkdir(emit.outDir, { recursive: true });
-  await assertTemplatesAreUsed(emit.templateDir, Object.keys(emit.sections));
-  const written = [];
-  for (const [id, entries] of Object.entries(emit.sections)) {
-    const where = `cv-tex/generated/${id}.tex`;
-    const selected = selectEntries(entries, emit.options, id);
-    const { source } = await resolveTemplate(id, emit.templateDir);
-    let body;
-    try {
-      body = tidy(eta.renderString(source, { entries: selected, ...helpers(where, `content/${id}.yml`) }));
-    } catch (error) {
-      throw new Error(`template ${id}.eta: ${error instanceof Error ? error.message : String(error)}`, { cause: error });
-    }
-    const file = join(emit.outDir, `${id}.tex`);
-    await writeFile(file, `% Generated by vitakit. Do not edit; edit content/${id}.yml instead.
-${body.trim()}
-`);
-    written.push(file);
-  }
-  if (emit.publications.length) {
-    const groups = emit.options.publications.groups ? emit.options.publications.groups.map((id) => emit.publications.find((group) => group.id === id)).filter((group) => group !== void 0) : emit.publications;
-    if (!emit.siteUrl) {
-      const local = groups.flatMap((group) => group.entries).find((entry) => entry.titleUrl && isSitePath(entry.titleUrl));
-      if (local) fail("content/publications.bib", `${local.key}: url ${local.titleUrl} ${SITE_PATH_HELP}`);
-    }
-    const { source } = await resolveTemplate("publications", emit.templateDir);
-    const body = tidy(eta.renderString(source, { groups, ...helpers("publications.tex", "content/publications.bib") }));
-    const file = join(emit.outDir, "publications.tex");
-    await writeFile(file, `% Generated by vitakit. Do not edit; edit content/publications.bib instead.
-${body.trim()}
-`);
-    written.push(file);
-  }
-  return written;
-}
-
-export { SITE_PATH_HELP as S, escapeTex as a, bundledTexDir as b, escapeUrl as c, discoverDocuments as d, emitDocument as e, documentSchema as f, escapeRichTex as g, selectEntries as s };