Skip to content

LaTeXerr is a simple command line tool which extracts errors and warnings from LaTeX log file and displays them in a more readable way

License

Notifications You must be signed in to change notification settings

pnevyk/latexerr

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

LaTeXerr

LaTeXerr is a simple command line tool which extracts errors and warnings from LaTeX log file and displays them in a more readable way. It is implemented in Rust programming language.

Example

Status

Very few rules are implemented right now. New ones will emerge proportionally to the demand. The error/warning extraction is also not very robust at the moment, I need to discover as many cases as possible with time. If you want a new rule to be included or an old one to be fixed, just write an issue or send a pull request (implementation of a rule is very simple). All contributions are very welcome.

Be aware that there will likely be many false negatives.

Features

  • User-friendly error/warning messages
  • File name and location in the file
  • Colors in terminal
  • Support for included documents

Installation

At the moment, LaTeXerr is not published anywhere apart from GitHub (apparently). You need to clone the repository, build it from source and link the binary to use it across your system. For that, because I use some experimental features, you need a nightly version of the Rust compiler.

git clone git@github.com:pnevyk/latexerr.git
cd latexerr
cargo build --release
# link the binary at target/release/latexerr from any of directories in your $PATH

Usage

pdflatex -interaction=nonstopmode source.tex
latexerr source.log

Rules

This is a brief list without comments. For rules' description, see the source code or tests.

  • Undefined control sequence
  • Curly braces mismatch
  • Sequences invalid outside of math environments
  • Underfull and overfull hbox
  • Missing package
  • Invalid option
  • Wrong number of &'s in table and similar environments

If you encounter a LaTeX error which is not handled by LaTeXerr, I would love to hear from you (in the form of issue or pull request).

License

LaTeXerr is licensed under MIT. Feel free to use it, contribute or spread the word.

About

LaTeXerr is a simple command line tool which extracts errors and warnings from LaTeX log file and displays them in a more readable way

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published