@kirchdev/duxt 0.3.4 → 0.3.5-dev-main.44-5337cc1

package/git-contributors.ts

@@ -0,0 +1,322 @@
+import { execFileSync } from 'node:child_process';
+
+/**
+ * Who wrote something, read out of git.
+ *
+ * TWO SURFACES ASK THIS, and they ask it about different things. A page asks
+ * who touched the file it was parsed from — `modules/git-meta.ts`, indexed by
+ * path. A release asks who wrote the commits it carries — the release history,
+ * indexed by tag. What they share is the part that decides WHO A PERSON IS, and
+ * that is the whole reason this file exists rather than two copies of it: an
+ * identity computed twice is one reader shown as two people on one page and as
+ * one on the next.
+ *
+ * Node-only, and a root module rather than something under `modules/`, for the
+ * reason `repository-root.ts` is one: `sections-changelog.ts` reaches it out of
+ * the Content config, and a Nuxt module drags a type graph that config has no
+ * business resolving.
+ *
+ * NO EMAIL EVER LEAVES THIS FILE. It is the identity every answer below is
+ * keyed by, and it is the one field a commit carries that a published page has
+ * no business republishing: an address in a commit object is between a
+ * repository and whoever clones it, where the same address on a prerendered,
+ * crawled, indexed page is a harvesting target the person never agreed to.
+ * `DuxtContributor` is therefore a name, a count and — where git itself
+ * carries one — a GitHub handle, which is already public by construction.
+ */
+export interface DuxtContributor {
+  name: string;
+  commits: number;
+  username?: string;
+}
+
+/** The fields either caller supplies about one commit. */
+export interface DuxtCommitAuthor {
+  name: string;
+  email: string;
+}
+
+/**
+ * One entry per person, most commits first.
+ *
+ * Identity is the email, not the name — the same person commits as "Titus
+ * Kirch" and as "titus" and would otherwise appear twice. The GitHub username
+ * is read out of a noreply address, which is the only place git actually
+ * carries one; without it there is a name and no avatar, which is the truth.
+ */
+export function contributorsOf(commits: DuxtCommitAuthor[]): DuxtContributor[] {
+  const people = new Map<string, DuxtContributor>();
+
+  for (const commit of commits) {
+    const key = commit.email.toLowerCase();
+    const existing = people.get(key);
+
+    if (existing) {
+      existing.commits += 1;
+      continue;
+    }
+
+    people.set(key, {
+      name: commit.name,
+      commits: 1,
+      username: githubUsername(commit.email)
+    });
+  }
+
+  return [...people.values()].sort((a, b) => b.commits - a.commits);
+}
+
+/** `1234567+octocat@users.noreply.github.com` becomes `octocat`. */
+export function githubUsername(email: string): string | undefined {
+  const match = /^(?:\d+\+)?([^@]+)@users\.noreply\.github\.com$/i.exec(
+    email.trim()
+  );
+
+  return match?.[1];
+}
+
+/**
+ * An address GitHub itself issued to an APP rather than to a person.
+ *
+ * READ, NEVER GUESSED. GitHub writes `<id>+<app>[bot]@users.noreply.github.com`
+ * for every app installation, so the marker is the forge's own and not a
+ * taxonomy of ours — the same standard the changelog's group names are held to.
+ * The EMAIL is tested rather than the display name, because the email is
+ * already the identity above and a person may call themselves anything.
+ *
+ * Read by the RELEASE history and not by the page history, which is a scope
+ * line rather than an inconsistency: the issue this answers asks a release to
+ * name the people who wrote it, and this repository's own releases would
+ * otherwise each open with the bot that cut them. Whether "last touched by"
+ * should read the same way is a question about another surface.
+ */
+export function isGitHubApp(author: DuxtCommitAuthor): boolean {
+  return /\[bot\]@users\.noreply\.github\.com$/i.test(author.email.trim());
+}
+
+/**
+ * The unit separator, not a comma or a pipe.
+ *
+ * An author name may hold anything a person is called and a decoration list is
+ * comma-separated prose; the one byte that cannot appear in either is one git
+ * will emit for us with `%x1f`.
+ */
+const SEPARATOR = '\u001f';
+
+/** The record separator, marking where one commit's line begins. */
+const RECORD = '\u0001';
+
+/** The fields one record carries, in order. */
+const FORMAT = `${RECORD}%P${SEPARATOR}%an${SEPARATOR}%ae${SEPARATOR}%D`;
+
+/** What git is asked, and the whole of why each flag is there. */
+const ARGUMENTS = [
+  'log',
+  // FROM THE TAGS, NOT FROM `HEAD`. A release tag is cut on the release branch,
+  // so on an integration branch — which is what every pull request builds — all
+  // but the oldest are unreachable and the history comes back empty. Walking
+  // the tags also excludes, for free, the commits no release carries yet:
+  // bucketing those into the newest tag would credit people for work that has
+  // not shipped.
+  '--tags',
+  // Keeps a merged branch's commits together instead of letting their commit
+  // dates interleave them with another line of history. It is what makes the
+  // walk below equal to one `rev-list <previous>..<tag>` per release without
+  // paying for one `git` process per release.
+  '--topo-order',
+  '--decorate=short',
+  '--decorate-refs=refs/tags/*',
+  `--format=${FORMAT}`
+];
+
+/**
+ * Every release tag, with the people whose commits it carries.
+ *
+ * ONE `git log` FOR THE WHOLE HISTORY, walked newest-first: a commit carrying a
+ * tag OPENS that tag's release, and every commit after it in the walk belongs
+ * there until the next tag opens the release before it. That is exactly the
+ * range `<previous tag>..<tag>` names, and the alternative — a `git log` per
+ * release — is the cost `modules/git-meta.ts` already paid once: the work is
+ * never the history, it is spawning the processes.
+ *
+ * A MERGE COMMIT SETS THE BOUNDARY AND CREDITS NOBODY. It has to be walked,
+ * because release-please tags the merge commit its release pull request
+ * produced and skipping it would lose the boundary altogether; it introduces no
+ * change of its own, so its author did not write the diff the release carries.
+ * The page history arrives at the same answer by another route — `--name-status`
+ * prints nothing for a merge — which is why the two surfaces agree about it.
+ */
+export function parseReleaseContributors(
+  output: string
+): Map<string, DuxtContributor[]> {
+  const commits = new Map<string, DuxtCommitAuthor[]>();
+  const contributors = new Map<string, DuxtContributor[]>();
+
+  /** The tags whose release the commits now being read belong to. */
+  let current: string[] = [];
+
+  for (const record of output.split(RECORD)) {
+    if (!record.trim()) continue;
+
+    const [parents, name, email, decoration] = record
+      .split('\n')[0]!
+      .split(SEPARATOR);
+
+    const tags = tagsOf(decoration ?? '');
+
+    if (tags.length) {
+      current = tags;
+      for (const tag of tags) commits.set(tag, commits.get(tag) ?? []);
+    }
+
+    if (!current.length) continue;
+
+    // A merge carries more than one parent. It opened the release above and
+    // says nothing else.
+    if ((parents ?? '').trim().includes(' ')) continue;
+
+    const author = { name: name ?? '', email: email ?? '' };
+    if (isGitHubApp(author)) continue;
+
+    for (const tag of current) commits.get(tag)!.push(author);
+  }
+
+  for (const [tag, authors] of commits) {
+    contributors.set(tag, contributorsOf(authors));
+  }
+
+  return contributors;
+}
+
+/**
+ * The tag names in one commit's decoration.
+ *
+ * Every tag on a commit names the same range of history, so all of them are
+ * kept: a project that tags `v1.0.0` and `1.0.0` at once is answered under
+ * whichever spelling its changelog happens to use.
+ */
+function tagsOf(decoration: string): string[] {
+  return decoration
+    .split(',')
+    .map((entry) => entry.trim())
+    .filter((entry) => entry.startsWith('tag: '))
+    .map((entry) => entry.slice('tag: '.length).trim())
+    .filter(Boolean);
+}
+
+/**
+ * Two ways of writing a repository, reduced to the one thing that identifies it.
+ *
+ * `kirchDev/duxt` resolves to `https://github.com/kirchDev/duxt`, a checkout's
+ * remote is routinely `git@github.com:kirchDev/duxt.git`, and both name the same
+ * repository. Scheme, credentials, the scp-style colon, a trailing `.git` and
+ * case go; GitHub treats owner and name case-insensitively, and so does this.
+ */
+export function sameRepository(a: string, b: string): boolean {
+  const key = (url: string) =>
+    url
+      .trim()
+      .replace(/^[a-z][a-z+.-]*:\/\//i, '')
+      .replace(/^[^@/]+@/, '')
+      .replace(/^([^/:]+):(?!\d+\/)/, '$1/')
+      .replace(/\.git\/?$/i, '')
+      .replace(/\/+$/, '')
+      .toLowerCase();
+
+  return key(a) === key(b);
+}
+
+/**
+ * The local checkout's history, where a DOWNLOADED source is this very
+ * repository.
+ *
+ * Content clones a remote source at `--depth 1`, and a history like that is
+ * wrong data rather than missing data — which is why a downloaded changelog
+ * reads no contributors. But a site very often names ITS OWN repository as a
+ * source, to publish the documentation of a tag rather than of the commit being
+ * built, and then the full history is already on disk: the tags are the same
+ * tags, so a release is the same range of commits whichever copy is asked.
+ *
+ * Every remote counts, not only `origin`: a fork's checkout calls the project
+ * `upstream`. A failure is silent for the reason `releaseContributors` gives —
+ * nothing was configured, so no git means what it meant before.
+ */
+export function localHistoryFor(url: string, root: string): string | undefined {
+  try {
+    const remotes = execFileSync('git', ['-C', root, 'remote', '-v'], {
+      encoding: 'utf8',
+      stdio: ['ignore', 'pipe', 'ignore']
+    });
+
+    return remotes
+      .split('\n')
+      .map((line) => line.split(/\s+/)[1])
+      .some((remote) => remote && sameRepository(remote, url))
+      ? root
+      : undefined;
+  } catch {
+    return undefined;
+  }
+}
+
+/** One answer per repository, read the first time a section asks for it. */
+const cache = new Map<string, Map<string, DuxtContributor[]>>();
+
+/**
+ * The releases of the checkout at `root`, by tag.
+ *
+ * A FAILURE IS SILENT, and deliberately not the reporting `sources-git.ts`
+ * does: there, tags that cannot be read are a source a maintainer has to fix,
+ * and "found no tags" sent them to edit a source that was never wrong. Here
+ * nothing was configured at all — the history is read because it happens to be
+ * there — so no git, no checkout and a repository that has never been tagged
+ * all mean what they mean in `modules/git-meta.ts`: the page shows what it
+ * showed before this module existed.
+ */
+export function releaseContributors(
+  root: string
+): Map<string, DuxtContributor[]> {
+  const cached = cache.get(root);
+  if (cached) return cached;
+
+  let found: Map<string, DuxtContributor[]>;
+
+  try {
+    found = parseReleaseContributors(
+      execFileSync('git', ['-C', root, ...ARGUMENTS], {
+        encoding: 'utf8',
+        stdio: ['ignore', 'pipe', 'ignore'],
+        // A repository's whole log against execFileSync's 1 MB default is a
+        // truncated history reported as a git failure.
+        maxBuffer: Number.POSITIVE_INFINITY
+      })
+    );
+  } catch {
+    found = new Map();
+  }
+
+  cache.set(root, found);
+  return found;
+}
+
+/**
+ * The people a changelog's version names, matched to the tag it was cut as.
+ *
+ * A changelog heading says `0.2.0` and the tag says `v0.2.0` — release-please's
+ * `include-v-in-tag` — so both spellings are tried, in both directions. Nothing
+ * is inferred beyond that: a version with no tag is a release this checkout
+ * cannot see (one cut after the build, or a hand-written fixture), and the
+ * honest answer for it is no contributors rather than someone else's.
+ */
+export function contributorsForVersion(
+  releases: Map<string, DuxtContributor[]> | undefined,
+  version: string
+): DuxtContributor[] | undefined {
+  if (!releases) return undefined;
+
+  const bare = version.replace(/^v/, '');
+
+  return (
+    releases.get(version) ?? releases.get(`v${bare}`) ?? releases.get(bare)
+  );
+}

package/i18n/locales/de/duxt/announcement.json

@@ -0,0 +1,7 @@
+{
+  "duxt": {
+    "announcement": {
+      "dismiss": "Diese Ankündigung schließen"
+    }
+  }
+}

package/i18n/locales/de/duxt/bruno.json

@@ -0,0 +1,25 @@
+{
+  "duxt": {
+    "bruno": {
+      "auth": "Authentifizierung",
+      "body": "Body",
+      "download": "Collection herunterladen",
+      "downloadHint": "Die Collection genau so, wie diese Version und Sprache sie beschreiben.",
+      "environments": "Umgebungen",
+      "fetch": "In Bruno öffnen",
+      "fetchHint": "Klont das Repository in Bruno. Es folgt dem Standard-Branch und ist nicht an diese Version gebunden.",
+      "folders": "Ordner",
+      "format": "Format",
+      "getIt": "Collection beziehen",
+      "hasCode": "Diese Anfrage enthält außerdem Skripte oder Tests. Sie werden hier weder angezeigt noch ausgeführt; im Download sind sie enthalten.",
+      "headers": "Header",
+      "name": "Name",
+      "notPublished": "Umgebungen, Zugangsdaten, Skripte und Tests werden auf dieser Seite nie veröffentlicht und nie im Browser ausgeführt.",
+      "parameters": "Parameter",
+      "requests": "Anfragen",
+      "shared": "Für alle Anfragen gemeinsam",
+      "value": "Wert",
+      "withheld": "zurückgehalten"
+    }
+  }
+}

package/i18n/locales/de/duxt/changelog.json

@@ -5,7 +5,7 @@
       "filter": "Nach Art der Änderung filtern",
       "latest": "Neueste",
       "changes": "Änderungen",
-      "kinds": "Änderungsarten",
+      "contributors": "Mitwirkende",
       "last": "Letztes Release",
       "more": "und {count} weitere",
       "kind": "Änderungsart",

package/i18n/locales/de/duxt/code.json

@@ -7,7 +7,8 @@
       "preview": "Vorschau",
       "source": "Code",
       "previewTabs": "Beispiel und Quelltext",
-      "copiedToast": "In die Zwischenablage kopiert"
+      "copiedToast": "In die Zwischenablage kopiert",
+      "copyFailed": "Konnte nicht in die Zwischenablage kopieren."
     }
   }
 }

