https://github.com/jonasbb/pre-commit-latex-hooks

pre-commit hooks to improve LaTeX writing.
https://github.com/jonasbb/pre-commit-latex-hooks

ci hacktoberfest latex lint pre-commit

Last synced: 17 days ago
JSON representation

pre-commit hooks to improve LaTeX writing.

• Host: GitHub
• URL: https://github.com/jonasbb/pre-commit-latex-hooks
• Owner: jonasbb
• License: apache-2.0
• Created: 2019-02-18T19:59:34.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-21T21:03:14.000Z (22 days ago)
• Last Synced: 2024-10-22T15:16:45.941Z (22 days ago)
• Topics: ci, hacktoberfest, latex, lint, pre-commit
• Language: Rust
• Homepage:
• Size: 246 KB
• Stars: 47
• Watchers: 4
• Forks: 7
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
# pre-commit Hooks for LaTeX [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit) | [![pre-commit.ci status](https://results.pre-commit.ci/badge/github/jonasbb/pre-commit-latex-hooks/master.svg)](https://results.pre-commit.ci/latest/github/jonasbb/pre-commit-latex-hooks/master)

## Example configuration

`.pre-commit-config.yaml`:

```yaml

repos:

  - repo: https://github.com/jonasbb/pre-commit-latex-hooks

    rev: v1.4.0

    hooks:

      - id: american-eg-ie

      - id: cleveref-capitalization

      - id: consistent-spelling

        args:

            [

              "--emph=et al.",

              "--emph=a priori",

              "--emph=a posteriori",

              '--regex=naive=\bna(i|\\"i)ve',

            ]

      - id: csquotes

      - id: ensure-labels-for-sections

        # args:

        #     [

        #       # If present only check that there is a \label{} but not the value

        #       "--ignore-label-content",

        #     ]

      - id: no-space-in-cite

      - id: tilde-cite

      - id: unique-labels

      - id: cleveref-instead-of-autoref

  - repo: https://github.com/pre-commit/pre-commit-hooks

    rev: v3.3.0

    hooks:

      - id: check-merge-conflict

      - id: check-yaml

      - id: trailing-whitespace

        files: ".*\\.(?:tex|py)$"

```

## License

Licensed under either of

* Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)

* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

at your option.

## Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted

for inclusion in the work by you, as defined in the Apache-2.0 license, shall

be dual licensed as above, without any additional terms or conditions.