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

Jump to bottom

Create .pre-commit-hooks.yaml #238

Merged
merged 1 commit into from
Aug 27, 2024
Merged

Create .pre-commit-hooks.yaml #238

merged 1 commit into from
Aug 27, 2024

Conversation

Jayman2000
Copy link
Contributor

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.

@github-actions GitHub Actions
Copy link

github-actions bot commented Aug 23, 2024 •
edited
Loading

Nixpkgs diff

Jayman2000 added a commit to Jayman2000/jasons-pre-commit-hooks that referenced this pull request Aug 23, 2024
@Jayman2000
Merge branch 'rsc-enable-nixfmt-hook'
2d5b801 
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>
@infinisil
Copy link
Member

How does this work? It would be great if you could add this to the README :)

@Jayman2000
Create .pre-commit-hooks.yaml
6d57d1b 
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
Copy link
Contributor Author

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 https://github.com/NixOS/nixfmt URL with https://github.com/Jayman2000/nixfmt-pr, and you’ll need to use 6d57d1b as the version.

infinisil
infinisil approved these changes Aug 26, 2024
View reviewed changes
Copy link
Member

@infinisil infinisil left a comment

Choose a reason for hiding this comment

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

This is looking great to me!

@infinisil infinisil merged commit 8c4da7b into NixOS:master Aug 27, 2024
2 checks passed
@Jayman2000 Jayman2000 deleted the pre-commit.com-hook branch September 5, 2024 23:04
@MSchmoecker MSchmoecker mentioned this pull request Sep 6, 2024
Open
13 tasks
Jayman2000 added a commit to Jayman2000/jasons-pre-commit-hooks that referenced this pull request Sep 6, 2024
@Jayman2000
Use upstream nixfmt repo
0af53c1 
Now that this PR [1] has been merged into nixfmt, we can use the
upstream nixfmt repo.

[1]: <NixOS/nixfmt#238>
@Freed-Wu
Copy link

nixfmt’s integration with the pre-commit tool is relatively new. At the moment, none of the stable releases of nixfmt can be used with the pre-commit tool. You’ll have to use an unstable version for the time being.

When to release a new version? Just increase subrevision by one is OK.

infinisil added a commit to tweag/nixpkgs that referenced this pull request Nov 28, 2024
@infinisil
nixfmt-rfc-style: 2024-08-16 -> 2024-11-26
083f6bc 
Changes:
- NixOS/nixfmt#233 and
  NixOS/nixfmt#257 fix the poor formatting of
  `mkRenamedOptionModule` code.
