Skip to content

[doc] Add copy pastable yaml about pre-commit in the readme #1117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[doc] Add copy pastable yaml about pre-commit in the readme #1117

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,17 @@ Fix my format!
djlint . --extension=html.j2 --reformat
```

Or use ``pre-commit`` to reformat, then check !

```yaml
- repo: https://github.com/djlint/djLint
rev: v1.36.4 # use latest version instead
hooks:
- id: djlint # For an exhaustive list check 'id' in the project's '.pre-commit-hooks.yaml'
args: ["--reformat"]
- id: djlint
Copy link
Preview

Copilot AI Jul 29, 2025

Choose a reason for hiding this comment

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

The second djlint hook is missing the args parameter. Since this hook is intended for checking (as mentioned in the description), it should include appropriate arguments or a comment explaining its purpose.

Suggested change
- id: djlint
- id: djlint
args: ["--check"]

Copilot uses AI. Check for mistakes.

Copy link
Author

Choose a reason for hiding this comment

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

Would make sense to be explicit, it's the default value.

```

## 💙 Like it?

Add a badge to your projects `readme.md`:
Expand Down