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.

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

Adhere to [RFC 0166] formatting #404

Open
nyabinary opened this issue Nov 10, 2023 · 15 comments
Open

Adhere to [RFC 0166] formatting #404

nyabinary opened this issue Nov 10, 2023 · 15 comments
Labels
component | style Modifications to the formatting rules roadmap | style config status | it is a good thing We agree it is good to implement this type | feature request New feature or request

Comments

@nyabinary
Copy link

nyabinary commented Nov 10, 2023

NixOS/rfcs#166

@nyabinary nyabinary changed the title Adhere to RFC101 formatting Adhere to RFC166 formatting Nov 15, 2023
@nyabinary
Copy link
Author

cc: @kamadorueda

@kamadorueda
Copy link
Owner

It's probably a good question for the community once the RFC is adopted, the options are:

  1. make Alejandra follow the suggested style
  2. make Alejandra keep its existing style (there will always be an audience for this style)
  3. archive all alternative formatters so the community only has 1 option available

@nyabinary
Copy link
Author

It's probably a good question for the community once the RFC is adopted, the options are:

1. make Alejandra follow the suggested style

2. make Alejandra keep its existing style (there will always be an audience for this style)

3. archive all alternative formatters so the community only has 1 option available

As I understand 3 is a non-goal, the formatter implementation is supposed to be considered more of a standard specification for formatting, so different implementations could exist as well, 1. Would be the most optimal.

@infinisil
Copy link

The main intention behind making it a standard is to not make the implementation the standard. This allows some room for both bug fixes and minor improvements, but it also makes it clear which changes need to go though another RFC.

And while Nixpkgs will have to use the official formatter, there's no problem with other standard-complient formatters existing. It would also be possible to change out the underlying implementation of the official formatter (as long as it's standards-compliant).

@infinisil
Copy link

But I do think that for the benefit of everybody's time, it would be best to archive other formatters if the RFC is accepted and implemented.

@nyabinary
Copy link
Author

But I do think that for the benefit of everybody's time, it would be best to archive other formatters if the RFC is accepted and implemented.

I disagree on this end, I think alejandra should adopt the standard, but some formatters, of course, can be archived like nixpkgs-fmt. Since that had one goal in mind, alejandra is more broad and widely used in the community (including myself) so I think its best to continue supporting it and change it to adhere to the RFC.

@piegamesde
Copy link
Contributor

If adapting Alejandra to the RFC166 format was easy, I'd already have done so half a year ago. Initially, nixfmt was only our second choice after Alejandra.

@nyabinary
Copy link
Author

If adapting Alejandra to the RFC166 format was easy, I'd already have done so half a year ago. Initially, nixfmt was only our second choice after Alejandra.

What's wrong with Alejandra that makes it harder to adher to RFC0166?

@nyabinary nyabinary changed the title Adhere to RFC166 formatting Adhere to RFC0166 formatting Dec 19, 2023
@nyabinary nyabinary changed the title Adhere to RFC0166 formatting Adhere to [RFC 0166] formatting Dec 19, 2023
@infinisil
Copy link

We recorded some meetings notes about that here

@nyabinary
Copy link
Author

Nix Formatter is now out for testing in nixpkgs.
https://discourse.nixos.org/t/call-for-testing-nix-formatter/39179/

@nyabinary
Copy link
Author

@kamadorueda
The time is now to decide I guess, since NixOS/rfcs#166 got officially merged, and their now a tracking issue for nixfmt: NixOS/nixfmt#153

@justinrubek
Copy link

As much as I'd love for us all to fall on a single standard, after trying out the new nixfmt I don't think I'm willing to use an RFC166 compliant formatter on any of my projects. I'd prefer that alejandra remain as it is currently.

@nyabinary
Copy link
Author

As much as I'd love for us all to fall on a single standard, after trying out the new nixfmt I don't think I'm willing to use an RFC166 compliant formatter on any of my projects. I'd prefer that alejandra remain as it is currently.

We could have different modes tbf

@MattSturgeon
Copy link

We could have different modes tbf

Is anyone actually going to work on and maintain that when there's already alternative formatting tools out there?

It seems to me that alejandra has different goals to RFC 166. If so this should be considered a "won't fix".

@viperML
Copy link

viperML commented May 2, 2024

After trying nixfmt-rfc-style, I have decided to keep using alejandra in my personal projects. My opinion is that it is ok to have different formatters to choose from, that don't comply with the "standard"

@kamadorueda kamadorueda added type | feature request New feature or request component | style Modifications to the formatting rules status | it is a good thing We agree it is good to implement this roadmap | style config labels Nov 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component | style Modifications to the formatting rules roadmap | style config status | it is a good thing We agree it is good to implement this type | feature request New feature or request
Projects
None yet
Development

No branches or pull requests

7 participants