Skip to main content

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

[Home | sourcehut | PyPI | 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):

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

Run the checks defined at a specific policy version:

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

Enable some additional checks:

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

List the names of the checks that would be enabled:

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

Contact

The check-gitignore tool was written by Peter Pentchev. It is developed in a sourcehut repository. This documentation is hosted at Ringlet with a copy at ReadTheDocs.

Metadata

Release files for check-gitignore 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for check-gitignore 0.1.0
File Size Uploaded Provenance Actions
check_gitignore-0.1.0.tar.gz 89.5 kB Without provenance Details for check_gitignore-0.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for check-gitignore 0.1.0
File Interpreter ABI Platform Actions
check_gitignore-0.1.0-py3-none-any.whl Python 3 none any Details for check_gitignore-0.1.0-py3-none-any.whl

Total release size: 98.6 kB

Release files / check_gitignore-0.1.0.tar.gz

Download URL check_gitignore-0.1.0.tar.gz
Size 89.5 kB
Tags Source
SHA-256 checksum
How to use checksums
a213e302e99e9c3612c79f9e2bb1b2f9c5191c68b6df1e1e948a60d995ef0dd9
BLAKE2b-256 checksum
How to use checksums
f730f9fe8639a32d15956b606244e5ac7e6db152759c5656d6d51c32e4a73cc3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.10

Release files / check_gitignore-0.1.0-py3-none-any.whl

Download URL check_gitignore-0.1.0-py3-none-any.whl
Size 9.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
712e2da5dc2057427b41ec126976cd25b7b075c87f0ed6d130c28477660eb705
BLAKE2b-256 checksum
How to use checksums
2fa89b7471624749c94302b7f2d8354471d78e9412bffa13d1f4921f8789dd0b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.10

Security for check-gitignore 0.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page