package/i18n/locales/de/duxt/page.json

@@ -13,6 +13,15 @@
         "no": "Nein",
         "thanks": "Vielen Dank."
       },
+      "image": {
+        "close": "Bildansicht schließen",
+        "original": "Original in neuem Tab öffnen",
+        "resetZoom": "Zoom zurücksetzen",
+        "zoom": "Bild vergrößern",
+        "zoomIn": "Vergrößern",
+        "zoomNamed": "Bild vergrößern: {alt}",
+        "zoomOut": "Verkleinern"
+      },
       "tabs": "Varianten",
       "since": "Neu in {version}",
       "copy": {

package/i18n/locales/de/duxt/shortcuts.json

@@ -2,6 +2,7 @@
   "duxt": {
     "shortcuts": {
       "title": "Tastenkürzel",
+      "open": "Tastenkürzel anzeigen",
       "search": "Dokumentation durchsuchen",
       "help": "Diese Liste anzeigen",
       "previous": "Vorherige Seite",

package/i18n/locales/de/duxt/theme.json

@@ -1,7 +1,8 @@
 {
   "duxt": {
     "theme": {
-      "toggle": "Erscheinungsbild wechseln"
+      "toLight": "Zum hellen Erscheinungsbild wechseln",
+      "toDark": "Zum dunklen Erscheinungsbild wechseln"
     }
   }
 }

package/i18n/locales/en/duxt/announcement.json

@@ -0,0 +1,7 @@
+{
+  "duxt": {
+    "announcement": {
+      "dismiss": "Dismiss this announcement"
+    }
+  }
+}

package/i18n/locales/en/duxt/bruno.json

@@ -0,0 +1,25 @@
+{
+  "duxt": {
+    "bruno": {
+      "auth": "Authentication",
+      "body": "Body",
+      "download": "Download collection",
+      "downloadHint": "The collection exactly as this version and language describe it.",
+      "environments": "Environments",
+      "fetch": "Fetch in Bruno",
+      "fetchHint": "Clones the repository in Bruno. It follows the default branch and is not pinned to this version.",
+      "folders": "Folders",
+      "format": "Format",
+      "getIt": "Get the collection",
+      "hasCode": "This request also carries scripts or tests. They are neither shown here nor run; the download has them.",
+      "headers": "Headers",
+      "name": "Name",
+      "notPublished": "Environments, credentials, scripts and tests are never published on this site and never run in your browser.",
+      "parameters": "Parameters",
+      "requests": "Requests",
+      "shared": "Shared by every request",
+      "value": "Value",
+      "withheld": "withheld"
+    }
+  }
+}

package/i18n/locales/en/duxt/changelog.json

@@ -5,7 +5,7 @@
       "filter": "Filter by kind of change",
       "latest": "Latest",
       "changes": "Changes",
-      "kinds": "Kinds of change",
+      "contributors": "Contributors",
       "last": "Last release",
       "more": "and {count} more",
       "kind": "Kind of change",

package/i18n/locales/en/duxt/code.json

@@ -7,7 +7,8 @@
       "preview": "Preview",
       "source": "Code",
       "previewTabs": "Example and source",
-      "copiedToast": "Copied to clipboard"
+      "copiedToast": "Copied to clipboard",
+      "copyFailed": "Could not copy to the clipboard."
     }
   }
 }

