xrefcheck/exec/Main.hs

{- SPDX-FileCopyrightText: 2018-2019 Serokell <https://serokell.io>
 -
 - SPDX-License-Identifier: MPL-2.0
 -}

module Main where

import Universum

import Data.ByteString qualified as BS
import Main.Utf8 (withUtf8)

import Xrefcheck.CLI (Command (..), getCommand)
import Xrefcheck.Command (defaultAction)
import Xrefcheck.Config (defConfigText)

main :: IO ()
main = withUtf8 $ do
  command <- getCommand
  case command of
    DefaultCommand options ->
      defaultAction options
    DumpConfig repoType path ->
      BS.writeFile path (defConfigText repoType)
[INT-128] Make the repository REUSE compliant Problem: nowadays we want all files to store licensing information in machine-readable format and to use reuse tool to check that. But the repo is not REUSE compliant. Solution: add `LICENSES` folder and licensing information for each file. 2019-12-18 17:18:55 +03:00			`{- SPDX-FileCopyrightText: 2018-2019 Serokell <https://serokell.io>`
			`-`
			`- SPDX-License-Identifier: MPL-2.0`
			`-}`

[INT-31] Implement cross-references verifier 2018-10-11 00:15:08 +03:00			`module Main where`

Remove mixins Problem: Stack cannot build projects with mixins, and they only used to splice universum instead of base. Solution: Use `NoImplicitPreduce` and import `Universum` everywhere explicitly. 2021-07-26 11:00:21 +03:00			`import Universum`

Improve readability of imports Problem: In ``` import qualified Foo.Bar as Bar import Foo.Bar (Bar) ``` names of the imported modules are on different vertical lines, which disables autosorting, and makes it harder to read. Solution: Use `ImportQualifiedPost` 2021-07-26 11:05:00 +03:00			`import Data.ByteString qualified as BS`
Use UTF-8 encoding for stdin/stdout Problem: we use many unusual unicode characters, on some locales this may cause failures on attempt to print to stdout. Solution: it is generally a good practice to set encoding of all handlers to UTF-8, and this commit brings `with-utf8` package which does that. 2020-03-25 16:34:32 +03:00			`import Main.Utf8 (withUtf8)`
[INT-31] Implement cross-references verifier 2018-10-11 00:15:08 +03:00
[Chore] Move commands related functionality to lib Problem: We have `exec` directory with `Main.hs` which (from semantic) supposed to only run Xrefcheck. Also, it's a common practice to keep `Main.hs` as simple as it possible. But now it have some logic. Solution: Move commands related functionality to lib (separate module) and keep `Main.hs` very simple, only as runner. 2021-09-22 18:05:29 +03:00			`import Xrefcheck.CLI (Command (..), getCommand)`
			`import Xrefcheck.Command (defaultAction)`
			`import Xrefcheck.Config (defConfigText)`
Add CLI option for dumping config Problem: we have moved config to `src-files`, now user needs a way to get config. Solution: add a CLI option. 2019-12-03 22:51:39 +03:00
			`main :: IO ()`
Use UTF-8 encoding for stdin/stdout Problem: we use many unusual unicode characters, on some locales this may cause failures on attempt to print to stdout. Solution: it is generally a good practice to set encoding of all handlers to UTF-8, and this commit brings `with-utf8` package which does that. 2020-03-25 16:34:32 +03:00			`main = withUtf8 $ do`
[Chore] Move commands related functionality to lib Problem: We have `exec` directory with `Main.hs` which (from semantic) supposed to only run Xrefcheck. Also, it's a common practice to keep `Main.hs` as simple as it possible. But now it have some logic. Solution: Move commands related functionality to lib (separate module) and keep `Main.hs` very simple, only as runner. 2021-09-22 18:05:29 +03:00			`command <- getCommand`
			`case command of`
			`DefaultCommand options ->`
			`defaultAction options`
			`DumpConfig repoType path ->`
			`BS.writeFile path (defConfigText repoType)`