- NixOS/nixfmt#240 deprecates passing
  directories as CLI args, instead using
  [treefmt](https://github.com/numtide/treefmt) is recommended.
- NixOS/nixfmt#246 fixes some problems with
  floats.
- NixOS/nixfmt#247 fixes trailing spaces not
  always being stripped.
- NixOS/nixfmt#248 ensures that the ownership of
  files isn't changed when formatting them.
- NixOS/nixfmt#249 fixes some poor formatting of
  some attribute selections.
- NixOS/nixfmt#262 ensures that 64-bit integers
  don't get trimmed on 32-bit platforms.
- NixOS/nixfmt#264 adds a `--filename` flag to
  allow setting the filename in error messages when formatting standard input.
- NixOS/nixfmt#243 added
  [installation and integration docs](https://github.com/NixOS/nixfmt?tab=readme-ov-file#installation-and-usage-instructions).
- NixOS/nixfmt#238 created a
  [`.pre-commit-hooks.yaml`](https://github.com/NixOS/nixfmt/blob/master/.pre-commit-hooks.yaml)
  for integration with [pre-commit](https://pre-commit.com/)
@infinisil infinisil mentioned this pull request Nov 28, 2024
Merged
1 task
dasJ pushed a commit to NixOS/nixpkgs that referenced this pull request Nov 28, 2024
@infinisil
nixfmt-rfc-style: 2024-08-16 -> 2024-11-26 (#359904)
edd47f7 
Changes:
- NixOS/nixfmt#233 and
  NixOS/nixfmt#257 fix the poor formatting of
  `mkRenamedOptionModule` code.
- NixOS/nixfmt#240 deprecates passing
  directories as CLI args, instead using
  [treefmt](https://github.com/numtide/treefmt) is recommended.
- NixOS/nixfmt#246 fixes some problems with
  floats.
- NixOS/nixfmt#247 fixes trailing spaces not
  always being stripped.
- NixOS/nixfmt#248 ensures that the ownership of
  files isn't changed when formatting them.
- NixOS/nixfmt#249 fixes some poor formatting of
  some attribute selections.
- NixOS/nixfmt#262 ensures that 64-bit integers
  don't get trimmed on 32-bit platforms.
- NixOS/nixfmt#264 adds a `--filename` flag to
  allow setting the filename in error messages when formatting standard input.
- NixOS/nixfmt#243 added
  [installation and integration docs](https://github.com/NixOS/nixfmt?tab=readme-ov-file#installation-and-usage-instructions).
- NixOS/nixfmt#238 created a
  [`.pre-commit-hooks.yaml`](https://github.com/NixOS/nixfmt/blob/master/.pre-commit-hooks.yaml)
  for integration with [pre-commit](https://pre-commit.com/)
github-actions bot pushed a commit to NixOS/nixpkgs that referenced this pull request Nov 28, 2024
@infinisil @github-actions
nixfmt-rfc-style: 2024-08-16 -> 2024-11-26 (#359904)
5603ab6 
Changes:
- NixOS/nixfmt#233 and
  NixOS/nixfmt#257 fix the poor formatting of
  `mkRenamedOptionModule` code.
- NixOS/nixfmt#240 deprecates passing
  directories as CLI args, instead using
  [treefmt](https://github.com/numtide/treefmt) is recommended.
- NixOS/nixfmt#246 fixes some problems with
  floats.
- NixOS/nixfmt#247 fixes trailing spaces not
  always being stripped.
- NixOS/nixfmt#248 ensures that the ownership of
  files isn't changed when formatting them.
- NixOS/nixfmt#249 fixes some poor formatting of
  some attribute selections.
- NixOS/nixfmt#262 ensures that 64-bit integers
  don't get trimmed on 32-bit platforms.
- NixOS/nixfmt#264 adds a `--filename` flag to
  allow setting the filename in error messages when formatting standard input.
- NixOS/nixfmt#243 added
  [installation and integration docs](https://github.com/NixOS/nixfmt?tab=readme-ov-file#installation-and-usage-instructions).
- NixOS/nixfmt#238 created a
  [`.pre-commit-hooks.yaml`](https://github.com/NixOS/nixfmt/blob/master/.pre-commit-hooks.yaml)
  for integration with [pre-commit](https://pre-commit.com/)

(cherry picked from commit edd47f7)
mkg20001 pushed a commit to mkg20001/nixpkgs that referenced this pull request Nov 30, 2024
@infinisil @mkg20001
nixfmt-rfc-style: 2024-08-16 -> 2024-11-26 (NixOS#359904)
06369ba 
Changes:
- NixOS/nixfmt#233 and
  NixOS/nixfmt#257 fix the poor formatting of
  `mkRenamedOptionModule` code.
- NixOS/nixfmt#240 deprecates passing
  directories as CLI args, instead using
  [treefmt](https://github.com/numtide/treefmt) is recommended.
- NixOS/nixfmt#246 fixes some problems with
  floats.
- NixOS/nixfmt#247 fixes trailing spaces not
  always being stripped.
- NixOS/nixfmt#248 ensures that the ownership of
  files isn't changed when formatting them.
- NixOS/nixfmt#249 fixes some poor formatting of
  some attribute selections.
- NixOS/nixfmt#262 ensures that 64-bit integers
  don't get trimmed on 32-bit platforms.
- NixOS/nixfmt#264 adds a `--filename` flag to
  allow setting the filename in error messages when formatting standard input.
- NixOS/nixfmt#243 added
  [installation and integration docs](https://github.com/NixOS/nixfmt?tab=readme-ov-file#installation-and-usage-instructions).
- NixOS/nixfmt#238 created a
  [`.pre-commit-hooks.yaml`](https://github.com/NixOS/nixfmt/blob/master/.pre-commit-hooks.yaml)
  for integration with [pre-commit](https://pre-commit.com/)
mkg20001 pushed a commit to mkg20001/nixpkgs that referenced this pull request Dec 2, 2024
@infinisil @mkg20001
nixfmt-rfc-style: 2024-08-16 -> 2024-11-26 (NixOS#359904)
e56fd5c 
Changes:
- NixOS/nixfmt#233 and
  NixOS/nixfmt#257 fix the poor formatting of
  `mkRenamedOptionModule` code.
- NixOS/nixfmt#240 deprecates passing
  directories as CLI args, instead using
  [treefmt](https://github.com/numtide/treefmt) is recommended.
- NixOS/nixfmt#246 fixes some problems with
  floats.
- NixOS/nixfmt#247 fixes trailing spaces not
  always being stripped.
- NixOS/nixfmt#248 ensures that the ownership of
  files isn't changed when formatting them.
- NixOS/nixfmt#249 fixes some poor formatting of
  some attribute selections.
- NixOS/nixfmt#262 ensures that 64-bit integers
  don't get trimmed on 32-bit platforms.
- NixOS/nixfmt#264 adds a `--filename` flag to
  allow setting the filename in error messages when formatting standard input.
- NixOS/nixfmt#243 added
  [installation and integration docs](https://github.com/NixOS/nixfmt?tab=readme-ov-file#installation-and-usage-instructions).
- NixOS/nixfmt#238 created a
  [`.pre-commit-hooks.yaml`](https://github.com/NixOS/nixfmt/blob/master/.pre-commit-hooks.yaml)
  for integration with [pre-commit](https://pre-commit.com/)
mkg20001 pushed a commit to mkg20001/nixpkgs that referenced this pull request Dec 4, 2024
@infinisil @mkg20001
nixfmt-rfc-style: 2024-08-16 -> 2024-11-26 (NixOS#359904)
aa7b8e7 
Changes:
- NixOS/nixfmt#233 and
  NixOS/nixfmt#257 fix the poor formatting of
  `mkRenamedOptionModule` code.
- NixOS/nixfmt#240 deprecates passing
  directories as CLI args, instead using
  [treefmt](https://github.com/numtide/treefmt) is recommended.
- NixOS/nixfmt#246 fixes some problems with
  floats.
- NixOS/nixfmt#247 fixes trailing spaces not
  always being stripped.
- NixOS/nixfmt#248 ensures that the ownership of
  files isn't changed when formatting them.
- NixOS/nixfmt#249 fixes some poor formatting of
  some attribute selections.
- NixOS/nixfmt#262 ensures that 64-bit integers
  don't get trimmed on 32-bit platforms.
- NixOS/nixfmt#264 adds a `--filename` flag to
  allow setting the filename in error messages when formatting standard input.
- NixOS/nixfmt#243 added
  [installation and integration docs](https://github.com/NixOS/nixfmt?tab=readme-ov-file#installation-and-usage-instructions).
- NixOS/nixfmt#238 created a
  [`.pre-commit-hooks.yaml`](https://github.com/NixOS/nixfmt/blob/master/.pre-commit-hooks.yaml)
  for integration with [pre-commit](https://pre-commit.com/)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@infinisil infinisil infinisil approved these changes

Assignees
No one assigned
Labels
None yet
Projects
Nix formatting
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Jayman2000 @infinisil @Freed-Wu