numtide/treefmt
Archived
8
0
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

support formatter ordering #20

Merged
brianmcgee merged 4 commits from feat/formatter-ordering into main 2024-01-12 11:46:05 +00:00
Conversation 2 Commits 4 Files Changed 5 +249 -84
brianmcgee commented 2024-01-08 16:21:47 +00:00
Member
Copy Link

Allows specifying the order in which formatters are applied.

Very simple for now, adding a Before field to the formatted config which allows the user to say that formatter x needs to be applied before formatted y.

[formatter.statix]
command = "statix"
includes = ["*.nix"]
before = "deadnix"

[formatter.deadnix]
command = "statix"
includes = ["*.nix"]

Signed-off-by: Brian McGee brian@bmcgee.ie

Allows specifying the order in which formatters are applied. Very simple for now, adding a `Before` field to the formatted config which allows the user to say that formatter `x` needs to be applied _before_ formatted `y`. ```toml [formatter.statix] command = "statix" includes = ["*.nix"] before = "deadnix" [formatter.deadnix] command = "statix" includes = ["*.nix"] ``` Signed-off-by: Brian McGee <brian@bmcgee.ie>
brianmcgee added 1 commit 2024-01-08 16:21:47 +00:00 
Signed-off-by: Brian McGee <brian@bmcgee.ie>
brianmcgee commented 2024-01-08 16:24:49 +00:00
Author
Member
Copy Link

@zimbatm what do you think about allowing the user to configure a formatter as needing to be before another?

Essentially, it restricts things to simple linear behaviour. I can't envision a scenario that would require a more complex config.

In a real-world scenario, you would have statix before deadnix for example.

test.WriteConfig(t, configPath, format.Config{
		Formatters: map[string]*format.Formatter{
			"hs-a": {
				Command:  "echo",
				Includes: []string{"*.hs"},
				Before:   "hs-b",
			},
			"hs-b": {
				Command:  "echo",
				Includes: []string{"*.hs"},
				Before:   "hs-c",
			},
			"hs-c": {
				Command:  "echo",
				Includes: []string{"*.hs"},
			},
			"py-a": {
				Command:  "echo",
				Includes: []string{"*.py"},
				Before:   "py-b",
			},
			"py-b": {
				Command:  "echo",
				Includes: []string{"*.py"},
			},
		},
	})
@zimbatm what do you think about allowing the user to configure a formatter as needing to be before another? Essentially, it restricts things to simple linear behaviour. I can't envision a scenario that would require a more complex config. In a real-world scenario, you would have `statix` before `deadnix` for example. ```go test.WriteConfig(t, configPath, format.Config{ Formatters: map[string]*format.Formatter{ "hs-a": { Command: "echo", Includes: []string{"*.hs"}, Before: "hs-b", }, "hs-b": { Command: "echo", Includes: []string{"*.hs"}, Before: "hs-c", }, "hs-c": { Command: "echo", Includes: []string{"*.hs"}, }, "py-a": { Command: "echo", Includes: []string{"*.py"}, Before: "py-b", }, "py-b": { Command: "echo", Includes: []string{"*.py"}, }, }, }) ```
brianmcgee requested review from zimbatm 2024-01-08 16:24:56 +00:00
zimbatm approved these changes 2024-01-08 17:03:04 +00:00
zimbatm left a comment
Owner

I haven't wrapped my head around the concurrent aspect of the code, but the rest looks good.

In some cases, you might want to declare that deadnix is run before both statix and nixpkgs-fmt. The intent can't be expressed with the current design, but this can be added in a comment. I think this is good for the first iteration.

I haven't wrapped my head around the concurrent aspect of the code, but the rest looks good. In some cases, you might want to declare that deadnix is run before both statix and nixpkgs-fmt. The intent can't be expressed with the current design, but this can be added in a comment. I think this is good for the first iteration.
internal/cli/format.go Outdated
@ -67,0 +72,4 @@
if !ok {
return fmt.Errorf(
"formatter %v is before %v but config for %v was not found",
name, formatter.Before, formatter.Before,
zimbatm commented 2024-01-08 16:50:01 +00:00
Owner

formatter.Before is there 2 times

formatter.Before is there 2 times
brianmcgee commented 2024-01-08 17:05:26 +00:00
Author
Member

If you look at the string you can see why it's listed twice

If you look at the string you can see why it's listed twice
brianmcgee marked this conversation as resolved
internal/cli/format.go Outdated
@ -67,0 +74,4 @@
"formatter %v is before %v but config for %v was not found",
name, formatter.Before, formatter.Before,
)
}
zimbatm commented 2024-01-08 16:52:42 +00:00
Owner

You need a second for loop here to check for the dependency cycle.

You need a second for loop here to check for the dependency cycle.
brianmcgee commented 2024-01-08 17:05:02 +00:00
Author
Member

Yeah I haven't done the dependency cycle check yet

