Skip to content

Commit

Permalink
Add --filename flag for overriding the filename when using stdinTarget
Browse files Browse the repository at this point in the history
When `--filename path` is specified, any diagnostics will use the
`path` instead of `<stdin>`.

Closes #263
  • Loading branch information
pluiedev committed Nov 21, 2024
1 parent 92c9d8c commit f34a1b4
Showing 1 changed file with 14 additions and 6 deletions.
20 changes: 14 additions & 6 deletions main/Main.hs
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import Data.ByteString.Char8 (unpack)
import Data.Either (lefts)
import Data.FileEmbed
import Data.List (isSuffixOf)
import Data.Maybe (fromMaybe)
import Data.Text (Text)
import qualified Data.Text.IO as TextIO (getContents, hPutStr, putStr)
import Data.Version (showVersion)
Expand Down Expand Up @@ -49,7 +50,8 @@ data Nixfmt = Nixfmt
quiet :: Bool,
strict :: Bool,
verify :: Bool,
ast :: Bool
ast :: Bool,
filename :: Maybe FilePath
}
deriving (Show, Data, Typeable)

Expand All @@ -76,7 +78,13 @@ options =
ast =
False
&= help
"Pretty print the internal AST, only for debugging"
"Pretty print the internal AST, only for debugging",

filename =
Nothing
&= help
"The filename to display when the file input is given through stdin.\n\
\Useful for tools like editors and autoformatters that wish to use Nixfmt without providing it direct file access, while still providing context to where the file is."
}
&= summary ("nixfmt " ++ versionFromFile)
&= help "Format Nix source code"
Expand Down Expand Up @@ -132,8 +140,8 @@ checkTarget format Target{tDoRead, tPath} = do
| formatted == contents -> Right ()
| otherwise -> Left $ tPath ++ ": not formatted"

stdioTarget :: Target
stdioTarget = Target TextIO.getContents "<stdin>" (const TextIO.putStr)
stdioTarget :: Maybe FilePath -> Target
stdioTarget filename = Target TextIO.getContents (fromMaybe "<stdin>" filename) (const TextIO.putStr)

fileTarget :: FilePath -> Target
fileTarget path = Target (readFileUtf8 path) path atomicWriteFile
Expand All @@ -148,8 +156,8 @@ checkFileTarget :: FilePath -> Target
checkFileTarget path = Target (readFileUtf8 path) path (const $ const $ pure ())

toTargets :: Nixfmt -> IO [Target]
toTargets Nixfmt{files = []} = pure [stdioTarget]
toTargets Nixfmt{files = ["-"]} = pure [stdioTarget]
toTargets Nixfmt{files = [], filename} = pure [stdioTarget filename]
toTargets Nixfmt{files = ["-"], filename} = pure [stdioTarget filename]
toTargets Nixfmt{check = False, files = paths} = map fileTarget <$> collectAllNixFiles paths
toTargets Nixfmt{check = True, files = paths} = map checkFileTarget <$> collectAllNixFiles paths

Expand Down

0 comments on commit f34a1b4

Please sign in to comment.