texCheckmate

Shell and Make utilities to inspect a LaTeX manuscript.

• Word count via TeXcount (excludes bibliography, headers, captions, etc.)
• Flags \label{}s declared but never used (e.g., via \ref)
• Flags duplicated \label{} entries
• Checks that all URLs in the manuscript are live
• Flags repeated words, bigrams, trigrams (e.g., "the the")
• Finds lines with hardcoded numbers for proofing
• Lists acronyms used, with frequency counts
• Runs Textidote for grammar and LaTeX style checks (via LanguageTool)
• Swaps citation style between author-year and numeric (and back)

Adapted from Jonathan Dingel's logbook Makefile: https://github.com/jdingel/projecttemplate/blob/master/paper/reviewing/Makefile.

See this note for more details.

Assumptions

• The manuscript is ./main.tex (if not, the scripts need to be changed).

Use with Make

Comes with a Makefile, with quick CLI access to the utilities, some of which call scripts from https://github.com/LSYS/texCheckmate/tree/main/inspecting.

acronyms         Find and tally acronyms
aynumeric        Change author-year to numeric citation
cleantex         Clean aux output files in LaTex compilation
dueto            Find "due to"s; Did you mean "because of", "owing to", or "from"?
duplicated_labels Check for duplicated labels
hardcodednumbers Find hardcoded numbers
help             Show this help message and exit
inspect          Do all inspections of manuscript
linkchecker      Check URLs
numericay        Change author-year to numeric citation
repeated_strings Check for repeated words
textidote        Check with textidote
unreferenced_labels Check for label referencing
wordcount        Wordcount via texcount

Cloning

git clone https://github.com/LSYS/texCheckmate.git
mv texCheckmate/* .
rm -r texCheckmate

Porting (w/o Git)

To download the utilities without cloning:

1. Download the zipped repo

wget -v https://github.com/LSYS/texCheckmate/archive/refs/heads/main.zip

2. Unzip

unzip main.zip

3. Remove the README.md & repo CI

rm texCheckmate-main/README.md
rm -r texCheckmate-main/.github

4. Move to ./

mv texCheckmate-main/* .

5. Clean up

rm -r texCheckmate-main
rm main.zip

All together:

wget -v https://github.com/LSYS/texCheckmate/archive/refs/heads/main.zip
unzip main.zip
rm texCheckmate-main/README.md
rm -r texCheckmate-main/.github
mv texCheckmate-main/* .
rm -r texCheckmate-main
rm main.zip