Yeah I haven't done the dependency cycle check yet
brianmcgee commented 2024-01-12 10:08:59 +00:00
Author
Member

Addressed in 23c86cee02

Addressed in 23c86cee027e133181577f749f7716e1ad0986cb
brianmcgee marked this conversation as resolved
internal/format/format.go Outdated
@ -25,2 +25,4 @@
// Excludes is an optional list of glob patterns used to exclude certain files from this Formatter.
Excludes []string
// Before is the name of another formatter which must process a path after this one
Before string
zimbatm commented 2024-01-08 16:58:12 +00:00
Owner

Personal taste thing: because of how many public/private fields there are, I would split this into a FormatterConfig that only contains the config and serializes/deserializes, and then the Formatter that gets generated from the config. That way, how to interact with the structs in the rest of the code becomes clearer. I don't think the Before field should be mutated in the code for example.

Personal taste thing: because of how many public/private fields there are, I would split this into a FormatterConfig that only contains the config and serializes/deserializes, and then the Formatter that gets generated from the config. That way, how to interact with the structs in the rest of the code becomes clearer. I don't think the Before field should be mutated in the code for example.
brianmcgee commented 2024-01-10 14:29:02 +00:00
Author
Member

It was a fair point, I've separated things out in c542655177

It was a fair point, I've separated things out in https://git.numtide.com/numtide/treefmt/commit/c54265517754f4d67684e5810c87cbba0644ae0d
brianmcgee marked this conversation as resolved
brianmcgee commented 2024-01-08 17:07:53 +00:00
Author
Member
Copy Link

In some cases, you might want to declare that deadnix is run before both statix and nixpkgs-fmt. The intent can't be expressed with the current design, but this can be added in a comment. I think this is good for the first iteration.

In the example you provide, deadnix would be before statix which would be before nixpkgs-fmt:

[deadnix]
...
Before = "statix"

[statix]
...
Before = "nixpkgs-fmt"

[nixpkgs-fmt]
...

I agree, this could be more expressive but as a first iteration it would solve some existing problems.

> In some cases, you might want to declare that deadnix is run before both statix and nixpkgs-fmt. The intent can't be expressed with the current design, but this can be added in a comment. I think this is good for the first iteration. In the example you provide, `deadnix` would be before `statix` which would be before `nixpkgs-fmt`: ```toml [deadnix] ... Before = "statix" [statix] ... Before = "nixpkgs-fmt" [nixpkgs-fmt] ... ``` I agree, this could be more expressive but as a first iteration it would solve some existing problems.
👍 1
brianmcgee added 1 commit 2024-01-10 14:28:32 +00:00 
Signed-off-by: Brian McGee <brian@bmcgee.ie>
brianmcgee force-pushed feat/formatter-ordering from c542655177 to d323715fa8 2024-01-12 09:44:07 +00:00 Compare
brianmcgee added 1 commit 2024-01-12 10:08:21 +00:00 
Signed-off-by: Brian McGee <brian@bmcgee.ie>
brianmcgee changed title from WIP: support formatter ordering to support formatter ordering 2024-01-12 10:09:08 +00:00
brianmcgee merged commit c7d0138a02 into main 2024-01-12 11:46:05 +00:00
This repo is archived. You cannot comment on pull requests.
Reviewers
No reviewers
zimbatm
Labels
Clear labels   
Kind/Breaking

Breaking change that won't be backward compatible

  
Kind/Bug

Something is not working

  
Kind/Documentation

Documentation changes

  
Kind/Enhancement

Improve existing functionality

  
Kind/Feature

New functionality

  
Kind/Security

This is security issue

  
Kind/Testing

Issue or pull request related to testing

  
Priority
Critical
The priority is critical

  
Priority
High
The priority is high

  
Priority
Low
The priority is low

  
Priority
Medium
The priority is medium

  
Reviewed
Confirmed
Issue has been confirmed

  
Reviewed
Duplicate
This issue or pull request already exists

  
Reviewed
Invalid
Invalid issue

  
Reviewed
Won't Fix
This issue won't be fixed

  
Status
Abandoned
Somebody has started to work on this but abandoned work

  
Status
Blocked
Something is blocking this issue or pull request

  
Status
Need More Info
Feedback is required to reproduce issue or to continue work

No Label
Kind/Breaking
Kind/Bug
Kind/Documentation
Kind/Enhancement
Kind/Feature
Kind/Security
Kind/Testing
Priority
Critical
Priority
High
Priority
Low
Priority
Medium
Reviewed
Confirmed
Reviewed
Duplicate
Reviewed
Invalid
Reviewed
Won't Fix
Status
Abandoned
Status
Blocked
Status
Need More Info
Milestone
Clear milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
No Assignees
2 Participants
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: numtide/treefmt#20
No description provided.
Delete Branch "feat/formatter-ordering"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?