DiCy

A JavaScript/TypeScript based builder for LaTeX, knitr, Literate Agda, Literate Haskell, and Pweave that automatically builds dependencies. It parses and filters output logs and error messages generated during build and can build projects that utilize the following programs to process files.

• Bibliographies — Biber, BibTeX, BibTeX8, BibTeXu, pBibTeX, upBibTeX
• Graphics Creation — Asymptote, MetaPost
• Image/File Conversion — dvipdfm, dvipdfmx, dvips, dvisvgm, epstopdf, pdf2ps, ps2pdf
• Indexing/Glossaries — bib2gls, makeglossaries, makeindex, mendex, splitindex, texindy, upmendex
• LaTeX Engines — LaTeX, LuaLaTeX, pdfLaTeX, pLaTeX, upLaTeX, XeLaTeX
• Literate Programming/Reproducible Research — Agda, knitr, lhs2TeX, patchSynctex, PythonTeX, Pweave, SageTeX

Installation

DiCy can be accessed via a library, via a JSON-RPC server or via the command line. The packages that implement these interfaces are listed below. In general to install a package use a command like npm install @dicy/core. Whereas to install for command line access use npm install -g @dicy/cli.

Documentation

Basic usage of the Command Line interface and library can be found below. For more detailed documentation please see the following pages.

• Comparison of Builders — A comparision of DiCy to arara and latexmk.
• Commands — The commands that can be passed to DiCy.
• Configuration — How DiCy configures the build including the order of configuration.
• Options — The options that can be passed to DiCy from the command line, the YAML option files, or TeX magic comments.
• API — Usage details on the library interface and the JSON-RPC interface.

Command Line Usage

The command line interface is generally called via

dicy [command] [options] [inputs...]

where the following commands are available (--help will enumerate options):

The options that can be specified are generally the same options accessible via the library interface.

Library Usage

The primary class in @dicy/core and @dicy/client is the DiCy class. For instance, to build foo.tex and report any log messages:

const dicy = new DiCy()

dicy.on('log', (filePath, messages) => {
  for (const message of messages) {
    const nameText = event.name ? `[${event.name}] ` : ''
    const typeText = event.category ? `${event.category}: ` : ''
    const text = `${event.severity} ${nameText}${typeText}${event.text.replace('\n', ' ')}`

    console.log(text)
  }
})

await dicy.setInstanceOptions('foo.tex', { synctex: true })
await dicy.run('foo.tex', ['load', 'build', 'log', 'save'])

Any sequence of commands listed below may be used, but the first and last commands should always be load and save, respectively.

For more details regarding library usage please see the API documentation.