https://github.com/yegor256/fail-fast

LaTeX package that turns warnings into errors in order to make the build more fragile
https://github.com/yegor256/fail-fast

ctan latex latex-package

Last synced: about 1 month ago
JSON representation

LaTeX package that turns warnings into errors in order to make the build more fragile

• Host: GitHub
• URL: https://github.com/yegor256/fail-fast
• Owner: yegor256
• License: mit
• Created: 2023-07-01T13:51:18.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-09-28T13:10:45.000Z (about 2 months ago)
• Last Synced: 2024-09-29T04:41:47.944Z (about 2 months ago)
• Topics: ctan, latex, latex-package
• Language: TeX
• Homepage:
• Size: 43.9 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
[![make](https://github.com/yegor256/fail-fast/actions/workflows/l3build.yml/badge.svg)](https://github.com/yegor256/fail-fast/actions/workflows/l3build.yml)

[![CTAN](https://img.shields.io/ctan/v/fail-fast)](https://ctan.org/pkg/fail-fast)

[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/yegor256/fail-fast/blob/master/LICENSE.txt)

This LaTeX package helps you make your build more fragile, which is good if you care about quality.

Every warning it will turn into an error and LaTeX engine will fail with a non-zero error message.

First, [install it](https://en.wikibooks.org/wiki/LaTeX/Installing_Extra_Packages)

from [CTAN](https://ctan.org/pkg/fail-fast) 

and then use in the preamble:

```tex

\documentclass{article}

\usepackage{fail-fast}

\begin{document}

This reference is broken: \ref{foo}

\end{fail-fast}

\end{document}

```

Otherwise, you can download [`fail-fast.sty`](https://raw.githubusercontent.com/yegor256/fail-fast/gh-pages/fail-fast/fail-fast.sty) and add to your project.

If you want to contribute yourself, make a fork, then create a branch,

then run `l3build ctan` in the root directory.

It should compile everything without errors. If not, submit an issue and wait.

Otherwise, make your changes and then run `l3build ctan` again. If the build is

still clean, submit a pull request.

Copyright (c) 2023-2024 Yegor Bugayenko, MIT License