Skip to content

Add --filename flag for overriding the filename when using stdioTarget#264

Merged
tomberek merged 1 commit intoNixOS:masterfrom
pluiedev:push-qtpwkuzrzvsw
Nov 22, 2024
Merged

Add --filename flag for overriding the filename when using stdioTarget#264
tomberek merged 1 commit intoNixOS:masterfrom
pluiedev:push-qtpwkuzrzvsw

Conversation

@pluiedev
Copy link
Member

@pluiedev pluiedev commented Nov 21, 2024

When --filename path is specified, any diagnostics will use the path instead of <stdin>.

Closes #263

@github-actions
Copy link

github-actions bot commented Nov 21, 2024 •
edited
Loading

Nixpkgs diff

@pluiedev pluiedev changed the title Add --filename flag for overriding the filename when using stdinTarget Add --filename flag for overriding the filename when using stdioTarget Nov 21, 2024
infinisil
infinisil approved these changes Nov 21, 2024
View reviewed changes
Copy link
Member

@infinisil infinisil left a comment •
edited
Loading

Choose a reason for hiding this comment

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

LGTM, thanks!

Needs a treefmt to satisfy CI though :)

@pluiedev
Add --filename flag for overriding the filename when using stdioTarget
37c66ea 
When `--filename path` is specified, any diagnostics will use the
`path` instead of `<stdin>`.

Closes NixOS#263
@pluiedev
Copy link
Member Author

pluiedev commented Nov 21, 2024

Just did :D

@tomberek tomberek merged commit 923d379 into NixOS:master Nov 22, 2024
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/)
@mweinelt
Copy link
Member

mweinelt commented Dec 17, 2024

Was super suprised to see -f and --filename not point to the file to format, but to something else entirely.

Wouldn't --display-filename and -d be the less surprising option here?

@jfly jfly mentioned this pull request May 13, 2025
Open
@jfly
Copy link
Collaborator

jfly commented May 13, 2025

Wouldn't --display-filename and -d be the less surprising option here?

Good point. We'll be deprecating this option in #305.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tomberek tomberek tomberek approved these changes

@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.

Add a flag for overriding the filename of files passed through stdin

5 participants

@pluiedev @mweinelt @jfly @tomberek @infinisil