Create .pre-commit-hooks.yaml
#238
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Jayman2000
added a commit
to Jayman2000/jasons-pre-commit-hooks
that referenced
this pull request
Aug 23, 2024
Making this change was unexpectedly annoying (yak saving 🙁). All I wanted to do was add a flake.nix file to another private Git repo. Before I could add the flake.nix file, I had to open a pull request for nixfmt [1] so that I could create four different commits in this repo so that I could make sure that Nix files get styled properly so that I can START creating the flake.nix file in that other repo. Plus, there will probably be more problems that I encounter while creating the flake.nix file, and I’ll end up having to make more changes to this repo. In other words, this is just the beginning of the yak shaving. [1]: <NixOS/nixfmt#238>
|
How does this work? It would be great if you could add this to the README :) |
This will allow people to enforce the style of .nix files in their own repos via the pre-commit tool. This change is related to #221, but it doesn’t actually implement the idea proposed in that issue. When writing the instructions for how to use the nixfmt pre-commit hook, I tried to make it clear that there’s a difference between the pre-commit tool and Git pre-commit hooks in general. I tried to make the difference between those two things clear for two reasons: 1. Both of those things are called pre-commit which makes it easy for people to mix them up [1]. 2. Depending on how #221 shakes out, the nixfmt project might end up adding another alternative mechanism for using nixfmt as part of a Git pre-commit hook script. I’m preemptively using language that makes it easy to differentiate between those two different mechanisms just in case there ends up being two different mechanisms in the future. [1]: <DescentDevelopers/Descent3#450 (comment)>
Jayman2000
force-pushed
the
pre-commit.com-hook
branch
from
f69bd4e
to
6d57d1b
Compare
|
I just pushed a new version that adds instructions to the README. If you want to test out those instructions, then you’ll need to make some tweaks once you get to step 5 in order to account for the fact that this PR hasn’t been merged yet. You’ll need to replace the |
infinisil
approved these changes
Aug 26, 2024
Open
13 tasks
Jayman2000
added a commit
to Jayman2000/jasons-pre-commit-hooks
that referenced
this pull request
Sep 6, 2024
Now that this PR [1] has been merged into nixfmt, we can use the upstream nixfmt repo. [1]: <NixOS/nixfmt#238>
When to release a new version? Just increase subrevision by one is OK. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This will allow people to enforce the style of
.nixfiles in their own repos via thepre-committool. This change is related to #221, but it doesn’t actually implement the idea proposed in that issue.