LaTeX overfull-box report

Turn a pdflatex log’s Overfull \hbox warnings into a located, actionable report, with a threshold so a long tail of trivial overruns does not bury the real ones.

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-preflight, tex-snippet-validate, tex-source-audit.

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
inlogRepoPathyesThe pdflatex log to read.string · pattern ^[A-Za-z0-9._][A-Za-z0-9._/-]*$ · A path relative to the repository root. No .. segments.
inminDpiIgnore overruns below this sizeinteger · Dots per inch for rendered formulae.
inmaxDpiFail above this count, for use as a gate.integer · Dots per inch for rendered formulae.
injsonFlagboolean · A boolean switch — projects to a bare flag, with no value word
outreportTextLocated overfull boxes. Requires a build log: with no log there is nothing to read, which is could-not-determine rather than clean.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:overfull. cat latex:overfull runs bun run cat-harness-tools/pipeline/latex-overfull-report.ts (declared in cat-harness-tools/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/latex-overfull.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/latex-overfull.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": "latex-overfull",
  "title": "LaTeX overfull-box report",
  "description": "Turn a pdflatex log's Overfull \\hbox warnings into a located, actionable report, with a threshold so a long tail of trivial overruns does not bury the real ones.",
  "install": {
    "none": true
  },
  "invoke": {
    "shell": "bun run cat latex:overfull"
  },
  "io": {
    "inputs": [
      {
        "name": "log",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/RepoPath",
        "description": "The pdflatex log to read.",
        "required": true,
        "arg": {
          "positional": 0
        }
      },
      {
        "name": "min",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/Dpi",
        "description": "Ignore overruns below this size",
        "required": false,
        "arg": {
          "flag": "--min"
        }
      },
      {
        "name": "max",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/Dpi",
        "description": "Fail above this count, for use as a gate.",
        "required": false,
        "arg": {
          "flag": "--max"
        }
      },
      {
        "name": "json",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/Flag",
        "required": false,
        "arg": {
          "flag": "--json"
        }
      }
    ],
    "outputs": [
      {
        "name": "report",
        "schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/Text",
        "description": "Located overfull boxes. Requires a build log: with no log there is nothing to read, which is could-not-determine rather than clean."
      }
    ]
  },
  "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