git-annex/CmdLine/GlobalSetter.hs

{- git-annex global options
 -
 - Copyright 2015-2021 Joey Hess <id@joeyh.name>
 -
 - Licensed under the GNU AGPL version 3 or higher.
  -}
  
module CmdLine.GlobalSetter where

import Types.DeferredParse
import Common
import Annex

import Options.Applicative

globalFlag :: Annex () -> Mod FlagFields GlobalSetter -> GlobalOption
globalFlag setter = flag' (DeferredParse setter) 

globalSetter :: (v -> Annex ()) -> Parser v -> GlobalOption
globalSetter setter parser = DeferredParse . setter <$> parser

parserGlobalOptions :: [GlobalOption] -> Parser GlobalSetter
parserGlobalOptions [] = DeferredParse <$> pure noop
parserGlobalOptions l = DeferredParse . mapM_ getParsed
	<$> many (foldl1 (<|>) l)
improve global options display in --help Put them in the help of subcommands, not the main command. And, hide them from the synopsis, to avoid cluttering it. 2015-07-10 06:18:08 +00:00			`{- git-annex global options`
			`-`
addon commands Seems only fair, that, like git runs git-annex, git-annex runs git-annex-foo. Implementation relies on O.forwardOptions, so that any options are passed through to the addon program. Note that this includes options before the subcommand, eg: git-annex -cx=y foo Unfortunately, git-annex eats the --help/-h options. This is because it uses O.hsubparser, which injects that option into each subcommand. Seems like this should be possible to avoid somehow, to let commands display their own --help, instead of the dummy one git-annex displays. The two step searching mirrors how git works, it makes finding git-annex-foo fast when "git annex foo" is run, but will also support fuzzy matching, once findAllAddonCommands gets implemented. This commit was sponsored by Dr. Land Raider on Patreon. 2021-02-02 20:32:25 +00:00			`- Copyright 2015-2021 Joey Hess <id@joeyh.name>`
improve global options display in --help Put them in the help of subcommands, not the main command. And, hide them from the synopsis, to avoid cluttering it. 2015-07-10 06:18:08 +00:00			`-`
update licenses from GPL to AGPL This does not change the overall license of the git-annex program, which was already AGPL due to a number of sources files being AGPL already. Legally speaking, I'm adding a new license under which these files are now available; I already released their current contents under the GPL license. Now they're dual licensed GPL and AGPL. However, I intend for all my future changes to these files to only be released under the AGPL license, and I won't be tracking the dual licensing status, so I'm simply changing the license statement to say it's AGPL. (In some cases, others wrote parts of the code of a file and released it under the GPL; but in all cases I have contributed a significant portion of the code in each file and it's that code that is getting the AGPL license; the GPL license of other contributors allows combining with AGPL code.) 2019-03-13 19:48:14 +00:00			`- Licensed under the GNU AGPL version 3 or higher.`
improve global options display in --help Put them in the help of subcommands, not the main command. And, hide them from the synopsis, to avoid cluttering it. 2015-07-10 06:18:08 +00:00			`-}`

			`module CmdLine.GlobalSetter where`

			`import Types.DeferredParse`
			`import Common`
			`import Annex`

			`import Options.Applicative`

finished converting all the main options 2015-07-10 17:18:46 +00:00			`globalFlag :: Annex () -> Mod FlagFields GlobalSetter -> GlobalOption`
improve global options display in --help Put them in the help of subcommands, not the main command. And, hide them from the synopsis, to avoid cluttering it. 2015-07-10 06:18:08 +00:00			`globalFlag setter = flag' (DeferredParse setter)`

finished converting all the main options 2015-07-10 17:18:46 +00:00			`globalSetter :: (v -> Annex ()) -> Parser v -> GlobalOption`
improve global options display in --help Put them in the help of subcommands, not the main command. And, hide them from the synopsis, to avoid cluttering it. 2015-07-10 06:18:08 +00:00			`globalSetter setter parser = DeferredParse . setter <$> parser`

addon commands Seems only fair, that, like git runs git-annex, git-annex runs git-annex-foo. Implementation relies on O.forwardOptions, so that any options are passed through to the addon program. Note that this includes options before the subcommand, eg: git-annex -cx=y foo Unfortunately, git-annex eats the --help/-h options. This is because it uses O.hsubparser, which injects that option into each subcommand. Seems like this should be possible to avoid somehow, to let commands display their own --help, instead of the dummy one git-annex displays. The two step searching mirrors how git works, it makes finding git-annex-foo fast when "git annex foo" is run, but will also support fuzzy matching, once findAllAddonCommands gets implemented. This commit was sponsored by Dr. Land Raider on Patreon. 2021-02-02 20:32:25 +00:00			`parserGlobalOptions :: [GlobalOption] -> Parser GlobalSetter`
			`parserGlobalOptions [] = DeferredParse <$> pure noop`
			`parserGlobalOptions l = DeferredParse . mapM_ getParsed`
improve global options display in --help Put them in the help of subcommands, not the main command. And, hide them from the synopsis, to avoid cluttering it. 2015-07-10 06:18:08 +00:00			`<$> many (foldl1 (<\|>) l)`