https://github.com/yegor256/texqc
LaTeX Build Quality Control: checks the log file after LaTeX and finds error reports
https://github.com/yegor256/texqc
latex linter quality-control
Last synced: 28 days ago
JSON representation
LaTeX Build Quality Control: checks the log file after LaTeX and finds error reports
- Host: GitHub
- URL: https://github.com/yegor256/texqc
- Owner: yegor256
- License: mit
- Created: 2020-08-02T15:32:45.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2025-06-06T13:20:37.000Z (about 1 month ago)
- Last Synced: 2025-06-14T06:15:50.599Z (29 days ago)
- Topics: latex, linter, quality-control
- Language: Ruby
- Homepage: https://rubygems.org/gems/texqc
- Size: 82 KB
- Stars: 11
- Watchers: 3
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://badge.fury.io/rb/texqc)
[](https://github.com/yegor256/takes/texqc/master/LICENSE.txt)This tool helps you make sure your LaTeX document compiles without issues.
First, you install it:
```bash
$ gem install texqc
```Then, you just run it after the LaTeX document is compiled:
```bash
$ latexmk -pdf article
$ texqc article
```If any warnings were reported by LaTeX, you will get a short list of them
and the exit code will be non-zero (very convenient for your CI/CD scripts).To make configuration easier, you can create `.texqc` file next to your
`.tex` file and place all your command line configuration options over there,
each one on its own line. You can also have a global configuration file
at `~/.texqc`, which will be read first.## How to contribute
Read [these guidelines](https://www.yegor256.com/2014/04/15/github-guidelines.html).
Make sure your build is green before you contribute
your pull request. You will need to have [Ruby](https://www.ruby-lang.org/en/) 2.3+ and
[Bundler](https://bundler.io/) installed. Then:```
$ bundle update
$ bundle exec rake
```If it's clean and you don't see any error messages, submit your pull request.