add treefmt.withConfig #169

zimbatm · 2022-05-20T14:04:11Z

This is useful if you want to configure treefmt with nix, and precisely
pass all the commands from nixpkgs.

srid · 2022-05-29T13:22:20Z

srid · 2022-05-29T13:24:23Z

.envrc

@@ -0,0 +1,2 @@
+export PRJ_ROOT=$PWD


Interesting trick! Does direnv always use project root (parent dir of .direnv file) as PWD even if you open the terminal directly in one of its sub directories?

Yes, this is necessary so that relative paths in the .envrc have the same result, even if the user jumps into a sub-folder directly.

DIRENV_DIR already exists and can be queried if you use direnv, there may be no need to set PRJ_ROOT then.

srid · 2022-05-29T13:33:51Z

@zimbatm What do you think of exposing a flakeModule (a la cachix/git-hooks.nix#130) so that projects that already use flake-parts can use this directly, thus resolving #165?

zimbatm · 2022-05-30T08:30:06Z

Sounds good, the flake module probably can call treefmt.withConfig with its resulting schema at the end.

default.nix

srid · 2022-05-30T13:28:16Z

Sounds good, the flake module probably can call treefmt.withConfig with its resulting schema at the end.

Great; I'd be happy to test it out here:

https://github.com/srid/haskell-template/blob/6c9e2eb0870b108731df87cdcbb016c064e55041/flake.nix#L19-L25

zimbatm · 2022-06-07T16:43:48Z

@srid ok this is ready if you want to give it a try

srid · 2022-06-11T00:43:36Z

@zimbatm Trying it out on haskell-template,

diff --git a/flake.nix b/flake.nix
index 9918a57..684242e 100644
--- a/flake.nix
+++ b/flake.nix
@@ -5,22 +5,23 @@
     flake-parts.url = "github:hercules-ci/flake-parts";
     flake-parts.inputs.nixpkgs.follows = "nixpkgs";
     haskell-flake.url = "github:srid/haskell-flake";
+    treefmt.url = "github:numtide/treefmt/withConfig";
+    treefmt.flake = false;
   };
 
