TeX-source hazard audit

Catch the source patterns that crash pdflatex but read as ordinary prose — a bare _ or ^ in a bibliography field, | inside a markdown table cell where it is also the column separator, a $…$ span across two lines, markdown link syntax inside a fenced tex block, a double subscript.

Skills it satisfies

A skill states the capability; this Tool is one way to exercise it. Each skill’s declared input and output contract follows, where it has one.

latex-validation

Source: folio-assistant-sci/skills/content/folio-paper-adapter/latex-validation.md.

Also satisfied by: latex-overfull, latex-preflight, tex-snippet-validate.

The skill declares no I/O contract (schemas/skills/latex-validation/{input,output}.schema.json).

Inputs and outputs

Each port names a shared type by IRI, so two Tools for one skill can be checked for interchangeability.

porttyperequireddescriptionconstraint
instrictFlagExit 1 on any finding, for use as a gate.boolean · A boolean switch — projects to a bare flag, with no value word
outreportTextHazards with file and line, plus a committed sidecar. Run where no folio exists it says No .md files found … refusing to report success. This audits a FOLIO's content; folio-assistant is the platform. and exits 2 (could-not-determine).string · A short single-line human string. Not admissible as a command-line argument.

Processes and tasks

No process step names a skill this Tool satisfies.

How it is deployed and reached

  • Command line. From the repository root: bun run cat latex:audit-source. cat latex:audit-source runs bun run folio-assistant-sci/pipeline/audit-tex-source.ts (declared in folio-assistant-sci/package.json).
  • GitHub Actions. No workflow in this checkout runs its command.

As an API: its operation in the OpenAPI document and the MCP tool list of its layer.

installnone
runtimebun
networkno

What it is made of

Linked data

The Tool is published as its own JSON-LD document at its IRI, https://litlfred.github.io/folio-assistant/folio-assistant-sci/tools/tex-source-audit.jsonld, partOf its layer’s document. The node below is the definition this page was drawn from, and is embedded in the page as application/ld+json.

{
  "@context": "https://litlfred.github.io/folio-assistant/folio-assistant-sci/folio-assistant-sci.context.jsonld",
  "@id": "https://litlfred.github.io/folio-assistant/folio-assistant-sci/tools/tex-source-audit.jsonld",
  "@type": "https://litlfred.github.io/cat-harness/v0/ns/Tool",
  "partOf": "https://litlfred.github.io/folio-assistant/folio-assistant-sci/folio-assistant-sci.jsonld",
  "name": "tex-source-audit",
  "title": "TeX-source hazard audit",
  "description": "Catch the source patterns that crash pdflatex but read as ordinary prose — a bare `_` or `^` in a bibliography field, `|` inside a markdown table cell where it is also the column separator, a `$…$` span across two lines, markdown link syntax inside a fenced tex block, a double subscript.",
  "install": {
    "none": true
  },
  "invoke": {
    "shell": "bun run cat latex:audit-source"
  },
  "io": {
    "inputs": [
      {
        "name": "strict",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/Flag",
        "description": "Exit 1 on any finding, for use as a gate.",
        "required": false,
        "arg": {
          "flag": "--strict"
        }
      }
    ],
    "outputs": [
      {
        "name": "report",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/Text",
        "description": "Hazards with file and line, plus a committed sidecar. Run where no folio exists it says `No .md files found … refusing to report success. This audits a FOLIO's content; folio-assistant is the platform.` and exits 2 (could-not-determine)."
      }
    ]
  },
  "satisfies": [
    "latex-validation"
  ],
  "requirements": {
    "runtime": [
      "bun"
    ],
    "network": false
  }
}

folio-assistant — code under the Apache License 2.0, documentation under CC BY 3.0. Generated schema and API references are rebuilt from source on every push to main.

deployed dev