package/i18n/locales/en/duxt/page.json

@@ -13,6 +13,15 @@
         "no": "No",
         "thanks": "Thank you."
       },
+      "image": {
+        "close": "Close image viewer",
+        "original": "Open original in a new tab",
+        "resetZoom": "Reset zoom",
+        "zoom": "Enlarge image",
+        "zoomIn": "Zoom in",
+        "zoomNamed": "Enlarge image: {alt}",
+        "zoomOut": "Zoom out"
+      },
       "tabs": "Options",
       "since": "New in {version}",
       "copy": {

package/i18n/locales/en/duxt/shortcuts.json

@@ -2,6 +2,7 @@
   "duxt": {
     "shortcuts": {
       "title": "Keyboard shortcuts",
+      "open": "Show keyboard shortcuts",
       "search": "Search the documentation",
       "help": "Show this list",
       "previous": "Previous page",

package/i18n/locales/en/duxt/theme.json

@@ -1,7 +1,8 @@
 {
   "duxt": {
     "theme": {
-      "toggle": "Toggle theme"
+      "toLight": "Switch to light theme",
+      "toDark": "Switch to dark theme"
     }
   }
 }

package/i18n/locales/es/duxt/announcement.json

@@ -0,0 +1,7 @@
+{
+  "duxt": {
+    "announcement": {
+      "dismiss": "Descartar este anuncio"
+    }
+  }
+}

package/i18n/locales/es/duxt/bruno.json

@@ -0,0 +1,25 @@
+{
+  "duxt": {
+    "bruno": {
+      "auth": "Autenticación",
+      "body": "Cuerpo",
+      "download": "Descargar la colección",
+      "downloadHint": "La colección tal y como la describen esta versión y este idioma.",
+      "environments": "Entornos",
+      "fetch": "Abrir en Bruno",
+      "fetchHint": "Clona el repositorio en Bruno. Sigue la rama por defecto y no está fijado a esta versión.",
+      "folders": "Carpetas",
+      "format": "Formato",
+      "getIt": "Obtener la colección",
+      "hasCode": "Esta petición también incluye scripts o pruebas. Aquí no se muestran ni se ejecutan; están en la descarga.",
+      "headers": "Cabeceras",
+      "name": "Nombre",
+      "notPublished": "Los entornos, las credenciales, los scripts y las pruebas nunca se publican en este sitio ni se ejecutan en tu navegador.",
+      "parameters": "Parámetros",
+      "requests": "Peticiones",
+      "shared": "Común a todas las peticiones",
+      "value": "Valor",
+      "withheld": "oculto"
+    }
+  }
+}

package/i18n/locales/es/duxt/changelog.json

@@ -5,7 +5,7 @@
       "filter": "Filtrar por tipo de cambio",
       "latest": "Más reciente",
       "changes": "Cambios",
-      "kinds": "Tipos de cambio",
+      "contributors": "Colaboradores",
       "last": "Última versión",
       "more": "y {count} más",
       "kind": "Tipo de cambio",

package/i18n/locales/es/duxt/code.json

@@ -7,7 +7,8 @@
       "preview": "Vista previa",
       "source": "Código",
       "previewTabs": "Ejemplo y código fuente",
-      "copiedToast": "Copiado al portapapeles"
+      "copiedToast": "Copiado al portapapeles",
+      "copyFailed": "No se pudo copiar al portapapeles."
     }
   }
 }

