Ignore symlinks when formatting #57
Conversation
|
Ah, whoops, I broke |
This separates data and functionality better.
Before this, symlinks were replaced with a formatted file rather than formatting the file behind the symlink. The choice was between ignoring symlinks and following them. Following symlinks means potentially formatting files in an unexpected location which seems much worse than needing to wrap the arguments in a `readlink -f` when symlinks are otherwise ignored.
Lucus16
force-pushed
the
ignore-symlinks
branch
from
3e975cd
to
5c2281a
Compare
|
That should fix that. |
| @@ -9,6 +9,7 @@ | |||
| module Main where | |||
|
|
|||
| import Control.Concurrent (Chan, forkIO, newChan, readChan, writeChan) | |||
| import Control.Exception (IOException, try) | |||
There was a problem hiding this comment.
Please, only ever use Control.Exception.Safe from safe-exceptions.
There was a problem hiding this comment.
Also apparently it's in a wrong commit 🙄
| filterTarget :: (Target -> IO Result) -> Target -> IO Result | ||
| filterTarget operation StdioTarget = operation StdioTarget | ||
| filterTarget operation (FileTarget path) = do | ||
| isSymlink <- try $ pathIsSymbolicLink path |
There was a problem hiding this comment.
This will also catch async exceptions which you don’t want (this probably doesn’t matter in this specific case, but it’s better to place safe and future-proof). Use try for safe-exceptions.
|
One option might be to add |
|
I agree with using |
|
We plan to deprecate the directory mode directly in nixfmt and instead encourage use of treefmt. |
|
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/formatting-team-meeting-2024-05-28/46126/1 |
|
See #151 |
|
This pull request has been mentioned on NixOS Discourse. There might be relevant details there: https://discourse.nixos.org/t/formatting-team-meeting-2024-08-06/50222/1 |
Before this, symlinks were replaced with a formatted file rather than
formatting the file behind the symlink. The choice was between ignoring
symlinks and following them. Following symlinks means potentially
formatting files in an unexpected location which seems much worse than
needing to wrap the arguments in a
readlink -fwhen symlinks areotherwise ignored.
Fixes #56.