Metadata-Version: 2.5
Name: check-gitignore
Version: 0.1.0
Summary: Run formatting and robustness checks on a gitignore file
Project-URL: Homepage, https://devel.ringlet.net/textproc/check-gitignore/
Project-URL: Changes, https://devel.ringlet.net/textproc/check-gitignore/changes/
Project-URL: Issue Tracker, https://todo.sr.ht/~ppentchev/check-gitignore
Project-URL: Source Code, https://git.sr.ht/~ppentchev/check-gitignore
Author-email: Peter Pentchev <roam@ringlet.net>
License-Expression: BSD-2-Clause
License-File: LICENSES/BSD-2-Clause.txt
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3.15
Classifier: Programming Language :: Python :: 3.16
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Python: >=3.11
Requires-Dist: cappa<0.34,>=0.33
Requires-Dist: roundlet<0.3,>=0.2.4
Description-Content-Type: text/markdown

<!--
SPDX-FileCopyrightText: Peter Pentchev <roam@ringlet.net>
SPDX-License-Identifier: BSD-2-Clause
-->

# check-gitignore - run formatting and robustness checks on a gitignore file

\[[Home][ringlet-home] | [sourcehut][sourcehut] | [PyPI][pypi] | [ReadTheDocs][readthedocs]\]

## Overview

The `check-gitignore` tool examines a `gitignore` file (usually named
`.gitignore`, e.g. in a top-level source directory or in a user's
home directory) and checks it for several predefined robustness criteria,
e.g. do the paths start with a slash, do directory paths end with a slash,
are the definitions sorted, etc.

## Examples

Run all the checks supported by the current version of `check-gitignore`
(only do this with a pinned version, or new checks may surprise you):

``` sh
check-gitignore check --enable=all -- /path/to/.gitignore
```

Run the checks defined at a specific policy version:

``` sh
check-gitignore check --enable=0.0 -- /path/to/.gitignore
```

Enable some additional checks:

``` sh
check-gitignore check --enable=0.0,sort-after-initial-block  -- /path/to/.gitignore
```

List the names of the checks that would be enabled:

``` sh
check-gitignore show checks --enable=0.0,sort-after-initial-block  -- /path/to/.gitignore
```

## Contact

The `check-gitignore` tool was written by [Peter Pentchev][roam].
It is developed in [a sourcehut repository][sourcehut].
This documentation is hosted at [Ringlet][ringlet-home] with a copy at [ReadTheDocs][readthedocs].

[roam]: mailto:roam@ringlet.net "Peter Pentchev"
[sourcehut]: https://git.sr.ht/~ppentchev/check-gitignore "The check-gitignore sourcehut repository"
[pypi]: https://pypi.org/project/check-gitignore/ "The check-gitignore Python Package Index page"
[readthedocs]: https://check-gitignore.readthedocs.io/ "The check-gitignore ReadTheDocs page"
[ringlet-home]: https://devel.ringlet.net/textproc/check-gitignore/ "The Ringlet check-gitignore homepage"