package/i18n/locales/es/duxt/page.json

@@ -13,6 +13,15 @@
         "no": "No",
         "thanks": "Gracias."
       },
+      "image": {
+        "close": "Cerrar el visor de imágenes",
+        "original": "Abrir el original en una pestaña nueva",
+        "resetZoom": "Restablecer el zoom",
+        "zoom": "Ampliar imagen",
+        "zoomIn": "Acercar",
+        "zoomNamed": "Ampliar imagen: {alt}",
+        "zoomOut": "Alejar"
+      },
       "tabs": "Opciones",
       "since": "Novedad en {version}",
       "copy": {

package/i18n/locales/es/duxt/shortcuts.json

@@ -2,6 +2,7 @@
   "duxt": {
     "shortcuts": {
       "title": "Atajos de teclado",
+      "open": "Mostrar los atajos de teclado",
       "search": "Buscar en la documentación",
       "help": "Mostrar esta lista",
       "previous": "Página anterior",

package/i18n/locales/es/duxt/theme.json

@@ -1,7 +1,8 @@
 {
   "duxt": {
     "theme": {
-      "toggle": "Cambiar el tema"
+      "toLight": "Cambiar al tema claro",
+      "toDark": "Cambiar al tema oscuro"
     }
   }
 }

package/i18n/locales/fr/duxt/announcement.json

@@ -0,0 +1,7 @@
+{
+  "duxt": {
+    "announcement": {
+      "dismiss": "Masquer cette annonce"
+    }
+  }
+}

package/i18n/locales/fr/duxt/bruno.json

@@ -0,0 +1,25 @@
+{
+  "duxt": {
+    "bruno": {
+      "auth": "Authentification",
+      "body": "Corps",
+      "download": "Télécharger la collection",
+      "downloadHint": "La collection telle que cette version et cette langue la décrivent.",
+      "environments": "Environnements",
+      "fetch": "Ouvrir dans Bruno",
+      "fetchHint": "Clone le dépôt dans Bruno. Il suit la branche par défaut et n'est pas figé sur cette version.",
+      "folders": "Dossiers",
+      "format": "Format",
+      "getIt": "Obtenir la collection",
+      "hasCode": "Cette requête comporte aussi des scripts ou des tests. Ils ne sont ni affichés ni exécutés ici ; le téléchargement les contient.",
+      "headers": "En-têtes",
+      "name": "Nom",
+      "notPublished": "Les environnements, les identifiants, les scripts et les tests ne sont jamais publiés sur ce site ni exécutés dans votre navigateur.",
+      "parameters": "Paramètres",
+      "requests": "Requêtes",
+      "shared": "Commun à toutes les requêtes",
+      "value": "Valeur",
+      "withheld": "masqué"
+    }
+  }
+}

package/i18n/locales/fr/duxt/changelog.json

@@ -5,7 +5,7 @@
       "filter": "Filtrer par type de modification",
       "latest": "Plus récente",
       "changes": "Modifications",
-      "kinds": "Types de modification",
+      "contributors": "Contributeurs",
       "last": "Dernière version",
       "more": "et {count} de plus",
       "kind": "Type de modification",

package/i18n/locales/fr/duxt/code.json

@@ -7,7 +7,8 @@
       "preview": "Aperçu",
       "source": "Code",
       "previewTabs": "Exemple et source",
-      "copiedToast": "Copié dans le presse-papiers"
+      "copiedToast": "Copié dans le presse-papiers",
+      "copyFailed": "Impossible de copier dans le presse-papiers."
     }
   }
 }