feature/treefmt - integrate treefmt-nix #1679
+178
−72
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -250,3 +250,4 @@ EOF | |
| }; | ||
| }; | ||
| } | ||
|
|
||
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| # `devenv` Integration for [treefmt](https://treefmt.com/) via [treefmt-nix](https://github.com/numtide/treefmt-nix) | ||
|
|
||
| ## Set up | ||
|
|
||
| Check the available integrations in [the list of all available integrations](reference/options.md#treefmt). | ||
|
|
||
| Add your desired integration to your `devenv.nix` file. For example, the following code would enable `treefmt` with the `nixpkgs-fmt` and `rustfmt` integrations: | ||
|
|
||
| ```nix | ||
| { inputs, ... }: | ||
|
|
||
| { | ||
| treefmt = { | ||
| projectRootFile = "devenv.nix"; | ||
| programs = { | ||
| nixpkgs-fmt.enable = true; | ||
| rustfmt.enable = true; | ||
| }; | ||
| }; | ||
| } | ||
| ``` | ||
|
|
||
| ### In Action: | ||
|
|
||
| ```shell-session | ||
| $ devenv shell | ||
| Building shell ... | ||
| Entering shell ... | ||
|
|
||
| treefmt # This would run treefmt on all files. | ||
| ``` | ||
|
|
||
| ## Additional Devenv Integrations | ||
|
|
||
| ### Pre-commit Hooks | ||
|
|
||
| If you would like to enable `treefmt` in your pre-commit hooks, simply add: | ||
|
|
||
| ```nix | ||
| { inputs, ... }: | ||
|
|
||
| { | ||
| pre-commit.hooks = { | ||
| treefmt.enable = true; | ||
| }; | ||
| } | ||
| ``` | ||
|
|
||
| This will enable `treefmt` hooks and automatically change the default package to the one you have defined in your `devenv`. | ||
|
|
||
| ## Using a Custom Formatter | ||
|
|
||
| It is also possible to use custom formatters with `treefmt-nix`. For example, the following custom formatter formats JSON files using `yq-go`: | ||
|
|
||
| ```nix | ||
| { | ||
| treefmt.settings.formatter = { | ||
| "yq-json" = { | ||
| command = "${pkgs.bash}/bin/bash"; | ||
| options = [ | ||
| "-euc" | ||
| '' | ||
| for file in "$@"; do | ||
| ${lib.getExe yq-go} -i --output-format=json $file | ||
| done | ||
| '' | ||
| "--" # bash swallows the second argument when using -c | ||
| ]; | ||
| includes = [ "*.json" ]; | ||
| }; | ||
| }; | ||
| } | ||
| ``` |
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same here, not that important feature to be in the README