1
1
mirror of https://github.com/google/ormolu.git synced 2024-11-23 22:27:16 +03:00
ormolu/app/Main.hs
mrkkrp b9c8b64947 Implement more precise comment placement without ‘ghc-exactprint’
‘ghc-exactprint’ (or perhaps lexer of GHC itself) does a fairly poor job at
associating comments with elements of AST. In many cases the result is not
what you'd expect. We ran into insuperable problems with that to the effect
that correct comment placement were impossible.

The new approach is to exploit the raw position information provided by the
GHC lexer, that is, spans attached to AST elements and comments. This
allowed us to place comments in output in a very precise and satisfactory
fashion.
2019-05-08 22:03:21 +02:00

136 lines
3.4 KiB
Haskell

{-# LANGUAGE CPP #-}
{-# LANGUAGE LambdaCase #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE TemplateHaskell #-}
module Main (main) where
import Control.Monad
import Data.List (intercalate)
import Data.Version (showVersion)
import Development.GitRev
import Options.Applicative
import Ormolu
import Paths_ormolu (version)
import System.Exit (exitFailure)
import qualified Data.Text.IO as TIO
import qualified Data.Yaml as Yaml
-- | Entry point of the program.
main :: IO ()
main = withPrettyOrmoluExceptions $ do
Opts {..} <- execParser optsParserInfo
config <- case optConfigFile of
Nothing -> return optConfig
Just path -> do
config <- Yaml.decodeFileThrow path
return (config <> optConfig)
r <- ormoluFile config optInputFile
case optMode of
Stdout ->
TIO.putStr r
InPlace ->
TIO.writeFile optInputFile r
Check -> do
r' <- TIO.readFile optInputFile
when (r /= r') exitFailure
----------------------------------------------------------------------------
-- Command line options parsing.
data Opts = Opts
{ optMode :: !Mode
-- ^ Mode of operation
, optConfigFile :: !(Maybe FilePath)
-- ^ Location of configuration file (optional)
, optConfig :: !Config
-- ^ Ormolu 'Config'
, optInputFile :: !FilePath
-- ^ Input source file
}
-- | Mode of operation.
data Mode
= Stdout -- ^ Output formatted source code to stdout
| InPlace -- ^ Overwrite original file
| Check -- ^ Exit with non-zero status code if
-- source is not already formatted
deriving (Eq, Show)
optsParserInfo :: ParserInfo Opts
optsParserInfo = info (helper <*> ver <*> optsParser) . mconcat $
[ fullDesc
, progDesc ""
, header ""
]
where
ver :: Parser (a -> a)
ver = infoOption verStr . mconcat $
[ long "version"
, short 'v'
, help "Print version of the program"
]
verStr = intercalate "\n"
[ unwords
[ "ormolu"
, showVersion version
, $gitBranch
, $gitHash
]
, "using ghc " ++ VERSION_ghc
]
optsParser :: Parser Opts
optsParser = Opts
<$> (option parseMode . mconcat)
[ long "mode"
, short 'm'
, metavar "MODE"
, value Stdout
, help "Mode of operation: 'stdout', 'inplace', or 'check'"
]
<*> (optional . strOption . mconcat)
[ long "config"
, short 'c'
, metavar "CONFIG"
, help "Location of configuration file"
]
<*> configParser
<*> (strArgument . mconcat)
[ metavar "FILE"
, help "Haskell source file to format"
]
configParser :: Parser Config
configParser = Config
<$> (fmap (fmap DynOption) . many . strOption . mconcat)
[ long "ghc-opt"
, short 'o'
, metavar "OPT"
, help "GHC options to enable (e.g. language extensions)"
]
<*> (switch . mconcat)
[ long "unsafe"
, short 'u'
, help "Do formatting faster but without automatic detection of defects"
]
<*> (switch . mconcat)
[ long "debug"
, short 'd'
, help "Output information useful for debugging"
]
----------------------------------------------------------------------------
-- Helpers
-- | Parse 'Mode'.
parseMode :: ReadM Mode
parseMode = eitherReader $ \case
"stdout" -> Right Stdout
"inplace" -> Right InPlace
"check" -> Right Check
s -> Left $ "unknown mode: " ++ s