-  outputs = { self, nixpkgs, flake-parts, haskell-flake, ... }:
+  outputs = inputs@{ self, nixpkgs, flake-parts, haskell-flake, treefmt, ... }:
     flake-parts.lib.mkFlake { inherit self; } {
       systems = nixpkgs.lib.systems.flakeExposed;
       imports = [
         haskell-flake.flakeModule
       ];
-      perSystem = { self', pkgs, ... }: {
+      perSystem = { self', system, pkgs, ... }: {
         haskellProjects.default = {
           root = ./.;
           buildTools = hp: {
-            # TODO: Use https://github.com/numtide/treefmt/pull/169
             inherit (pkgs)
-              treefmt
               nixpkgs-fmt;
+            treefmt = (import treefmt { inherit system; nixpkgs = pkgs; }).treefmt.withConfig (pkgs.lib.importTOML ./treefmt.toml);
             inherit (hp)
               cabal-fmt
               fourmolu;

I see:

srid on now haskell-template on  master [!] via λ 9.0.2 via ❄️  impure (ghc-shell-for-haskell-template-0.1.0.0) 
❯ more $(which treefmt)
#!/nix/store/14lypyys4gfcl982rjddxa6jg7msqz9q-bash-5.1-p16/bin/bash
exec /nix/store/d88p6rcrpp83ir7i6lasljf871j34g25-treefmt/bin/treefmt --config-file /nix/store/vfblhmhr809df21cvcnh7mdwpqn0nv9w-treefmt.toml "$@"


srid on now haskell-template on  master [!] via λ 9.0.2 via ❄️  impure (ghc-shell-for-haskell-template-0.1.0.0) 
❯ treefmt
[ERR]: If --config-file is set, --tree-root must also be set

I wanted to see how importTOML behaved before switching to config defined entirely in Nix, but as you can see it looks like I need this PRJ_ROOT env var and pass it via --tree-root, which in turn would require direnv or devshell. Therefore, it seems to me that treefmt.withConfig as it is implemented currently wouldn't work with projects that use neither direnv nor devshell.

EDIT: I suppose we could add PRJ_ROOT to shellHook, but that would still add 'low-level' nix to flake.nix.

zimbatm · 2022-06-15T13:06:41Z

agreed. And since the absolute path to the project root would vary from machine to machine, I don't have a really good solution for it. Unless maybe the function also takes a command that points to the project root, like git rev-parse --show-toplevel

srid · 2022-08-17T18:27:26Z

What if we had a wrapper script to determine the project root by traversing until a parent directory with a flake.nix in it? It does assume that the project has no sub-flakes in it.

srid · 2022-08-17T22:48:11Z

What if we had a wrapper script to determine the project root by traversing until a parent directory with a flake.nix in it? It does assume that the project has no sub-flakes in it.

We can refine this idea to avoid the sub-flake assumption as follows:

formatter = pkgs.treefmt.withConfig (nixpkgs.lib.importTOML ./treefmt.toml) { projectRootFile = "flake.nix" };

Basically, this tells the wrapper script to cd ../. until the projectRootFile can be located. If the project has sub-flakes, the user can set it to an alternative file, like { projectRootFile = "cabal.project"; }.

@zimbatm If we can get this feature merged, it would be useful in Platonic-Systems/treefmt-flake#1. Ultimately, I imagine that treemfmt-flake can be upstreamed to the flake.nix of this repo.

zimbatm · 2022-08-18T08:55:41Z

yeah, that makes sense. Do you have the time to finish this PR so it takes pkgs.treefmt.withConfig { config = ...; projectRootFile = "..."; }, all of this gets passed to the module system, and it outputs the wrapper?

srid · 2022-08-23T16:01:03Z

@zimbatm Let me know what you think: #177

zimbatm · 2022-08-23T17:00:15Z

ok, I think this is ready now. Any last words/feedback?

zimbatm · 2022-08-23T17:05:27Z

flake.nix

@@ -20,6 +20,14 @@

        packages = pkgs;

+        # In Nix 2.8 you can run `nix fmt` to format this whole repo. Note that you need to have loaded the
+        # `nix develop` shell before so the various formatters are available in the PATH.


that's true only if the dependencies are not specified in nix. if the config has references to packages then it should work even outside of nix develop

srid · 2022-08-23T19:45:38Z

ok, I think this is ready now. Any last words/feedback?

I've tested it to work after applying #178

Looks good to merge. I'd only suggest making wrapper.projectRootFile = "flake.nix"; the default so the user doesn't have to specify it explicitly on every project using flakes (but without a sub-flake, as is usually the case).

zimbatm · 2022-08-24T10:38:55Z

Rebased. It looks like flake.parts doesn't support the formatter option yet. I will give it another shot next week.

default.nix

zimbatm · 2022-09-19T15:01:23Z

Blocked on hercules-ci/flake-parts#56

56: add formatter schema r=roberth a=zimbatm This is needed for flakes that want to support `nix fmt`. Right now it's missing some testing as I didn't find a test framework for it. Needed by numtide/treefmt#169 Co-authored-by: zimbatm <[email protected]> Co-authored-by: Jonas Chevalier <[email protected]>

zimbatm · 2022-09-21T15:01:01Z

ok, I think this is ready

.envrc

Co-authored-by: Jörg Thalheim <[email protected]>

This is useful if you want to configure treefmt with nix, and precisely pass all the commands from nixpkgs. Co-authored-by: Sridhar Ratnakumar <[email protected]>

srid · 2022-09-21T18:41:57Z

@zimbatm Will this (withConfig) be upstreamed to nixpkgs at some point?

zimbatm · 2022-09-21T19:32:04Z

I'm unsure about the policy regarding nix modules in the pkgs/ tree. Are there any precedents?

srid · 2022-09-21T21:04:27Z

I have seen passthru used by certain packages, eg: https://github.com/NixOS/nixpkgs/blob/45b92369d6fafcf9e462789e98fbc735f23b5f64/nixos/modules/services/networking/stubby.nix#L31

zimbatm · 2022-09-23T08:29:09Z

that's not quite the same, plus it's using IFD :-D

With @Mic92 we discussed moving this to another repo, so all the module systems could live separate from the code, and include pre-made samples for the various programs.

zimbatm · 2022-09-23T11:11:21Z

Now live at https://github.com/numtide/treefmt-nix . Looking for feedback!

srid · 2022-09-23T17:53:52Z

Looking for feedback!

Sure: numtide/treefmt-nix#2

srid reviewed May 29, 2022

View reviewed changes

zimbatm commented May 30, 2022

View reviewed changes

default.nix Outdated Show resolved Hide resolved

zimbatm changed the title ~~WIP: add treefmt.withConfig~~ add treefmt.withConfig Jun 7, 2022

zimbatm marked this pull request as ready for review June 7, 2022 16:43

zimbatm force-pushed the withConfig branch 2 times, most recently from 01b66aa to 582c5aa Compare July 5, 2022 08:59

zimbatm force-pushed the withConfig branch from ff1cbb0 to b8513c8 Compare August 23, 2022 16:59

zimbatm commented Aug 23, 2022

View reviewed changes

zimbatm force-pushed the withConfig branch from 0341220 to fc0331b Compare August 24, 2022 10:38

zimbatm force-pushed the withConfig branch 2 times, most recently from 574b533 to 19a0b32 Compare August 24, 2022 10:41

srid reviewed Aug 31, 2022

View reviewed changes

default.nix Outdated Show resolved Hide resolved

zimbatm force-pushed the withConfig branch from 19a0b32 to c0a0c12 Compare September 19, 2022 14:48

zimbatm mentioned this pull request Sep 19, 2022

add formatter schema hercules-ci/flake-parts#56

Merged

flake update

0c20ac5

zimbatm force-pushed the withConfig branch 3 times, most recently from 4d960bc to 1bac2bc Compare September 21, 2022 11:20

zimbatm force-pushed the withConfig branch 2 times, most recently from f44778c to f11a866 Compare September 21, 2022 15:10

Mic92 reviewed Sep 21, 2022

View reviewed changes

.envrc Outdated Show resolved Hide resolved

add .envrc for the project

f2bbb89

Co-authored-by: Jörg Thalheim <[email protected]>

zimbatm force-pushed the withConfig branch 2 times, most recently from 905fe05 to de9885d Compare September 21, 2022 16:37

introduce treefmt.withConfig

8467716

This is useful if you want to configure treefmt with nix, and precisely pass all the commands from nixpkgs. Co-authored-by: Sridhar Ratnakumar <[email protected]>

zimbatm force-pushed the withConfig branch from de9885d to 8467716 Compare September 21, 2022 16:40

zimbatm merged commit 9615c40 into master Sep 21, 2022

zimbatm deleted the withConfig branch September 21, 2022 16:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add treefmt.withConfig #169

add treefmt.withConfig #169

zimbatm commented May 20, 2022

srid commented May 29, 2022

srid May 29, 2022 •

edited

Loading

zimbatm May 30, 2022

MatthewCroughan Sep 20, 2022

srid commented May 29, 2022

zimbatm commented May 30, 2022

srid commented May 30, 2022

zimbatm commented Jun 7, 2022

srid commented Jun 11, 2022 •

edited

Loading

zimbatm commented Jun 15, 2022

srid commented Aug 17, 2022

srid commented Aug 17, 2022

zimbatm commented Aug 18, 2022

srid commented Aug 23, 2022

zimbatm commented Aug 23, 2022

zimbatm Aug 23, 2022

srid commented Aug 23, 2022 •

edited

Loading

zimbatm commented Aug 24, 2022

zimbatm commented Sep 19, 2022

zimbatm commented Sep 21, 2022

srid commented Sep 21, 2022

zimbatm commented Sep 21, 2022

srid commented Sep 21, 2022

zimbatm commented Sep 23, 2022

zimbatm commented Sep 23, 2022

srid commented Sep 23, 2022

add treefmt.withConfig #169

add treefmt.withConfig #169

Conversation

zimbatm commented May 20, 2022

srid commented May 29, 2022

srid May 29, 2022 • edited Loading

Choose a reason for hiding this comment

zimbatm May 30, 2022

Choose a reason for hiding this comment

MatthewCroughan Sep 20, 2022

Choose a reason for hiding this comment

srid commented May 29, 2022

zimbatm commented May 30, 2022

srid commented May 30, 2022

zimbatm commented Jun 7, 2022

srid commented Jun 11, 2022 • edited Loading

zimbatm commented Jun 15, 2022

srid commented Aug 17, 2022

srid commented Aug 17, 2022

zimbatm commented Aug 18, 2022

srid commented Aug 23, 2022

zimbatm commented Aug 23, 2022

zimbatm Aug 23, 2022

Choose a reason for hiding this comment

srid commented Aug 23, 2022 • edited Loading

zimbatm commented Aug 24, 2022

zimbatm commented Sep 19, 2022

zimbatm commented Sep 21, 2022

srid commented Sep 21, 2022

zimbatm commented Sep 21, 2022

srid commented Sep 21, 2022

zimbatm commented Sep 23, 2022

zimbatm commented Sep 23, 2022

srid commented Sep 23, 2022

srid May 29, 2022 •

edited

Loading

srid commented Jun 11, 2022 •

edited

Loading

srid commented Aug 23, 2022 •

edited

Loading