Skip to content

Add a commented-out exclude for Pipfile.lock to the pretty-format-json pre-commit hook#261

Open
jsf9k wants to merge 1 commit intodevelopfrom
improvement/exclude-pipenv-lock-file
Open

Add a commented-out exclude for Pipfile.lock to the pretty-format-json pre-commit hook#261
jsf9k wants to merge 1 commit intodevelopfrom
improvement/exclude-pipenv-lock-file

Conversation

@jsf9k
Copy link
Copy Markdown
Member

@jsf9k jsf9k commented Apr 7, 2026

🗣 Description

This pull request adds a commented-out exclude to the pre-commit configuration to exclude Pipfile.lock from the pretty-format-json hook.

💭 Motivation and context

This exclude directive will be uncommented in multiple downstream repos that use pipenv. We simply let pipenv format those files however it wants; we don't care about prettifying them since they are for the most part only read by machines.

This also saves us some time and effort on Dependabot PRs that update the Pipfile.lock file since they should pass the pre-commit linters without being reformatted.

🧪 Testing

All automated tests pass.

✅ Pre-approval checklist

  • This PR has an informative and human-readable title.
  • Changes are limited to a single goal - eschew scope creep!
  • All relevant type-of-change labels have been added.
  • I have read the CONTRIBUTING document.
  • These code changes follow cisagov code standards.
  • All new and existing tests pass.

This exclude is uncommented in multiple downstream repos that use
pipenv to simply allow it format those files however it wants; we
don't care about prettifying them since they are for the most part
only read by machines.
@jsf9k jsf9k self-assigned this Apr 7, 2026
@jsf9k jsf9k added the kraken 🐙 This pull request is ready to merge during the next Lineage Kraken release label Apr 7, 2026
@jsf9k jsf9k moved this to In Progress in Next Kraken Apr 7, 2026
@jsf9k jsf9k moved this from In progress to Review in progress in Skeleton Maintenance Apr 7, 2026
@github-actions github-actions bot added the dependencies Pull requests that update a dependency file label Apr 7, 2026
@jsf9k jsf9k marked this pull request as ready for review April 7, 2026 17:17
@jsf9k jsf9k requested review from dav3r, felddy and mcdonnnj as code owners April 7, 2026 17:17
Copilot AI review requested due to automatic review settings April 7, 2026 17:17
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This pull request updates the repository’s pre-commit configuration around pretty-format-json to address handling of Pipfile.lock files (commonly present in downstream pipenv-based repos).

Changes:

  • Adds commented documentation indicating how to exclude Pipfile.lock from the pretty-format-json hook.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread .pre-commit-config.yaml
@jsf9k jsf9k changed the title Exclude Pipfile.lock from pretty-format-json pre-commit hook Add a commented-out exclude for Pipfile.lock to the pretty-format-json pre-commit hook Apr 7, 2026
Copy link
Copy Markdown
Member

@mcdonnnj mcdonnnj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for taking care of this!

Copy link
Copy Markdown
Member

@dav3r dav3r left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Love it 👍 🚀

@github-project-automation github-project-automation bot moved this from Review in progress to Reviewer approved in Skeleton Maintenance Apr 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Pull requests that update a dependency file kraken 🐙 This pull request is ready to merge during the next Lineage Kraken release

Projects

Status: In Progress
Status: Reviewer approved

Development

Successfully merging this pull request may close these issues.

4 participants