Skip to content
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

Add auto-format yaml pre-commit hook #71

Merged
merged 6 commits into from
Sep 24, 2024
Merged

Add auto-format yaml pre-commit hook #71

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
cd6dd6e
perhaps put local hooks to the end?
DanielYang59 Sep 24, 2024
67848a6
add google yamlfmt hook
DanielYang59 Sep 24, 2024
1374c95
yamlfmt pre-commit hook pass args -formatter retain_line_breaks=true
janosh Sep 24, 2024
e9b323e
push a badly formatted yaml
DanielYang59 Sep 24, 2024
263eb40
what about one space?
DanielYang59 Sep 24, 2024
309f414
revert bad changes
DanielYang59 Sep 24, 2024
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
24 changes: 15 additions & 9 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ default_install_hook_types: [pre-commit, commit-msg]

repos:
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.6.6
rev: v0.6.7
hooks:
- id: ruff
args:
Expand All @@ -34,14 +34,27 @@ repos:
- id: trailing-whitespace

- repo: https://github.com/igorshubovych/markdownlint-cli
rev: v0.41.0
rev: v0.42.0
hooks:
- id: markdownlint
# MD013: line length
# MD033: no inline HTML
# MD041: first line in a file should be a top-level heading
args: [--disable, MD013, MD033, MD041, "--"]

- repo: https://github.com/codespell-project/codespell
rev: v2.3.0
hooks:
- id: codespell
stages: [commit, commit-msg]
args: [--ignore-words-list, gool, --check-filenames]

- repo: https://github.com/google/yamlfmt
rev: v0.13.0
hooks:
- id: yamlfmt
args: [-formatter, retain_line_breaks=true]
Copy link
Contributor Author

@DanielYang59 DanielYang59 Sep 24, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

lgtm. 👍 anything you'd like to add?

I guess not, I was trying to find an arg to retain the line breaks, glad you foundknew it!

Let me try to push a "bad" commit and see if it works.

Copy link
Owner

Choose a reason for hiding this comment

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

you don't need to push. after pre-commit install it will prevent the commit locally already

Copy link
Contributor Author

Choose a reason for hiding this comment

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

in case someone don't have pre-commit installed :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah great, I just found the retain_line_breaks arg here, I was looking at the wrong docs


- repo: local
hooks:
- id: no-bracket-links
Expand All @@ -63,10 +76,3 @@ repos:
language: pygrep
types: [text]
exclude_types: [python]

- repo: https://github.com/codespell-project/codespell
rev: v2.3.0
hooks:
- id: codespell
stages: [commit, commit-msg]
args: [--ignore-words-list, gool, --check-filenames]