1
1
mirror of https://github.com/nmattia/niv.git synced 2024-11-29 09:42:35 +03:00

Show version in --help

This commit is contained in:
Nicolas Mattia 2019-09-23 22:37:17 +02:00
parent efce82e4ba
commit ee19f5f841
4 changed files with 108 additions and 10 deletions

View File

@ -197,7 +197,9 @@ $ niv update ghc -v 8.6.2
### Commands ### Commands
``` ```
NIV - Version manager for Nix projects niv - dependency manager for Nix projects
version: 0.2.0
Usage: niv COMMAND Usage: niv COMMAND

View File

@ -55,21 +55,109 @@ with rec
cabal upload "$@" "${niv-sdist}/niv-${niv-version}.tar.gz" cabal upload "$@" "${niv-sdist}/niv-${niv-version}.tar.gz"
''; '';
# WARNING: extremely disgusting hack below.
#
# <rant>
# I was trying to fix this issue: https://github.com/nmattia/niv/issues/109
# Basically, --help should also show niv's version. As usual when trying to
# lookup the documentation for `Paths_` I google "cabal Paths_ module", end
# up here:
# https://stackoverflow.com/questions/21588500/haskell-cabal-package-cant-find-paths-module,
# click this link:
# https://downloads.haskell.org/~ghc/7.0.3/docs/html/Cabal/authors.html#paths-module,
# and then try to find my way to the latest doc.
#
# (╯°□°)╯︵ ┻━┻
#
# But now that we're using cabal Paths_, the `ghci` `repl` function won't
# work! So I wonder: stack or cabal? Well, stack, it's been a while! But
# _of course_ there's no way to easily tell stack to use the system GHC!
# Even if there's no `stack.yaml`, stack will infer "some" LTS and
# `--system-ghc` will be discarded because the GHC versions don't match!!
#
# (╯°□°)╯︵ ┻━┻
#
# So I give good old `cabal repl` a try and, (not much of a) surprise, it
# complains that it can't start because niv contains more than one cabal
# component.
#
# (╯°□°)╯︵ ┻━┻
#
# WTF, there's now repl, new-repl, v1-repl, v2-repl. WHAT?
#
# (˚Õ˚)ر ~~~~╚╩╩╝
#
# So I try `cabal new-repl`, and it doesn't load _any_ main function
# (without having to actually write `main = Niv.Test.test` or doing weird
# stuff to load a `Main` module).
#
# (╯°□°)╯︵ ┻━┻
#
# And there's no `cabal new-repl -main-is ...`
#
# (╯°□°)╯︵ ┻━┻
#
# The workaround here:
# https://github.com/haskell/cabal/issues/5374#issuecomment-410431619
# suggests using -ghci-script=foo where foo specifies `main = bar`, but, as
# pointed out, the ghci script runs too early (and that's after having
# tried --ghci-options which doesn't work; must use --repl-options).
#
# (╯°□°)╯︵ ┻━┻ (˚Õ˚)ر ~~~~╚╩╩╝
#
# But there's hope! The `cabal new-repl` doc says you can load a
# "component". So I try with `cabal new-repl niv-test`. FIRST it builds
# everything (actually generates `.o`s and stuff) and then loads the
# _wrong_ module. At this point I can't help thinking that a monkey
# (bonobo, baboon, pick any) will still manage to pick the correct main 50%
# of the time. I don't want to jump to conclusion: I only gave cabal one
# chance, so I'm not sure how exactly it scores on the "pick the correct
# main" game.
#
# (゜-゜)
#
# Well,
# => rm -rf ~/.stack
# => rm -rf ~/.cabal
# => rm -rf dist
# => rm -rf dist-newstyle
#
# </rant>
#
# In order to make `Paths_niv(version)` available in `ghci`, we parse the
# version from `package.yaml` and create a dummy module that we inject in the
# `ghci` command.
niv-devshell = haskellPackages.shellFor niv-devshell = haskellPackages.shellFor
{ packages = (ps: [ ps.niv ]); { packages = (ps: [ ps.niv ]);
shellHook = shellHook =
'' ''
repl() { repl_for() {
haskell_version=$(cat ./package.yaml \
| grep -oP 'version: \K\d+.\d+.\d+' \
| sed 's/\./,/g' )
paths_niv=$(mktemp -d)/Paths_niv.hs
echo "module Paths_niv where" >> $paths_niv
echo "import qualified Data.Version" >> $paths_niv
echo "version :: Data.Version.Version" >> $paths_niv
echo "version = Data.Version.Version [$haskell_version] []" >> $paths_niv
niv_main=""
shopt -s globstar shopt -s globstar
ghci -clear-package-db -global-package-db -Wall app/NivTest.hs src/**/*.hs ghci -clear-package-db -global-package-db -Wall app/$1.hs src/**/*.hs $paths_niv
}
repl() {
repl_for NivTest
} }
repl_niv() { repl_niv() {
shopt -s globstar repl_for Niv
ghci -clear-package-db -global-package-db -Wall app/Niv.hs src/**/*.hs
} }
echo "To start a REPL session for the test suite, run:" echo "To start a REPL for the test suite, run:"
echo " > repl" echo " > repl"
echo " > :main" echo " > :main"
echo " (tests run)" echo " (tests run)"

View File

@ -1,5 +1,5 @@
name: niv name: niv
version: 0.1.1 version: 0.2.0
license: MIT license: MIT
author: Nicolas Mattia <nicolas@nmattia.com> author: Nicolas Mattia <nicolas@nmattia.com>
maintainer: Nicolas Mattia <nicolas@nmattia.com> maintainer: Nicolas Mattia <nicolas@nmattia.com>
@ -15,6 +15,9 @@ ghc-options:
# For macOS: https://github.com/gibiansky/IHaskell/issues/942 # For macOS: https://github.com/gibiansky/IHaskell/issues/942
- -optP-Wno-nonportable-include-path - -optP-Wno-nonportable-include-path
data-files:
- nix/sources.nix
extra-source-files: extra-source-files:
- README.md - README.md
@ -51,8 +54,6 @@ executables:
niv: niv:
main: Niv.main main: Niv.main
source-dirs: app source-dirs: app
data-files:
- nix/sources.nix
dependencies: dependencies:
- niv - niv
niv-test: niv-test:

View File

@ -24,6 +24,7 @@ import System.Exit (ExitCode(ExitSuccess))
import System.FilePath ((</>), takeDirectory) import System.FilePath ((</>), takeDirectory)
import System.Process (readProcessWithExitCode) import System.Process (readProcessWithExitCode)
import UnliftIO import UnliftIO
import Data.Version (showVersion)
import qualified Data.Aeson as Aeson import qualified Data.Aeson as Aeson
import qualified Data.Aeson.Encode.Pretty as AesonPretty import qualified Data.Aeson.Encode.Pretty as AesonPretty
import qualified Data.ByteString as B import qualified Data.ByteString as B
@ -36,13 +37,19 @@ import qualified Options.Applicative as Opts
import qualified Options.Applicative.Help.Pretty as Opts import qualified Options.Applicative.Help.Pretty as Opts
import qualified System.Directory as Dir import qualified System.Directory as Dir
-- I died a little
import Paths_niv (version)
cli :: IO () cli :: IO ()
cli = join $ Opts.execParser opts cli = join $ Opts.execParser opts
where where
opts = Opts.info (parseCommand <**> Opts.helper) $ mconcat desc opts = Opts.info (parseCommand <**> Opts.helper) $ mconcat desc
desc = desc =
[ Opts.fullDesc [ Opts.fullDesc
, Opts.header "NIV - Version manager for Nix projects" , Opts.headerDoc $ Just $
"niv - dependency manager for Nix projects" Opts.<$$>
"" Opts.<$$>
"version:" Opts.<+> Opts.text (showVersion version)
] ]
parseCommand :: Opts.Parser (IO ()) parseCommand :: Opts.Parser (IO ())