texsquisite

texsquisite is an linter for LaTeX that auto-formats code and fixes common typesetting mistakes.

Install

pip install texsquisite

How to Use

Run texsquisite in the command-line in your working directory:

texsquisite check

It will automatically detect all *.tex files and print errors. For example, it may output something like:

Fixable errors in paper.tex:
  line 1: [S002] - quotation should look like `this' or ``this''
    The result "holds" for every \(x.\)
  line 1: [S006] - punctuations {.,} should be inside \[math.\] and outside $math$.
    The result "holds" for every \(x.\)
  line 2: [S003] - \ref and \cite should have ~ before them
    See \ref{fig:one} and the appendix \footnote{which is long}.
  line 2: [S004] - \footnote should follow punctuation, with no space before it
    See \ref{fig:one} and the appendix \footnote{which is long}.

Fixable errors in sections/intro.tex:
  line 1: [S001] - line should not end with trailing whitespace
    We call this the ``main'' result.  

texsquisite: 2 files scanned.
5 error(s) found, 5 of which are fixable with '--fix'.

To auto-fix fixable errors, do:

texsquisite check --fix

Include a texsquisite.toml file in your working directory to add configurable options.

For more info, check out the docs.

Contribute

texsquisite is open-source and just getting started! Fork the code and submit a PR to add your own features.

• publish on PyPI
• use a LaTeX lexer/parser to catch more types of errors
• spot and fix common text/math-mode mix-ups
• ambitious: check units in equations
• add more rules (this will never end)

For more info, check out the Contributing Guide

License

This work is distributed under the MIT License. See LICENSE for more information.

Support

:star: Star this repository, share with friends/colleagues, or donate to become a supporter of the project.