diff --git a/CHANGELOG.md b/CHANGELOG.md --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,25 @@ # Changelog +## [0.0.0.2] - 2025-03-12 + +### Added + +* Completions test helpers + + +## [0.0.0.1] - 2024-08-08 + +### Added + +* `settingsParserArgsTest` +* `parserArgsTest` +* `settingsParserEnvTest` +* `parserEnvTest` +* `settingsParserConfTest` +* `parserConfTest` +* `settingsParserTest` +* `parserTest` + ## [0.0.0.0] - 2024-07-08 First version diff --git a/app/Main.hs b/app/Main.hs deleted file mode 100644 --- a/app/Main.hs +++ /dev/null @@ -1,114 +0,0 @@ -{-# LANGUAGE ApplicativeDo #-} -{-# LANGUAGE RecordWildCards #-} - -module Main where - -import Data.Text (Text) -import OptEnvConf -import Paths_opt_env_conf_test (version) - -main :: IO () -main = do - s <- - runSettingsParser - version - "Example opt-env-conf-based application" - print (s :: Instructions) - -data Instructions = Instructions !Settings !Dispatch - deriving (Show) - -instance HasParser Instructions where - settingsParser = - withLocalYamlConfig $ - Instructions - <$> settingsParser - <*> settingsParser - -data Dispatch - = DispatchCreate !String - | DispatchRead - | DispatchUpdate !String !String - | DispatchDelete - deriving (Show) - -instance HasParser Dispatch where - settingsParser = - commands - [ command "create" "Create" $ - DispatchCreate - <$> setting - [ help "The item to create", - reader str, - argument, - metavar "STR" - ], - command "read" "Read" $ pure DispatchRead, - command "update" "Update" $ - DispatchUpdate - <$> setting - [ help "The item identifier of the item to update", - reader str, - argument, - metavar "STR" - ] - <*> setting - [ help "The contents of the item to update", - reader str, - argument, - metavar "STR" - ], - command "delete" "Delete" $ pure DispatchDelete - ] - -data Settings = Settings - { settingLogLevel :: String, - settingPaymentSettings :: Maybe PaymentSettings - } - deriving (Show) - -instance HasParser Settings where - settingsParser = do - settingLogLevel <- - setting - [ help "minimal severity of log messages", - reader str, - metavar "LOG_LEVEL", - name "log-level", - value "DEBUG" - ] - settingPaymentSettings <- optional $ subSettings "payment" - pure Settings {..} - -data PaymentSettings = PaymentSettings - { paymentSetPublicKey :: String, - paymentSetSecretKey :: Text, - paymentSetCurrency :: Maybe String - } - deriving (Show) - -instance HasParser PaymentSettings where - settingsParser = do - paymentSetPublicKey <- - setting - [ help "Public key", - reader str, - name "public-key", - metavar "PUBLIC_KEY" - ] - paymentSetSecretKey <- - mapIO readSecretTextFile $ - filePathSetting - [ help "Secret key", - name "secret-key", - metavar "SECRET_KEY_FILE" - ] - paymentSetCurrency <- - optional $ - setting - [ help "Currency", - reader str, - name "currency", - metavar "CURRENCY" - ] - pure PaymentSettings {..} diff --git a/opt-env-conf-test.cabal b/opt-env-conf-test.cabal --- a/opt-env-conf-test.cabal +++ b/opt-env-conf-test.cabal @@ -1,13 +1,17 @@ cabal-version: 1.12 --- This file has been generated from package.yaml by hpack version 0.36.0. +-- This file has been generated from package.yaml by hpack version 0.36.1. -- -- see: https://github.com/sol/hpack name: opt-env-conf-test -version: 0.0.0.0 +version: 0.0.0.2 synopsis: A testing companion package for opt-env-conf -copyright: Copyright: (c) 2024 Tom Sydney Kerckhove +homepage: https://github.com/NorfairKing/opt-env-conf#readme +bug-reports: https://github.com/NorfairKing/opt-env-conf/issues +author: Tom Sydney Kerckhove +maintainer: syd@cs-syd.eu +copyright: Copyright: (c) 2024-2025 Tom Sydney Kerckhove license: OtherLicense license-file: LICENSE.md build-type: Simple @@ -16,19 +20,6 @@ test_resources/completion/bash-completion-script.bash test_resources/completion/fish-completion-script.fish test_resources/completion/zsh-completion-script.zsh - test_resources/docs/args/config-docs.txt - test_resources/docs/args/config.txt - test_resources/docs/args/docs.txt - test_resources/docs/args/env-docs.txt - test_resources/docs/args/env.txt - test_resources/docs/args/help.txt - test_resources/docs/args/man.txt - test_resources/docs/args/opt-docs.txt - test_resources/docs/args/opt-long.txt - test_resources/docs/args/opt-short.txt - test_resources/docs/args/reference.txt - test_resources/docs/args/show.txt - test_resources/docs/args/version.txt test_resources/docs/big-config/config-docs.txt test_resources/docs/big-config/config.txt test_resources/docs/big-config/docs.txt @@ -36,6 +27,7 @@ test_resources/docs/big-config/env.txt test_resources/docs/big-config/help.txt test_resources/docs/big-config/man.txt + test_resources/docs/big-config/nix-options.nix test_resources/docs/big-config/opt-docs.txt test_resources/docs/big-config/opt-long.txt test_resources/docs/big-config/opt-short.txt @@ -49,12 +41,27 @@ test_resources/docs/empty/env.txt test_resources/docs/empty/help.txt test_resources/docs/empty/man.txt + test_resources/docs/empty/nix-options.nix test_resources/docs/empty/opt-docs.txt test_resources/docs/empty/opt-long.txt test_resources/docs/empty/opt-short.txt test_resources/docs/empty/reference.txt test_resources/docs/empty/show.txt test_resources/docs/empty/version.txt + test_resources/docs/enable-disable-optional/config-docs.txt + test_resources/docs/enable-disable-optional/config.txt + test_resources/docs/enable-disable-optional/docs.txt + test_resources/docs/enable-disable-optional/env-docs.txt + test_resources/docs/enable-disable-optional/env.txt + test_resources/docs/enable-disable-optional/help.txt + test_resources/docs/enable-disable-optional/man.txt + test_resources/docs/enable-disable-optional/nix-options.nix + test_resources/docs/enable-disable-optional/opt-docs.txt + test_resources/docs/enable-disable-optional/opt-long.txt + test_resources/docs/enable-disable-optional/opt-short.txt + test_resources/docs/enable-disable-optional/reference.txt + test_resources/docs/enable-disable-optional/show.txt + test_resources/docs/enable-disable-optional/version.txt test_resources/docs/enable-disable/config-docs.txt test_resources/docs/enable-disable/config.txt test_resources/docs/enable-disable/docs.txt @@ -62,6 +69,7 @@ test_resources/docs/enable-disable/env.txt test_resources/docs/enable-disable/help.txt test_resources/docs/enable-disable/man.txt + test_resources/docs/enable-disable/nix-options.nix test_resources/docs/enable-disable/opt-docs.txt test_resources/docs/enable-disable/opt-long.txt test_resources/docs/enable-disable/opt-short.txt @@ -75,6 +83,7 @@ test_resources/docs/greet/env.txt test_resources/docs/greet/help.txt test_resources/docs/greet/man.txt + test_resources/docs/greet/nix-options.nix test_resources/docs/greet/opt-docs.txt test_resources/docs/greet/opt-long.txt test_resources/docs/greet/opt-short.txt @@ -88,12 +97,27 @@ test_resources/docs/hidden/env.txt test_resources/docs/hidden/help.txt test_resources/docs/hidden/man.txt + test_resources/docs/hidden/nix-options.nix test_resources/docs/hidden/opt-docs.txt test_resources/docs/hidden/opt-long.txt test_resources/docs/hidden/opt-short.txt test_resources/docs/hidden/reference.txt test_resources/docs/hidden/show.txt test_resources/docs/hidden/version.txt + test_resources/docs/many-args/config-docs.txt + test_resources/docs/many-args/config.txt + test_resources/docs/many-args/docs.txt + test_resources/docs/many-args/env-docs.txt + test_resources/docs/many-args/env.txt + test_resources/docs/many-args/help.txt + test_resources/docs/many-args/man.txt + test_resources/docs/many-args/nix-options.nix + test_resources/docs/many-args/opt-docs.txt + test_resources/docs/many-args/opt-long.txt + test_resources/docs/many-args/opt-short.txt + test_resources/docs/many-args/reference.txt + test_resources/docs/many-args/show.txt + test_resources/docs/many-args/version.txt test_resources/docs/optional/config-docs.txt test_resources/docs/optional/config.txt test_resources/docs/optional/docs.txt @@ -101,12 +125,55 @@ test_resources/docs/optional/env.txt test_resources/docs/optional/help.txt test_resources/docs/optional/man.txt + test_resources/docs/optional/nix-options.nix test_resources/docs/optional/opt-docs.txt test_resources/docs/optional/opt-long.txt test_resources/docs/optional/opt-short.txt test_resources/docs/optional/reference.txt test_resources/docs/optional/show.txt test_resources/docs/optional/version.txt + test_resources/docs/same-help/config-docs.txt + test_resources/docs/same-help/config.txt + test_resources/docs/same-help/docs.txt + test_resources/docs/same-help/env-docs.txt + test_resources/docs/same-help/env.txt + test_resources/docs/same-help/help.txt + test_resources/docs/same-help/man.txt + test_resources/docs/same-help/nix-options.nix + test_resources/docs/same-help/opt-docs.txt + test_resources/docs/same-help/opt-long.txt + test_resources/docs/same-help/opt-short.txt + test_resources/docs/same-help/reference.txt + test_resources/docs/same-help/show.txt + test_resources/docs/same-help/version.txt + test_resources/docs/secret/config-docs.txt + test_resources/docs/secret/config.txt + test_resources/docs/secret/docs.txt + test_resources/docs/secret/env-docs.txt + test_resources/docs/secret/env.txt + test_resources/docs/secret/help.txt + test_resources/docs/secret/man.txt + test_resources/docs/secret/nix-options.nix + test_resources/docs/secret/opt-docs.txt + test_resources/docs/secret/opt-long.txt + test_resources/docs/secret/opt-short.txt + test_resources/docs/secret/reference.txt + test_resources/docs/secret/show.txt + test_resources/docs/secret/version.txt + test_resources/docs/some-args/config-docs.txt + test_resources/docs/some-args/config.txt + test_resources/docs/some-args/docs.txt + test_resources/docs/some-args/env-docs.txt + test_resources/docs/some-args/env.txt + test_resources/docs/some-args/help.txt + test_resources/docs/some-args/man.txt + test_resources/docs/some-args/nix-options.nix + test_resources/docs/some-args/opt-docs.txt + test_resources/docs/some-args/opt-long.txt + test_resources/docs/some-args/opt-short.txt + test_resources/docs/some-args/reference.txt + test_resources/docs/some-args/show.txt + test_resources/docs/some-args/version.txt test_resources/docs/sub-commands/config-docs.txt test_resources/docs/sub-commands/config.txt test_resources/docs/sub-commands/docs.txt @@ -114,12 +181,41 @@ test_resources/docs/sub-commands/env.txt test_resources/docs/sub-commands/help.txt test_resources/docs/sub-commands/man.txt + test_resources/docs/sub-commands/nix-options.nix test_resources/docs/sub-commands/opt-docs.txt test_resources/docs/sub-commands/opt-long.txt test_resources/docs/sub-commands/opt-short.txt test_resources/docs/sub-commands/reference.txt test_resources/docs/sub-commands/show.txt test_resources/docs/sub-commands/version.txt + test_resources/docs/sub-settings/config-docs.txt + test_resources/docs/sub-settings/config.txt + test_resources/docs/sub-settings/docs.txt + test_resources/docs/sub-settings/env-docs.txt + test_resources/docs/sub-settings/env.txt + test_resources/docs/sub-settings/help.txt + test_resources/docs/sub-settings/man.txt + test_resources/docs/sub-settings/nix-options.nix + test_resources/docs/sub-settings/opt-docs.txt + test_resources/docs/sub-settings/opt-long.txt + test_resources/docs/sub-settings/opt-short.txt + test_resources/docs/sub-settings/reference.txt + test_resources/docs/sub-settings/show.txt + test_resources/docs/sub-settings/version.txt + test_resources/docs/sum-type/config-docs.txt + test_resources/docs/sum-type/config.txt + test_resources/docs/sum-type/docs.txt + test_resources/docs/sum-type/env-docs.txt + test_resources/docs/sum-type/env.txt + test_resources/docs/sum-type/help.txt + test_resources/docs/sum-type/man.txt + test_resources/docs/sum-type/nix-options.nix + test_resources/docs/sum-type/opt-docs.txt + test_resources/docs/sum-type/opt-long.txt + test_resources/docs/sum-type/opt-short.txt + test_resources/docs/sum-type/reference.txt + test_resources/docs/sum-type/show.txt + test_resources/docs/sum-type/version.txt test_resources/docs/three-commands/config-docs.txt test_resources/docs/three-commands/config.txt test_resources/docs/three-commands/docs.txt @@ -127,6 +223,7 @@ test_resources/docs/three-commands/env.txt test_resources/docs/three-commands/help.txt test_resources/docs/three-commands/man.txt + test_resources/docs/three-commands/nix-options.nix test_resources/docs/three-commands/opt-docs.txt test_resources/docs/three-commands/opt-long.txt test_resources/docs/three-commands/opt-short.txt @@ -140,12 +237,41 @@ test_resources/docs/verbose/env.txt test_resources/docs/verbose/help.txt test_resources/docs/verbose/man.txt + test_resources/docs/verbose/nix-options.nix test_resources/docs/verbose/opt-docs.txt test_resources/docs/verbose/opt-long.txt test_resources/docs/verbose/opt-short.txt test_resources/docs/verbose/reference.txt test_resources/docs/verbose/show.txt test_resources/docs/verbose/version.txt + test_resources/docs/with-default/config-docs.txt + test_resources/docs/with-default/config.txt + test_resources/docs/with-default/docs.txt + test_resources/docs/with-default/env-docs.txt + test_resources/docs/with-default/env.txt + test_resources/docs/with-default/help.txt + test_resources/docs/with-default/man.txt + test_resources/docs/with-default/nix-options.nix + test_resources/docs/with-default/opt-docs.txt + test_resources/docs/with-default/opt-long.txt + test_resources/docs/with-default/opt-short.txt + test_resources/docs/with-default/reference.txt + test_resources/docs/with-default/show.txt + test_resources/docs/with-default/version.txt + test_resources/docs/yes-no-optional/config-docs.txt + test_resources/docs/yes-no-optional/config.txt + test_resources/docs/yes-no-optional/docs.txt + test_resources/docs/yes-no-optional/env-docs.txt + test_resources/docs/yes-no-optional/env.txt + test_resources/docs/yes-no-optional/help.txt + test_resources/docs/yes-no-optional/man.txt + test_resources/docs/yes-no-optional/nix-options.nix + test_resources/docs/yes-no-optional/opt-docs.txt + test_resources/docs/yes-no-optional/opt-long.txt + test_resources/docs/yes-no-optional/opt-short.txt + test_resources/docs/yes-no-optional/reference.txt + test_resources/docs/yes-no-optional/show.txt + test_resources/docs/yes-no-optional/version.txt test_resources/docs/yes-no/config-docs.txt test_resources/docs/yes-no/config.txt test_resources/docs/yes-no/docs.txt @@ -153,6 +279,7 @@ test_resources/docs/yes-no/env.txt test_resources/docs/yes-no/help.txt test_resources/docs/yes-no/man.txt + test_resources/docs/yes-no/nix-options.nix test_resources/docs/yes-no/opt-docs.txt test_resources/docs/yes-no/opt-long.txt test_resources/docs/yes-no/opt-short.txt @@ -165,6 +292,9 @@ test_resources/error/check-failed-checkMaybe.txt test_resources/error/empty-choice.txt test_resources/error/empty.txt + test_resources/error/leftover-argument.txt + test_resources/error/leftover-option.txt + test_resources/error/leftover-switch.txt test_resources/error/missing-argument.txt test_resources/error/missing-env.txt test_resources/error/missing-option.txt @@ -176,28 +306,51 @@ test_resources/error/read-int-options.txt test_resources/error/required-command.txt test_resources/error/some-none.txt + test_resources/error/typo-option.txt + test_resources/error/typo-switch.txt test_resources/error/unfolding-tombstone-option.txt test_resources/error/unfolding-tombstone-switch.txt test_resources/error/unreadable-var.txt test_resources/error/unreadable-vars.txt + test_resources/error/unrecognised-arg.txt test_resources/error/unrecognised-command.txt + test_resources/error/unrecognised-option.txt + test_resources/error/unrecognised-switch.txt + test_resources/help/create.txt + test_resources/help/read.txt + test_resources/help/sub-bar.txt + test_resources/help/sub-foo.txt + test_resources/help/sub.txt + test_resources/help/toplevel-pure-with-invalid-port.txt + test_resources/help/toplevel-pure.txt + test_resources/help/wrong-command.txt test_resources/lint/config-without-load.txt test_resources/lint/dash-in-long.txt test_resources/lint/dash-in-short.txt test_resources/lint/empty-setting.txt + test_resources/lint/many-conf.txt + test_resources/lint/many-env.txt test_resources/lint/no-commands.txt test_resources/lint/no-dashed-for-option.txt test_resources/lint/no-dashed-for-switch.txt test_resources/lint/no-metavar-for-argument.txt test_resources/lint/no-metavar-for-env.txt test_resources/lint/no-metavar-for-option.txt + test_resources/lint/no-option-or-switch-for-dashed.txt test_resources/lint/no-reader-for-argument.txt test_resources/lint/no-reader-for-env.txt test_resources/lint/no-reader-for-option.txt test_resources/lint/null-setting.txt test_resources/lint/only-default.txt + test_resources/lint/some-conf.txt + test_resources/lint/some-env.txt + test_resources/lint/unknown-default-command.txt test_resources/lint/unreadable-example.txt +source-repository head + type: git + location: https://github.com/NorfairKing/opt-env-conf + library exposed-modules: OptEnvConf.Args.Gen @@ -209,40 +362,33 @@ src/ ghc-options: -Wall build-depends: - base <5 + aeson + , base <5 , genvalidity , genvalidity-containers - , opt-env-conf + , opt-env-conf >=0.9.0.0 , safe-coloured-text , sydtest , text default-language: Haskell2010 -executable opt-env-conf-example - main-is: Main.hs - other-modules: - Paths_opt_env_conf_test - hs-source-dirs: - app - build-depends: - base <5 - , opt-env-conf - , text - default-language: Haskell2010 - test-suite opt-env-conf-test type: exitcode-stdio-1.0 main-is: Spec.hs other-modules: OptEnvConf.APISpec OptEnvConf.ArgsSpec + OptEnvConf.CompleterSpec OptEnvConf.CompletionSpec OptEnvConf.EnvMapSpec OptEnvConf.ErrorSpec + OptEnvConf.HelpSpec OptEnvConf.LintSpec OptEnvConf.NonDetSpec OptEnvConf.ReaderSpec OptEnvConf.RunSpec + OptEnvConf.TestUtils + OptEnvConf.ToplevelSpec Paths_opt_env_conf_test hs-source-dirs: test/ @@ -252,6 +398,7 @@ build-depends: QuickCheck , aeson + , autodocodec , base <5 , containers , genvalidity-aeson @@ -261,6 +408,7 @@ , opt-env-conf , opt-env-conf-test , path + , path-io , pretty-show , safe-coloured-text , sydtest diff --git a/src/OptEnvConf/Test.hs b/src/OptEnvConf/Test.hs --- a/src/OptEnvConf/Test.hs +++ b/src/OptEnvConf/Test.hs @@ -3,19 +3,50 @@ {-# LANGUAGE TypeApplications #-} module OptEnvConf.Test - ( settingsLintSpec, + ( -- * Lint test + settingsLintSpec, parserLintSpec, parserLintTest, + + -- * Parse tests + settingsParserArgsTest, + parserArgsTest, + settingsParserEnvTest, + parserEnvTest, + settingsParserConfTest, + parserConfTest, + settingsParserTest, + parserTest, + + -- * Completion tests + settingsParserCompletionTest, + settingsParserCompletionDescriptionTest, + parserCompletionTest, + parserCompletionDescriptionTest, + + -- * Reference documentation goldenSettingsReferenceDocumentationSpec, goldenParserReferenceDocumentationSpec, pureGoldenReferenceDocumentation, + + -- * Nix options + goldenSettingsNixOptionsSpec, + goldenParserNixOptionsSpec, + pureGoldenNixOptions, + module OptEnvConf, ) where +import Data.Aeson as JSON +import Data.Maybe import Data.Text (Text) import qualified Data.Text as T import GHC.Stack (HasCallStack, withFrozenCallStack) import OptEnvConf +import OptEnvConf.Args +import OptEnvConf.Completion +import OptEnvConf.EnvMap as EnvMap +import OptEnvConf.Error import OptEnvConf.Lint import Test.Syd import Text.Colour @@ -36,6 +67,52 @@ Just errs -> expectationFailure $ T.unpack $ renderChunksText With24BitColours $ renderLintErrors errs +settingsParserArgsTest :: (Show a, Eq a, HasParser a) => [String] -> a -> IO () +settingsParserArgsTest = parserArgsTest settingsParser + +parserArgsTest :: (Show a, Eq a) => Parser a -> [String] -> a -> IO () +parserArgsTest parser args = parserTest parser args [] Nothing + +settingsParserEnvTest :: (Show a, Eq a, HasParser a) => [(String, String)] -> a -> IO () +settingsParserEnvTest = parserEnvTest settingsParser + +parserEnvTest :: (Show a, Eq a) => Parser a -> [(String, String)] -> a -> IO () +parserEnvTest parser envVars = parserTest parser [] envVars Nothing + +settingsParserConfTest :: (Show a, Eq a, HasParser a) => JSON.Object -> a -> IO () +settingsParserConfTest = parserConfTest settingsParser + +parserConfTest :: (Show a, Eq a) => Parser a -> JSON.Object -> a -> IO () +parserConfTest parser obj = parserTest parser [] [] (Just obj) + +settingsParserTest :: (Show a, Eq a, HasParser a) => [String] -> [(String, String)] -> Maybe JSON.Object -> a -> IO () +settingsParserTest = parserTest settingsParser + +parserTest :: (Show a, Eq a) => Parser a -> [String] -> [(String, String)] -> Maybe JSON.Object -> a -> IO () +parserTest parser args envVars mObject expected = do + errOrActual <- runParserOn Nothing parser (parseArgs args) (EnvMap.parse envVars) mObject + case errOrActual of + Left errs -> expectationFailure $ T.unpack $ renderChunksText With24BitColours $ renderErrors errs + Right actual -> actual `shouldBe` expected + +settingsParserCompletionTest :: forall a. (HasParser a) => Int -> [String] -> [Completion String] -> IO () +settingsParserCompletionTest = parserCompletionTest (settingsParser @a) + +settingsParserCompletionDescriptionTest :: forall a. (HasParser a) => Int -> [String] -> [String] -> IO () +settingsParserCompletionDescriptionTest = parserCompletionDescriptionTest (settingsParser @a) + +parserCompletionTest :: Parser a -> Int -> [String] -> [Completion String] -> IO () +parserCompletionTest p ix ws expected = do + let arg = fromMaybe "" $ listToMaybe $ drop ix ws + let completions = pureCompletionQuery p ix ws + evaluatedCompletions <- evalCompletions arg completions + evaluatedCompletions `shouldBe` expected + +parserCompletionDescriptionTest :: Parser a -> Int -> [String] -> [String] -> IO () +parserCompletionDescriptionTest p ix ws descriptions = do + let completions = pureCompletionQuery p ix ws + map completionDescription completions `shouldBe` map Just descriptions + goldenSettingsReferenceDocumentationSpec :: forall a. (HasCallStack) => (HasParser a) => FilePath -> String -> Spec goldenSettingsReferenceDocumentationSpec path progname = withFrozenCallStack $ goldenParserReferenceDocumentationSpec (settingsParser @a) path progname @@ -50,3 +127,16 @@ renderChunksText With24BitColours $ renderReferenceDocumentation progname $ parserDocs parser + +goldenSettingsNixOptionsSpec :: forall a. (HasCallStack) => (HasParser a) => FilePath -> Spec +goldenSettingsNixOptionsSpec path = withFrozenCallStack $ goldenParserNixOptionsSpec (settingsParser @a) path + +goldenParserNixOptionsSpec :: (HasCallStack) => Parser a -> FilePath -> Spec +goldenParserNixOptionsSpec parser path = withFrozenCallStack $ do + specify "produces the nix options as before" $ + pureGoldenNixOptions path parser + +pureGoldenNixOptions :: FilePath -> Parser a -> GoldenTest Text +pureGoldenNixOptions path parser = + pureGoldenTextFile path $ + renderParserNixOptions parser diff --git a/test/OptEnvConf/APISpec.hs b/test/OptEnvConf/APISpec.hs --- a/test/OptEnvConf/APISpec.hs +++ b/test/OptEnvConf/APISpec.hs @@ -1,13 +1,17 @@ +{-# LANGUAGE LambdaCase #-} +{-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE ScopedTypeVariables #-} module OptEnvConf.APISpec (spec) where +import Autodocodec import Data.Map (Map) import Data.Text (Text) import Data.Version import GHC.Stack (HasCallStack, withFrozenCallStack) import OptEnvConf import OptEnvConf.Test +import OptEnvConf.TestUtils import Test.Syd import Text.Colour import Text.Show.Pretty as Pretty @@ -15,13 +19,21 @@ spec :: Spec spec = do exampleParserSpec "empty" "empty parser" emptyParser - exampleParserSpec "args" "args parser" argsParser + exampleParserSpec "many-args" "many args parser" manyArgsParser + exampleParserSpec "some-args" "some args parser" someArgsParser exampleParserSpec "optional" "optional argument" optionalParser exampleParserSpec "big-config" "example with a big configuration" bigConfigParser + exampleParserSpec "sub-settings" "example with a sub settings" subSettingsParser exampleParserSpec "hidden" "example with hidden settings" hiddenParser exampleParserSpec "enable-disable" "enableDisableSwitch example" enableDisableParser exampleParserSpec "yes-no" "yesNoSwitch example" yesNoParser + exampleParserSpec "enable-disable-optional" "enableDisableSwitch' example" enableDisableParser' + exampleParserSpec "yes-no-optional" "yesNoSwitch' example" yesNoParser' exampleParserSpec "verbose" "verbosity example" verboseParser + exampleParserSpec "same-help" "example where multiple options use the same help string" sameHelpParser + exampleParserSpec "sum-type" "Sum type example" sumTypeParser + exampleParserSpec "secret" "Secrets example" secretParser + exampleParserSpec "with-default" "withDefault example" withDefaultParser exampleParserSpec "greet" "hello world example" greetParser exampleParserSpec "three-commands" "example with three commands" threeCommandsParser exampleParserSpec "sub-commands" "example with subcommands" subCommandsParser @@ -29,10 +41,9 @@ exampleParserSpec :: (HasCallStack) => FilePath -> String -> Parser a -> Spec exampleParserSpec dir progDesc p = withFrozenCallStack $ describe dir $ do let version = makeVersion [0, 0, 0] - let parser = internalParser version p it "passes the linter" $ - parserLintTest parser + parserLintTest p it "shows the parser in the same way" $ goldenStringFile ("test_resources/docs/" <> dir <> "/show.txt") $ @@ -66,44 +77,171 @@ it "documents the help page in the same way" $ pureGoldenChunksFile ("test_resources/docs/" <> dir <> "/help.txt") $ - renderHelpPage dir progDesc $ - parserDocs parser + renderHelpPage dir version progDesc $ + parserDocs p it "documents the short opt parser in the same way" $ pureGoldenChunksFile ("test_resources/docs/" <> dir <> "/opt-short.txt") $ renderShortOptDocs dir $ - parserOptDocs parser + parserOptDocs p it "documents the long opt parser in the same way" $ pureGoldenChunksFile ("test_resources/docs/" <> dir <> "/opt-long.txt") $ renderLongOptDocs $ - parserOptDocs parser + parserOptDocs p it "documents the env parser in the same way" $ pureGoldenChunksFile ("test_resources/docs/" <> dir <> "/env.txt") $ renderEnvDocs $ - parserEnvDocs parser + parserEnvDocs p it "documents the conf parser in the same way" $ pureGoldenChunksFile ("test_resources/docs/" <> dir <> "/config.txt") $ renderConfDocs $ - parserConfDocs parser + parserConfDocs p it "documents the man page in the same way" $ pureGoldenTextFile ("test_resources/docs/" <> dir <> "/man.txt") $ renderChunksText WithoutColours $ renderManPage dir version progDesc $ - parserDocs parser + parserDocs p it "renders the reference documentation in the same way" $ pureGoldenChunksFile ("test_resources/docs/" <> dir <> "/reference.txt") $ renderReferenceDocumentation dir $ - parserDocs parser + parserDocs p -pureGoldenChunksFile :: FilePath -> [Chunk] -> GoldenTest Text -pureGoldenChunksFile fp cs = - pureGoldenTextFile fp $ renderChunksText With24BitColours cs + it "renders the Nix options the same way" $ + pureGoldenTextFile ("test_resources/docs/" <> dir <> "/nix-options.nix") $ + renderParserNixOptions p +sameHelpParser :: Parser (Either Int String, Bool) +sameHelpParser = + withoutConfig $ + let h = help "int or string" + in (,) + <$> choice + [ Left + <$> setting + [ h, + name "int", + reader auto, + metavar "INT" + ], + Right + <$> setting + [ h, + name "string", + reader str, + metavar "STR" + ] + ] + <*> yesNoSwitch + [ h, + name "other", + value True + ] + +data SumType + = SumTypeA + | SumTypeB + deriving (Show) + +instance HasCodec SumType where + codec = bimapCodec parseSumType renderSumType codec + +parseSumType :: String -> Either String SumType +parseSumType = \case + "a" -> pure SumTypeA + "b" -> pure SumTypeB + s -> Left $ unwords ["Unknown 'SumType':", s] + +renderSumType :: SumType -> String +renderSumType = \case + SumTypeA -> "a" + SumTypeB -> "b" + +sumTypeParser :: Parser SumType +sumTypeParser = + withoutConfig $ + let h = help "example" + in choice + [ setting + [ help "a", + switch SumTypeA, + short 'a' + ], + setting + [ help "b", + switch SumTypeB, + short 'b' + ], + setting + [ h, + reader $ eitherReader parseSumType, + env "sum-type", + metavar "SUM_TYPE" + ], + setting + [ h, + conf "sum-type" + ], + setting + [ h, + valueWithShown renderSumType SumTypeA + ] + ] + +secretParser :: Parser (Text, Text, Text, Text, Text) +secretParser = + withoutConfig $ + (,,,,) + <$> secretTextFileSetting + [ help "First example secret", + name "first-secret-file" + ] + <*> secretTextFileOrBareSetting + [ help "Second example secret, bare or in a file", + name "second-secret" + ] + <*> secretTextFileOrBareSetting + [ help "Second example secret, bare or in a file, only option", + option, + long "second-secret" + ] + <*> secretTextFileOrBareSetting + [ help "Second example secret, bare or in a file, only env", + env "second-secret" + ] + <*> secretTextFileOrBareSetting + [ help "Second example secret, bare or in a file, only conf", + conf "second-secret" + ] + +data FirstOrSecond = First | Second + deriving (Show) + +instance HasParser FirstOrSecond where + settingsParser = + -- This version has no default value, so we can add one with 'withDefault' + choice + [ setting + [ help "first", + switch First, + short 'f', + long "first" + ], + setting + [ help "second", + switch Second, + short 's', + long "second" + ] + ] + +withDefaultParser :: Parser FirstOrSecond +withDefaultParser = withDefault Second settingsParser + data Greet = Greet !String !String !Bool greetParser :: Parser Greet @@ -120,6 +258,7 @@ env "GREETING", conf "greeting", value "Hello", + example "Greetings", help "Greeting to use" ] <*> setting @@ -141,31 +280,60 @@ help "Whether to be polite" ] -data BigConfig = BigConfig (Map String (Map String Int)) +data BigConfig = BigConfig + { bigConfigMap :: Map String (Map String Int), + bigConfigSubObject :: Maybe Text + } +instance HasCodec BigConfig where + codec = + object "BigConfig" $ + BigConfig + <$> requiredField' "map" .= bigConfigMap + <*> optionalField' "sub" .= bigConfigSubObject + bigConfigParser :: Parser BigConfig bigConfigParser = withLocalYamlConfig $ - BigConfig - <$> setting - [ conf "big", - help "multi-line config codec explanation, the same option twice." - ] - -data Args = Args [String] + setting + [ conf "big", + help "big configuration object" + ] -argsParser :: Parser Args -argsParser = - Args - <$> many - ( setting +subSettingsParser :: Parser String +subSettingsParser = + withLocalYamlConfig $ + subAll "foo" $ + subAll "bar" $ + setting [ reader str, - argument, - help "Argument", - metavar "ARGUMENT" + name "quux", + help "Example with sub-settings", + metavar "STR" ] - ) +manyArgsParser :: Parser [String] +manyArgsParser = + many + ( setting + [ reader str, + argument, + help "Argument", + metavar "ARGUMENT" + ] + ) + +someArgsParser :: Parser [String] +someArgsParser = + some + ( setting + [ reader str, + argument, + help "Argument", + metavar "ARGUMENT" + ] + ) + data Optional = Optional (Maybe String) optionalParser :: Parser Optional @@ -198,30 +366,56 @@ enableDisableParser :: Parser EnableDisable enableDisableParser = - withLocalYamlConfig $ + withoutConfig $ EnableDisable <$> enableDisableSwitch - True [ long "example", help "Example of an enable/disable switch", env "EXAMPLE", - conf "example" + conf "example", + value True ] +enableDisableParser' :: Parser (Maybe EnableDisable) +enableDisableParser' = + withoutConfig $ + fmap EnableDisable + <$> optional + ( enableDisableSwitch + [ long "example", + help "Example of an enable/disable switch", + env "EXAMPLE", + conf "example" + ] + ) + data YesNo = YesNo Bool yesNoParser :: Parser YesNo yesNoParser = - withLocalYamlConfig $ + withoutConfig $ YesNo <$> yesNoSwitch - True [ long "example", help "Example of a yes/no switch", env "EXAMPLE", - conf "example" + conf "example", + value True ] +yesNoParser' :: Parser (Maybe YesNo) +yesNoParser' = + withoutConfig $ + fmap YesNo + <$> optional + ( yesNoSwitch + [ long "example", + help "Example of a yes/no switch", + env "EXAMPLE", + conf "example" + ] + ) + data Empty = Empty emptyParser :: Parser Empty @@ -235,7 +429,7 @@ threeCommandsParser :: Parser ThreeCommands threeCommandsParser = - withLocalYamlConfig $ + withoutConfig $ commands [ command "one" "first" $ One @@ -253,14 +447,16 @@ option, metavar "INT", name "number", - short 'n' + short 'n', + shownExample 5 ] <*> enableDisableSwitch - False [ help "enable extra", - name "enable" + name "enable", + value False ], - command "three" "third" (pure Three) + command "three-very-long-command-name" "third" (pure Three), + defaultCommand "one" ] data SubCommands @@ -277,9 +473,11 @@ [ help "name", reader str, metavar "NAME", - name "name" + name "name", + example "john" ], - command "sub" "command with subcommands" $ Sub <$> sub1Parser <*> sub2Parser + command "sub" "command with subcommands" $ + Sub <$> sub1Parser <*> sub2Parser ] data Sub1 = A | B @@ -297,7 +495,8 @@ sub2Parser = commands [ command "c" "C" $ pure C, - command "d" "D" $ pure D + command "d" "D" $ pure D, + defaultCommand "c" ] verboseParser :: Parser Int diff --git a/test/OptEnvConf/ArgsSpec.hs b/test/OptEnvConf/ArgsSpec.hs --- a/test/OptEnvConf/ArgsSpec.hs +++ b/test/OptEnvConf/ArgsSpec.hs @@ -43,12 +43,87 @@ describe "consumeArgument" $ do it "does not consume anything if there is nothing to consume" $ - consumeArgument [] `shouldBe` [] - it "consumes any argument if there is only one" $ - forAllValid $ \a -> - consumeArgument [Live a] - `shouldBe` [(renderArg a, [])] + consumeArgument [] `shouldBe` [(Nothing, emptyArgs)] + it "consumes a plain argument when there is one" $ + forAllValid $ \s -> + let as = [Live (ArgPlain s)] + in consumeArgument as + `shouldBe` [(Just s, Args [Dead] []), (Nothing, as)] + it "consumes a bare double-dash if it's the last argument" $ + forAllValid $ \befores -> + let as = Args befores [Live ArgBareDoubleDash] + in consumeArgument as + `shouldBe` [ (Just "--", Args (befores ++ [Dead]) []), + (Nothing, as) + ] + it "consumes any argument after a double-dash as an argument" $ + forAllValid $ \befores -> + forAllValid $ \bareArg -> + forAllValid $ \rest -> + let as = Args befores (Live ArgBareDoubleDash : Live bareArg : rest) + in consumeArgument as + `shouldBe` [ (Just (renderArg bareArg), Args befores (Live ArgBareDoubleDash : Dead : rest)), + (Nothing, as) + ] + it "skips dead arguments" $ + forAllValid $ \befores -> + forAllValid $ \afters -> + consumeArgument (Args befores (Dead : afters)) `shouldBe` consumeArgument (Args (befores ++ [Dead]) afters) + it "tries to consume dashed argument followed by a dead argument" $ + forAllValid $ \befores -> + forAllValid $ \isLong -> + forAllValid $ \cs -> + let d = ArgDashed isLong cs + args = Args befores [Live d, Dead] + in consumeArgument args + `shouldBe` [ (Nothing, Args (befores ++ [Live d, Dead]) []), + (Just (renderArg d), Args (befores ++ [Dead]) [Dead]) + ] + + it "tries to consume dashed argument followed by a live argument" $ + forAllValid $ \befores -> + forAllValid $ \isLong -> + forAllValid $ \cs -> + forAll (genValid `suchThat` (/= ArgBareDoubleDash)) $ \arg -> + let d = ArgDashed isLong cs + args = Args befores [Live d, Live arg] + in context (ppShow args) $ + consumeArgument args + `shouldBe` [ (Nothing, Args (befores ++ [Live d, Live arg]) []), + -- Consuming the value (dashed is a switch) is + -- more likely than consuming the dashed as an + -- argument + (Just (renderArg arg), Args (befores ++ [Live d, Dead]) []), + (Just (renderArg d), Args (befores ++ [Dead]) [Live arg]) + ] + it "tries to ignore this value that looks like an option value" $ + consumeArgument ["-p1", "--port", "2"] + `shouldBe` [ (Nothing, Args ["-p1", "--port", "2"] []), + (Just "2", Args ["-p1", "--port", Dead] []), + (Just "--port", Args ["-p1", Dead] ["2"]), + (Just "-p1", Args [Dead] ["--port", "2"]) + ] + + describe "consumeSwitch" $ do + it "fails to consume if there are no dasheds" $ + forAllValid $ \as -> + consumeSwitch [] as `shouldBe` Nothing + it "fails to consume if there are no arguments" $ + forAllValid $ \ds -> + consumeSwitch ds [] `shouldBe` Nothing + + it "does not consume a mismatched switch" $ + consumeSwitch ["--foo"] ["--bar"] `shouldBe` Nothing + it "consumes a short switch if there are no other args" $ + consumeSwitch ["-v"] ["-v"] `shouldBe` Just [Dead] + it "consumes a long switch if there are no other args" $ + consumeSwitch ["--verbose"] ["--verbose"] `shouldBe` Just [Dead] + it "consumes a switch at the front first" $ + consumeSwitch ["-a", "-b"] ["-a", "-b"] `shouldBe` Just [Dead, "-b"] + it "consumes a folded switch at the front first" $ + consumeSwitch ["-a", "-b"] ["-ab"] `shouldBe` Just ["-b"] + describe "consumeOption" $ do it "fails to consume if there are no dasheds" $ forAllValid $ \as -> @@ -70,22 +145,13 @@ consumeOption ["--file"] ["--file=foo.txt"] `shouldBe` Just ("foo.txt", [Dead]) it "consumes a short option in shorthand notation" $ consumeOption ["-f"] ["-ffoo.txt"] `shouldBe` Just ("foo.txt", [Dead]) - - describe "consumeSwitch" $ do - it "fails to consume if there are no dasheds" $ - forAllValid $ \as -> - consumeSwitch [] as `shouldBe` Nothing - it "fails to consume if there are no arguments" $ - forAllValid $ \ds -> - consumeSwitch ds [] `shouldBe` Nothing - - it "does not consume a mismatched switch" $ - consumeSwitch ["--foo"] ["--bar"] `shouldBe` Nothing - it "consumes a short switch if there are no other args" $ - consumeSwitch ["-v"] ["-v"] `shouldBe` Just [Dead] - it "consumes a long switch if there are no other args" $ - consumeSwitch ["--verbose"] ["--verbose"] `shouldBe` Just [Dead] - it "consumes a switch at the front first" $ - consumeSwitch ["-a", "-b"] ["-a", "-b"] `shouldBe` Just [Dead, "-b"] - it "consumes a folded switch at the front first" $ - consumeSwitch ["-a", "-b"] ["-ab"] `shouldBe` Just ["-b"] + it "consumes a short option before a long option" $ + consumeOption + ["-p", "--port"] + ["-p1", "--port", "2"] + `shouldBe` Just ("1", [Dead, "--port", "2"]) + it "consumes a short option before a long option" $ + consumeOption + ["-p", "--port"] + [Dead, "--port", "2"] + `shouldBe` Just ("2", [Dead, Dead]) diff --git a/test/OptEnvConf/CompleterSpec.hs b/test/OptEnvConf/CompleterSpec.hs new file mode 100644 --- /dev/null +++ b/test/OptEnvConf/CompleterSpec.hs @@ -0,0 +1,79 @@ +{-# LANGUAGE DataKinds #-} +{-# LANGUAGE OverloadedStrings #-} + +module OptEnvConf.CompleterSpec (spec) where + +import GHC.Stack (HasCallStack, withFrozenCallStack) +import OptEnvConf.Completer +import Path +import Path.IO +import Test.Syd + +spec :: Spec +spec = do + let setupExampleDir tdir = do + -- File + exampleFile1 <- resolveFile tdir "foo.txt" + writeFile (fromAbsFile exampleFile1) "" + -- Dir here + exampleDir <- resolveDir tdir "bar" + createDir exampleDir + -- File in dir + exampleFile2 <- resolveFile exampleDir "quux.txt" + writeFile (fromAbsFile exampleFile2) "" + -- Dir in dir + deeperDir <- resolveDir exampleDir "deep" + createDir deeperDir + -- File in dir in dir + exampleFile3 <- resolveFile deeperDir "gold.txt" + writeFile (fromAbsFile exampleFile3) "" + -- Hidden file + hiddenFile <- resolveFile tdir ".hidden.txt" + writeFile (fromAbsFile hiddenFile) "" + -- Hidden dir + hiddenDir <- resolveDir tdir ".hidden" + createDir hiddenDir + + -- These are read-only tests so we only need one dir for all of them + sequential . doNotRandomiseExecutionOrder + $ aroundAll + ( \func -> withSystemTempDir "opt-env-conf-test" $ \tdir -> do + setupExampleDir tdir + func tdir + ) + $ do + describe "filePath" $ do + let c :: (HasCallStack) => String -> [String] -> TestDef '[Path Abs Dir] () + c s l = + withFrozenCallStack $ + itWithOuter (unwords ["can complete", show s, "to", show l]) $ \tdir -> + withCurrentDir tdir $ + unCompleter filePath s `shouldReturn` l + + c "" ["foo.txt", "bar/"] + c "f" ["foo.txt"] + c "b" ["bar/"] + c "bar" ["bar/quux.txt", "bar/", "bar/deep/"] + c "q" [] + c "." [".hidden.txt", ".hidden/"] + c "./" ["./foo.txt", "./bar/"] + c "././" ["././foo.txt", "././bar/"] + c "./." ["./.hidden.txt", "./.hidden/"] + c "./bar" ["./bar/quux.txt", "./bar/", "./bar/deep/"] + + describe "directoryPath" $ do + let c :: (HasCallStack) => String -> [String] -> TestDef '[Path Abs Dir] () + c s l = withFrozenCallStack $ + itWithOuter (unwords ["can complete", show s, "to", show l]) $ \tdir -> + withCurrentDir tdir $ + unCompleter directoryPath s `shouldReturn` l + + c "" ["bar/"] + c "b" ["bar/"] + c "f" [] + c "." [".hidden/"] + c "./" ["./bar/"] + c "./." ["./.hidden/"] + c "././" ["././bar/"] + c "./." ["./.hidden/"] + c "./bar" ["./bar/", "./bar/deep/"] diff --git a/test/OptEnvConf/CompletionSpec.hs b/test/OptEnvConf/CompletionSpec.hs --- a/test/OptEnvConf/CompletionSpec.hs +++ b/test/OptEnvConf/CompletionSpec.hs @@ -1,10 +1,14 @@ +{-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE QuasiQuotes #-} module OptEnvConf.CompletionSpec (spec) where +import Control.Applicative +import OptEnvConf.Completer import OptEnvConf.Completion import OptEnvConf.Parser import OptEnvConf.Setting +import OptEnvConf.Test import Path import Test.Syd @@ -24,14 +28,212 @@ fishCompletionScript [absfile|/usr/bin/example-executable|] "example-executable" describe "pureCompletionQuery" $ do + it "can complete a switch from nothing" $ + parserCompletionTest + (setting [switch (), short 'e', long "example"]) + 0 + [] + ["--example"] -- Only the long version it "can complete a short switch from a single dash" $ - pureCompletionQuery (setting [short 'e']) 1 ["-"] - `shouldBe` [Completion "-e" Nothing] + parserCompletionTest + (setting [switch (), short 'e']) + 0 + ["-"] + ["-e"] + it "can complete a long switch from a single dash" $ - pureCompletionQuery (setting [long "example"]) 1 ["-"] - `shouldBe` [Completion "--example" Nothing] + parserCompletionTest + (setting [switch (), long "example"]) + 0 + ["-"] + ["--example"] + it "can complete a long switch from a double dash" $ - pureCompletionQuery (setting [long "example"]) 1 ["--"] - `shouldBe` [Completion "--example" Nothing] + parserCompletionTest + (setting [switch (), long "example"]) + 0 + ["--"] + ["--example"] - pending "can complete a long switch with an equals sign" + it "can complete a short option's dashed" $ + parserCompletionTest + (setting [option, short 'e', completer $ listCompleter ["hi"]]) + 0 + [] + ["-e"] + + it "can complete a long option's dashed" $ + parserCompletionTest + (setting [option, long "example", completer $ listCompleter ["hi"]]) + 0 + [] + ["--example"] + + it "can complete a short option with a separate arg" $ + parserCompletionTest + (setting [option, short 'e', completer $ listCompleter ["hi"]]) + 1 + ["-e"] + ["hi"] + + -- Don't think we want to support this. + -- pending "can complete a short option in short-hand mode. + + it "can complete a long option" $ + parserCompletionTest + (setting [option, long "example", completer $ listCompleter ["hi"]]) + 1 + ["--example"] + ["hi"] + + -- Don't think we want to support this + -- pending "can complete a long option with equals sign" + + it "can complete both switches of a tuple" $ + parserCompletionTest + ((,) <$> setting [switch (), long "foo"] <*> setting [switch (), long "bar"]) + 0 + [] + ["--foo", "--bar"] + + it "can complete both switches of a tuple, with a prefix" $ + parserCompletionTest + ((,) <$> setting [switch (), long "bar"] <*> setting [switch (), long "baz"]) + 0 + ["--b"] + ["--bar", "--baz"] + + it "can complete both switches of an either" $ + parserCompletionTest + (setting [switch (), long "foo"] <|> setting [switch (), long "bar"]) + 0 + [] + ["--foo", "--bar"] + + it "can complete both switches of an either wrapped in optionals" $ + parserCompletionTest + (optional (setting [switch (), long "foo"]) <|> optional (setting [switch (), long "bar"])) + 0 + [] + ["--foo", "--bar"] + + describe "commands" $ do + let p = + commands + [ command "foo" "1" $ pure (), + command "bar" "2" $ pure (), + command "baz" "3" $ pure () + ] + + it "can complete a command argument" $ + parserCompletionTest + p + 0 + [] + [Completion "foo" (Just "1"), Completion "bar" (Just "2"), Completion "baz" (Just "3")] + + it "can complete a command argument when it's been partially provided" $ + parserCompletionTest + p + 0 + ["b"] + [Completion "bar" (Just "2"), Completion "baz" (Just "3")] + + describe "completion after a command" $ do + it "can complete a command with a switch" $ + parserCompletionTest + (commands [command "foo" "1" $ setting [help "ex", switch (), short 'e', long "example"]]) + 1 + ["foo"] + [Completion "--example" (Just "ex")] -- Only the long version + it "can complete a command's short switch" $ + parserCompletionTest + (commands [command "foo" "1" $ setting [switch (), short 'e']]) + 1 + ["foo", "-"] + ["-e"] + + it "can complete a command's long switch from a single dash" $ + parserCompletionTest + (commands [command "foo" "1" $ setting [switch (), long "example"]]) + 1 + ["foo", "-"] + ["--example"] + + it "can complete a command's long switch from a double dash" $ + parserCompletionTest + (commands [command "foo" "1" $ setting [switch (), long "example"]]) + 1 + ["foo", "--"] + ["--example"] + + it "can complete a command's short option" $ + parserCompletionTest + (commands [command "foo" "1" $ setting [option, short 'e', completer $ listCompleter ["hi"]]]) + 2 + ["foo", "-e"] + ["hi"] + + it "can complete a command's long option" $ + parserCompletionTest + (commands [command "foo" "1" $ setting [option, long "example", completer $ listCompleter ["hi"]]]) + 2 + ["foo", "--example"] + ["hi"] + + it "can complete a file argument" $ + parserCompletionDescriptionTest + (filePathSetting [help "file arg", argument]) + 0 + [] + ["file arg"] + + it "can complete a file option" $ + parserCompletionDescriptionTest + (filePathSetting [help "file arg", option, long "file"]) + 1 + ["--file"] + ["file arg"] + + it "can complete a directory argument" $ + parserCompletionDescriptionTest + (directoryPathSetting [help "dir arg", argument]) + 0 + [] + ["dir arg"] + + it "can complete a directory option" $ + parserCompletionDescriptionTest + (directoryPathSetting [help "dir arg", option, long "file"]) + 1 + ["--file"] + ["dir arg"] + + it "no longer suggests a switch that has already been parsed" $ + parserCompletionTest + ((,) <$> setting [switch (), long "foo"] <*> setting [switch (), long "bar"]) + 1 + ["--foo"] + ["--bar"] + + it "no longer suggests an option that has already been parsed" $ + parserCompletionTest + ( (,,) + <$> setting [option, reader (str :: Reader String), long "foo"] + <*> setting [option, reader (str :: Reader String), long "bar"] + <*> setting [switch (), long "quux"] + ) + 2 + ["--foo", "foo"] + ["--bar", "--quux"] + + it "no longer suggests an argument that has already been parsed" $ + parserCompletionDescriptionTest + ( (,,) + <$> setting [argument, reader (str :: Reader String), help "hi", completer $ listCompleter ["hi"]] + <*> setting [argument, reader (str :: Reader String), help "ho", completer $ listCompleter ["ho"]] + <*> setting [switch (), long "bar", help "hu"] + ) + 1 + ["foo"] + ["ho", "hu"] diff --git a/test/OptEnvConf/ErrorSpec.hs b/test/OptEnvConf/ErrorSpec.hs --- a/test/OptEnvConf/ErrorSpec.hs +++ b/test/OptEnvConf/ErrorSpec.hs @@ -159,16 +159,52 @@ ) ["--foo", "'a'"] + parseArgsErrorSpec + "unrecognised-arg" + (pure 'a') + ["arg"] + parseArgsErrorSpec + "unrecognised-option" + (pure 'b') + ["--foo", "bar"] + parseArgsErrorSpec + "unrecognised-switch" + (pure 'c') + ["--foo"] + + parseArgsErrorSpec + "typo-option" + (optional $ setting [help "often misspelt as baz", reader str, option, long "bar"] :: Parser (Maybe String)) + ["--baz", "arg"] + + parseArgsErrorSpec + "typo-switch" + (optional $ setting [help "often misspelt as baz", switch True, long "bar"] :: Parser (Maybe Bool)) + ["--baz"] + + parseArgsErrorSpec + "leftover-switch" + (pure 'a') + ["--switch"] + parseArgsErrorSpec + "leftover-option" + (pure 'b') + ["--key", "val"] + parseArgsErrorSpec + "leftover-argument" + (pure 'c') + ["foo", "bar"] + parseArgsErrorSpec :: (HasCallStack) => (Show a) => FilePath -> Parser a -> [String] -> Spec parseArgsErrorSpec fp p args = withFrozenCallStack $ it (unwords ["renders the", fp, "error the same as before"]) $ let path = "test_resources/error/" <> fp <> ".txt" in goldenChunksFile path $ do - errOrResult <- runParserOn p (parseArgs args) EnvMap.empty Nothing + errOrResult <- runParserOn Nothing p (parseArgs args) EnvMap.empty Nothing case errOrResult of Right a -> expectationFailure $ unlines ["Should not have been able to parse, but did and got:", show a] - Left errs -> pure $ renderErrors $ eraseErrorSrcLocs errs + Left errs -> pure $ renderErrors errs parseEnvErrorSpec :: (HasCallStack) => (Show a) => FilePath -> Parser a -> [(String, String)] -> Spec parseEnvErrorSpec fp p e = @@ -176,10 +212,10 @@ it (unwords ["renders the", fp, "error the same as before"]) $ let path = "test_resources/error/" <> fp <> ".txt" in goldenChunksFile path $ do - errOrResult <- runParserOn p emptyArgs (EnvMap.parse e) Nothing + errOrResult <- runParserOn Nothing p emptyArgs (EnvMap.parse e) Nothing case errOrResult of Right a -> expectationFailure $ unlines ["Should not have been able to parse, but did and got:", show a] - Left errs -> pure $ renderErrors $ eraseErrorSrcLocs errs + Left errs -> pure $ renderErrors errs goldenChunksFile :: FilePath -> IO [Chunk] -> GoldenTest Text goldenChunksFile fp cs = diff --git a/test/OptEnvConf/HelpSpec.hs b/test/OptEnvConf/HelpSpec.hs new file mode 100644 --- /dev/null +++ b/test/OptEnvConf/HelpSpec.hs @@ -0,0 +1,167 @@ +{-# LANGUAGE ApplicativeDo #-} +{-# LANGUAGE OverloadedLists #-} +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE RecordWildCards #-} +{-# LANGUAGE TypeApplications #-} + +module OptEnvConf.HelpSpec (spec) where + +import Control.Applicative +import Data.GenValidity.Aeson () +import Data.Text (Text) +import qualified Data.Text as T +import Data.Version +import Data.Word +import OptEnvConf +import OptEnvConf.Args as Args +import OptEnvConf.Args.Gen () +import OptEnvConf.EnvMap.Gen () +import OptEnvConf.Error +import OptEnvConf.TestUtils +import Test.Syd +import Text.Colour + +spec :: Spec +spec = do + -- Help parsing works at the top level + helpSpec + "toplevel-pure" + [] + -- Help parsing needs to work even if provided settings are invalid + helpSpec + "toplevel-pure-with-invalid-port" + ["--port", "notaport"] + helpSpec + "read" + ["read"] + helpSpec + "create" + ["create"] + helpSpec + "sub" + ["sub"] + helpSpec + "sub-foo" + ["sub", "foo"] + helpSpec + "sub-bar" + ["sub", "bar"] + -- Help parsing needs to work if you type in the wrong command too. + helpSpec + "wrong-command" + ["quux"] + +data Instructions = Instructions !Settings !Dispatch + +instance HasParser Instructions where + settingsParser = + withLocalYamlConfig $ + Instructions + <$> settingsParser + <*> settingsParser + +data Dispatch + = DispatchRead + | DispatchCreate !String + | DispatchWithSub !Sub + +instance HasParser Dispatch where + settingsParser = + commands + [ command "read" "read command explanation" $ pure DispatchRead, + command "create" "create command explanation" $ + DispatchCreate + <$> setting + [ help "The item to create", + reader str, + argument, + metavar "STR" + ], + command "sub" "command with subcommand" $ DispatchWithSub <$> settingsParser + ] + +data Sub + = SubFoo + | SubBar + +instance HasParser Sub where + settingsParser = + commands + [ command "foo" "foo explanation" $ pure SubFoo, + command "bar" "bar explanation" $ pure SubBar + ] + +data Settings = Settings + { settingPort :: Word16, + settingLogLevel :: String, + settingPaymentSettings :: Maybe PaymentSettings + } + +instance HasParser Settings where + settingsParser = do + settingPort <- + setting + [ help "port to serve requests on", + reader auto, + metavar "PORT", + name "port", + value 8080 + ] + settingLogLevel <- + setting + [ help "minimal severity of log messages", + reader str, + metavar "LOG_LEVEL", + name "log-level", + value "DEBUG" + ] + settingPaymentSettings <- optional $ subSettings "payment" + pure Settings {..} + +data PaymentSettings = PaymentSettings + { paymentSetPublicKey :: String, + paymentSetSecretKey :: Text, + paymentSetCurrency :: Maybe String + } + +instance HasParser PaymentSettings where + settingsParser = do + paymentSetPublicKey <- + setting + [ help "Public key", + reader str, + name "public-key", + metavar "PUBLIC_KEY" + ] + paymentSetSecretKey <- + secretTextFileSetting + [ help "Secret key", + name "secret-key", + metavar "SECRET_KEY_FILE" + ] + paymentSetCurrency <- + optional $ + setting + [ help "Currency", + reader str, + name "currency", + metavar "CURRENCY" + ] + pure PaymentSettings {..} + +helpSpec :: String -> [String] -> Spec +helpSpec file args = + it (unwords ["this help page in the same way for args:", show args]) $ do + let version = makeVersion [0, 0, 0] + let argMap = Args.parseArgs args + let parser = settingsParser @Instructions + errOrDocs <- runHelpParser Nothing argMap parser + case errOrDocs of + Left err -> expectationFailure $ T.unpack $ renderChunksText With24BitColours $ renderErrors err + Right mCommandDoc -> do + let progname = "example" + pure $ + pureGoldenChunksFile ("test_resources/help/" <> file <> ".txt") $ + case mCommandDoc of + Nothing -> renderHelpPage progname version "example program description" (parserDocs parser) + Just (commandPath, commandDoc) -> renderCommandHelpPage progname commandPath commandDoc diff --git a/test/OptEnvConf/LintSpec.hs b/test/OptEnvConf/LintSpec.hs --- a/test/OptEnvConf/LintSpec.hs +++ b/test/OptEnvConf/LintSpec.hs @@ -21,13 +21,6 @@ ] ) goldenLintTest - "only-default" - ( setting - [ help "Only a default value", - value () - ] - ) - goldenLintTest "dash-in-short" ( setting [ help "Dash in a 'short'", @@ -80,6 +73,17 @@ Parser String ) goldenLintTest + "no-option-or-switch-for-dashed" + ( setting + [ reader str, + argument, + long "hi", + metavar "STR", + help "Example" + ] :: + Parser String + ) + goldenLintTest "no-metavar-for-option" ( setting [ reader str, @@ -133,6 +137,55 @@ metavar "INT" ] :: Parser Int + ) + goldenLintTest + "many-env" + ( many $ + setting + [ help "many with setting that always succeeds", + reader auto, + env "EXAMPLE", + metavar "INT" + ] :: + Parser [Int] + ) + goldenLintTest + "many-conf" + ( withLocalYamlConfig $ + many $ + setting + [ help "many with setting that always succeeds", + conf "example" + ] :: + Parser [Int] + ) + goldenLintTest + "some-env" + ( some $ + setting + [ help "some with setting that always succeeds", + reader auto, + env "EXAMPLE", + metavar "INT" + ] :: + Parser [Int] + ) + goldenLintTest + "some-conf" + ( withLocalYamlConfig $ + some $ + setting + [ help "some with setting that always succeeds", + conf "example" + ] :: + Parser [Int] + ) + goldenLintTest + "unknown-default-command" + ( commands + [ command "a" "a" $ pure 'a', + defaultCommand "b" + ] ) goldenLintTest :: (HasCallStack) => FilePath -> Parser a -> Spec diff --git a/test/OptEnvConf/ReaderSpec.hs b/test/OptEnvConf/ReaderSpec.hs --- a/test/OptEnvConf/ReaderSpec.hs +++ b/test/OptEnvConf/ReaderSpec.hs @@ -1,3 +1,5 @@ +{-# LANGUAGE LambdaCase #-} +{-# LANGUAGE OverloadedLists #-} {-# LANGUAGE OverloadedStrings #-} module OptEnvConf.ReaderSpec (spec) where @@ -25,4 +27,30 @@ parseCommaSeparated (renderCommaSeparated l) `shouldBe` l describe "commaSeparated" $ do - pure () + it "can parse these two ints" $ + runReader (commaSeparated auto) "1,2" + `shouldBe` Right [1, 2 :: Int] + + describe "commaSeparatedList" $ do + it "can parse these two ints" $ + runReader (commaSeparatedList auto) "3, 4" + `shouldBe` Right [3, 4 :: Int] + + describe "commaSeparatedSet" $ do + it "can parse these two ints" $ + runReader (commaSeparatedSet auto) "5, 6" + `shouldBe` Right [5, 6 :: Int] + + describe "maybeReader" $ + it "can parse a bool using this example reader" $ do + let r = maybeReader $ \case + "true" -> Just True + "false" -> Just False + _ -> Nothing + runReader r "true" `shouldBe` Right True + runReader r "false" `shouldBe` Right False + runReader r "yes" `shouldBe` Left "Unparseable value: \"yes\"" + + describe "viaStringCodec" $ + it "can parse a string via its string codec" $ + runReader viaStringCodec "hi" `shouldBe` Right ("hi" :: String) diff --git a/test/OptEnvConf/RunSpec.hs b/test/OptEnvConf/RunSpec.hs --- a/test/OptEnvConf/RunSpec.hs +++ b/test/OptEnvConf/RunSpec.hs @@ -1,7 +1,10 @@ {-# LANGUAGE LambdaCase #-} +{-# LANGUAGE OverloadedLists #-} +{-# LANGUAGE OverloadedStrings #-} module OptEnvConf.RunSpec (spec) where +import Autodocodec import Control.Applicative import Data.Aeson as JSON (Object, Value (Null), toJSON) import qualified Data.Aeson.Key as Key @@ -11,6 +14,7 @@ import qualified Data.List.NonEmpty as NE import Data.Text (Text) import qualified Data.Text as T +import Data.Tuple (swap) import GHC.Stack (HasCallStack, withFrozenCallStack) import OptEnvConf import OptEnvConf.Args as Args @@ -28,49 +32,44 @@ describe "runParser" $ do describe "pure" $ do it "can parse a pure value from anything" $ - forAllValid $ \args -> - forAllValid $ \e -> - forAllValid $ \mConf -> - forAllValid $ \expected -> - shouldParse (pure expected) args e mConf (expected :: Int) + forAllValid $ \e -> + forAllValid $ \mConf -> + forAllValid $ \expected -> + shouldParse (pure expected) Args.emptyArgs e mConf (expected :: Int) describe "fmap" $ do it "can parse a mapped value from anything" $ - forAllValid $ \args -> - forAllValid $ \e -> - forAllValid $ \mConf -> - forAllValid $ \i -> do - let expected = succ i - shouldParse (fmap succ $ pure i) args e mConf (expected :: Int) + forAllValid $ \e -> + forAllValid $ \mConf -> + forAllValid $ \i -> do + let expected = succ i + shouldParse (fmap succ $ pure i) Args.emptyArgs e mConf (expected :: Int) describe "<*>" $ do it "can parse two values with ap" $ - forAllValid $ \args -> - forAllValid $ \e -> - forAllValid $ \mConf -> - forAllValid $ \i -> do - let p = (,) <$> pure (succ i) <*> pure i - let expected = (succ i, i :: Int) - shouldParse p args e mConf expected + forAllValid $ \e -> + forAllValid $ \mConf -> + forAllValid $ \i -> do + let p = (,) <$> pure (succ i) <*> pure i + let expected = (succ i, i :: Int) + shouldParse p Args.emptyArgs e mConf expected describe "Select" $ do it "can use the second parser with select" $ - forAllValid $ \args -> - forAllValid $ \e -> - forAllValid $ \mConf -> - forAllValid $ \i -> do - let p = select (pure (Left i :: Either Int Int)) (pure succ) - let expected = succ i - shouldParse p args e mConf expected + forAllValid $ \e -> + forAllValid $ \mConf -> + forAllValid $ \i -> do + let p = select (pure (Left i :: Either Int Int)) (pure succ) + let expected = succ i + shouldParse p Args.emptyArgs e mConf expected it "can avoid the second parser with select" $ - forAllValid $ \args -> - forAllValid $ \e -> - forAllValid $ \mConf -> - forAllValid $ \i -> do - let p = select (pure (Right i :: Either Int Int)) (pure succ) - let expected = i - shouldParse p args e mConf expected + forAllValid $ \e -> + forAllValid $ \mConf -> + forAllValid $ \i -> do + let p = select (pure (Right i :: Either Int Int)) (pure succ) + let expected = i + shouldParse p Args.emptyArgs e mConf expected describe "Empty" $ do it "can fail to parse an empty value" $ @@ -84,29 +83,27 @@ describe "Alt" $ do it "can parse a Left value with Alt" $ - forAllValid $ \args -> - forAllValid $ \e -> - forAllValid $ \mConf -> - forAllValid $ \i -> do - let p = (Left <$> pure i) <|> (Right <$> pure (succ i)) - let expected = Left (i :: Int) - shouldParse p args e mConf expected + forAllValid $ \e -> + forAllValid $ \mConf -> + forAllValid $ \i -> do + let p = (Left <$> pure i) <|> (Right <$> pure (succ i)) + let expected = Left (i :: Int) + shouldParse p Args.emptyArgs e mConf expected it "can parse a Right value with Alt" $ - forAllValid $ \args -> - forAllValid $ \e -> - forAllValid $ \mConf -> - forAllValid $ \i -> do - let p = empty `ParserAlt` (Right <$> pure i) - let expected = Right (i :: Int) :: Either Int Int - shouldParse p args e mConf expected + forAllValid $ \e -> + forAllValid $ \mConf -> + forAllValid $ \i -> do + let p = empty `ParserAlt` (Right <$> pure i) + let expected = Right (i :: Int) :: Either Int Int + shouldParse p Args.emptyArgs e mConf expected describe "Many" $ do it "can pass many args" $ forAllValid $ \e -> forAllValid $ \mConf -> forAllValid $ \ls -> do - let args = emptyArgs {unArgs = map (Live . ArgPlain) ls} + let args = parseArgs ls let p = many $ setting [reader str, argument] let expected = ls shouldParse p args e mConf expected @@ -115,7 +112,7 @@ it "fails to parse zero args" $ forAllValid $ \e -> forAllValid $ \mConf -> do - let args = emptyArgs {unArgs = []} + let args = emptyArgs let p = some $ setting [reader str, argument] :: Parser [String] shouldFail p args e mConf $ \case ParseErrorMissingArgument _ :| [] -> True @@ -125,105 +122,113 @@ forAllValid $ \e -> forAllValid $ \mConf -> forAllValid $ \ls -> do - let args = emptyArgs {unArgs = map (Live . ArgPlain) (NE.toList ls)} + let args = parseArgs (NE.toList ls) let p = some $ setting [reader str, argument] let expected = NE.toList ls shouldParse p args e mConf expected describe "MapIO" $ do it "can run an IO action on the result of a parser" $ - forAllValid $ \args -> - forAllValid $ \e -> - forAllValid $ \mConf -> - forAllValid $ \i -> do - let p = mapIO (pure . succ) (pure (i :: Int)) - let expected = succ i - shouldParse p args e mConf expected + forAllValid $ \e -> + forAllValid $ \mConf -> + forAllValid $ \i -> do + let p = mapIO (pure . succ) (pure (i :: Int)) + let expected = succ i + shouldParse p Args.emptyArgs e mConf expected describe "WithConfig" $ do it "can replace the config object" $ - forAllValid $ \args -> - forAllValid $ \e -> - forAllValid $ \c1 -> - forAllValid $ \c2' -> - forAllValid $ \(key, val) -> do - let c2 = KeyMap.insert key (toJSON val) c2' - let p = - withConfig (pure (Just c2)) $ - setting [conf (Key.toString key)] - let expected = val :: Text - shouldParse p args e (Just c1) expected + forAllValid $ \e -> + forAllValid $ \c1 -> + forAllValid $ \c2' -> + forAllValid $ \(key, val) -> do + let c2 = KeyMap.insert key (toJSON val) c2' + let p = + withConfig (pure (Just c2)) $ + setting [conf (Key.toString key)] + let expected = val :: Text + shouldParse p Args.emptyArgs e (Just c1) expected + describe "withFirstYamlConfig" $ do + it "can parse without any arguments" $ + forAllValid $ \e -> + forAllValid $ \val -> do + let p = withFirstYamlConfig (pure []) (pure val) :: Parser String + shouldParse p Args.emptyArgs e Nothing val + + describe "withCombinedYamlConfig" $ do + it "can parse without any arguments" $ do + forAllValid $ \e -> + forAllValid $ \val -> do + let p = withCombinedYamlConfigs (pure []) (pure val) :: Parser String + shouldParse p Args.emptyArgs e Nothing val + describe "subArgs" $ do it "can prefix a switch parser" $ - forAllValid $ \a' -> - forAllValid $ \e -> - forAllValid $ \mConf -> - forAllValid $ \prefix -> - forAllValid $ \(key, val) -> do - let prefixedKey = Args.prefixDashed prefix (DashedLong key) - let a = a' {unArgs = Live (Args.renderDashedArg prefixedKey) : unArgs a'} - let p = - subArgs prefix $ - setting - [ reader str, - switch val, - long (NE.toList key) - ] - let expected = val :: String - shouldParse p a e mConf expected + forAllValid $ \e -> + forAllValid $ \mConf -> + forAllValid $ \prefix -> + forAllValid $ \(key, val) -> do + let prefixedKey = Args.prefixDashed prefix (DashedLong key) + let a = Args.parseArgs [Args.renderDashed prefixedKey] + let p = + subArgs prefix $ + setting + [ reader str, + switch val, + long (NE.toList key) + ] + let expected = val :: String + shouldParse p a e mConf expected it "can prefix an option parser" $ - forAllValid $ \a' -> - forAllValid $ \e -> - forAllValid $ \mConf -> - forAllValid $ \prefix -> - forAllValid $ \(key, val) -> do - let prefixedKey = Args.prefixDashed prefix (DashedLong key) - let a = a' {unArgs = Live (Args.renderDashedArg prefixedKey) : Live (ArgPlain val) : unArgs a'} - let p = - subArgs prefix $ - setting - [ reader str, - option, - long (NE.toList key) - ] - let expected = val - shouldParse p a e mConf expected + forAllValid $ \e -> + forAllValid $ \mConf -> + forAllValid $ \prefix -> + forAllValid $ \(key, val) -> do + let prefixedKey = Args.prefixDashed prefix (DashedLong key) + let a = parseArgs [renderDashed prefixedKey, val] + let p = + subArgs prefix $ + setting + [ reader str, + option, + long (NE.toList key) + ] + let expected = val + shouldParse p a e mConf expected describe "subEnv" $ do it "can prefix an env var parser" $ - forAllValid $ \args -> - forAllValid $ \e' -> - forAllValid $ \mConf -> - forAllValid $ \prefix -> - forAllValid $ \(key, val) -> do - let prefixedKey = prefix <> key - let e = EnvMap.insert prefixedKey val e' - let p = subEnv prefix $ setting [reader str, env key] - let expected = val - shouldParse p args e mConf expected + forAllValid $ \e' -> + forAllValid $ \mConf -> + forAllValid $ \prefix -> + forAllValid $ \(key, val) -> do + let prefixedKey = prefix <> key + let e = EnvMap.insert prefixedKey val e' + let p = subEnv prefix $ setting [reader str, env key] + let expected = val + shouldParse p Args.emptyArgs e mConf expected describe "subConfig" $ do it "can prefix a conf val parser" $ - forAllValid $ \args -> - forAllValid $ \e -> - forAllValid $ \c' -> - forAllValid $ \prefix -> - forAllValid $ \(key, val) -> do - let c = KeyMap.insert prefix (toJSON (KeyMap.singleton key (toJSON val))) c' - let p = - subConfig (Key.toString prefix) $ - setting [conf (Key.toString key)] - let expected = val :: Text - shouldParse p args e (Just c) expected + forAllValid $ \e -> + forAllValid $ \c' -> + forAllValid $ \prefix -> + forAllValid $ \(key, val) -> do + let c = KeyMap.insert prefix (toJSON (KeyMap.singleton key (toJSON val))) c' + let p = + subConfig (Key.toString prefix) $ + setting [conf (Key.toString key)] + let expected = val :: Text + shouldParse p Args.emptyArgs e (Just c) expected describe "Setting" $ do it "can parse a single arg" $ forAllValid $ \e -> forAllValid $ \mConf -> forAllValid $ \arg -> do - let args = emptyArgs {unArgs = [Live (ArgPlain arg)]} + let args = Args.parseArgs [arg] let p = setting [reader str, argument] let expected = arg shouldParse p args e mConf expected @@ -233,12 +238,10 @@ forAllValid $ \mConf -> forAllValid $ \(l, r) -> do let args = - emptyArgs - { unArgs = - [ Live (Args.renderDashedArg (DashedLong l)), - Live (ArgPlain r) - ] - } + parseArgs + [ Args.renderDashed (DashedLong l), + r + ] let p = setting [reader str, option, long $ NE.toList l] let expected = r shouldParse p args e mConf expected @@ -247,79 +250,72 @@ forAllValid $ \e -> forAllValid $ \mConf -> forAllValid $ \(l, rs) -> do - let args = - emptyArgs - { unArgs = - concatMap - ( \v -> - [ Live (Args.renderDashedArg (DashedLong l)), - Live (ArgPlain v) - ] - ) - rs - } + let args = parseArgs $ concatMap (\v -> [Args.renderDashed (DashedLong l), v]) rs let p = many $ setting [reader str, option, long $ NE.toList l] let expected = rs :: [String] shouldParse p args e mConf expected it "can parse a single env var" $ - forAllValid $ \args -> - forAllValid $ \e' -> - forAllValid $ \mConf -> - forAllValid $ \(key, val) -> do - let e = EnvMap.insert key val e' - let p = setting [reader str, env key] - let expected = val - shouldParse p args e mConf expected + forAllValid $ \e' -> + forAllValid $ \mConf -> + forAllValid $ \(key, val) -> do + let e = EnvMap.insert key val e' + let p = setting [reader str, env key] + let expected = val + shouldParse p Args.emptyArgs e mConf expected it "can parse a single config value" $ - forAllValid $ \args -> - forAllValid $ \e -> - forAllValid $ \c' -> - forAllValid $ \(key, val) -> do - let c = KeyMap.insert key (toJSON val) c' - let p = setting [conf (Key.toString key)] - let expected = val :: Text - shouldParse p args e (Just c) expected + forAllValid $ \e -> + forAllValid $ \c' -> + forAllValid $ \(key, val) -> do + let c = KeyMap.insert key (toJSON val) c' + let p = setting [conf (Key.toString key)] + let expected = val :: Text + shouldParse p Args.emptyArgs e (Just c) expected it "parses Null as the default value" $ - forAllValid $ \args -> - forAllValid $ \e -> - forAllValid $ \c' -> - forAllValid $ \key -> do - let c = KeyMap.insert key JSON.Null c' - let defaultVal = "hi" - let p = setting [conf (Key.toString key), value defaultVal] - let expected = defaultVal - shouldParse p args e (Just c) expected + forAllValid $ \e -> + forAllValid $ \c' -> + forAllValid $ \key -> do + let c = KeyMap.insert key JSON.Null c' + let defaultVal = "hi" :: String + let p = setting [conf (Key.toString key), value defaultVal] + let expected = defaultVal + shouldParse p Args.emptyArgs e (Just c) expected describe "Unit tests" $ do argParseSpec ["--foo", "bar"] (setting [reader str, option, long "foo"]) - "bar" + ("bar" :: String) argParseSpec ["--foo", "bar"] (many $ setting [reader str, option, long "foo"]) - ["bar"] + (["bar"] :: [String]) argParseSpec ["--foo", "bar", "--foo", "quux"] (many $ setting [reader str, option, long "foo"]) - ["bar", "quux"] + (["bar", "quux"] :: [String]) argParseSpec ["--foo", "bar", "-f", "quux"] (many $ setting [reader str, option, short 'f', long "foo"]) - ["bar", "quux"] + (["bar", "quux"] :: [String]) argParseSpec ["-f", "bar", "--foo", "quux"] (many $ setting [reader str, option, short 'f', long "foo"]) - ["bar", "quux"] + (["bar", "quux"] :: [String]) + argParseSpec + ["--", "all", "-bare", "--arguments"] + (many $ setting [reader str, argument]) + -- No double-dash! + (["all", "-bare", "--arguments"] :: [String]) + -- Switch before argument argParseSpec ["--foo", "bar"] ((,) <$> setting [switch True, long "foo"] <*> setting [reader str, argument]) - (True, "bar") + (True, "bar" :: String) -- Note that this could also be parsed as (False, "--foo") with a -- leftover argument but somehow that's not what we want. @@ -328,13 +324,13 @@ argParseSpec ["--foo", "bar"] ((,) <$> setting [switch True, long "foo", value False] <*> setting [reader str, argument]) - (True, "bar") + (True, "bar" :: String) -- Switch before argument, but defined after argParseSpec ["--foo", "bar"] ((,) <$> setting [reader str, argument] <*> setting [switch True, long "foo"]) - ("bar", True) + ("bar" :: String, True) -- Dashed as argument -- This example shows that we can't just skip dasheds when looking for @@ -342,7 +338,7 @@ argParseSpec ["--foo", "bar"] ((,) <$> setting [reader str, argument] <*> setting [reader str, argument]) - ("--foo", "bar") + ("--foo" :: String, "bar" :: String) -- Dashed as value for an option -- This example shows that we can't "just" treat any argument with dashed @@ -351,7 +347,7 @@ argParseSpec ["--foo", "--bar"] (setting [reader str, option, long "foo"]) - "--bar" + ("--bar" :: String) -- Short dashed as a value for an option -- This example shows that we can't "just" unfold combined short options. @@ -359,8 +355,28 @@ argParseSpec ["--foo", "-dfu"] (setting [reader str, option, long "foo"]) - "-dfu" + ("-dfu" :: String) + -- Arguments can be parsed as-is + argParseSpec + ["delete"] + ( commands + [ command "add" "add" (pure "hi"), + command "delete" "delete" (pure "ho") + ] + ) + ("ho" :: String) + + -- A command can have an argument + argParseSpec + ["add", "hi"] + ( commands + [ command "add" "add" $ setting [argument, reader str], + command "other" "other" (pure "ho") + ] + ) + ("hi" :: String) + -- Here an argument has a value that looks like a command name but -- should still be treated as an argument. argParseSpec @@ -372,7 +388,7 @@ command "arg" "command" (pure '2') ] ) - ("command", '2') + ("command" :: String, '2') -- Same as above but with an option instead of an argument argParseSpec @@ -384,8 +400,30 @@ command "arg" "command" (pure '2') ] ) - ("command", '2') + ("command" :: String, '2') + -- Commands can have a default + argParseSpec + [] + ( commands + [ command "a" "a" (pure "a"), + command "b" "b" (pure "b"), + defaultCommand "b" + ] + ) + ("b" :: String) + + -- Commands can have a default with an argument + argParseSpec + ["c"] + ( commands + [ command "a" "a" (pure "a"), + command "b" "b" $ setting [argument, reader str], + defaultCommand "b" + ] + ) + ("c" :: String) + -- Unfolding switches argParseSpecs ( length @@ -427,7 +465,7 @@ example ("file" :: String) ] ) - [ (["-f", "foo"], (0, "foo")), + [ (["-f", "foo"], (0, "foo" :: String)), (["-v", "-f", "foo"], (1, "foo")), (["-vf", "foo", "-v"], (2, "foo")), (["-vvf", "foo"], (2, "foo")), @@ -456,7 +494,7 @@ ) ) [ ([], ([], 0)), - (["--file", "foo", "-v"], (["foo"], 1)), + (["--file", "foo", "-v"], (["foo" :: String], 1)), (["-vf", "foo"], (["foo"], 1)) ] -- Equals version of long option @@ -467,7 +505,7 @@ long "file" ] ) - [ (["--file", "foo"], "foo"), + [ (["--file", "foo"], "foo" :: String), (["--file=foo"], "foo") ] @@ -479,26 +517,128 @@ short 'f' ] ) - [ (["-f", "foo"], "foo"), + [ (["-f", "foo"], "foo" :: String), (["-ffoo"], "foo") ] + -- Optional Argument and optional switch + let optionalArgOptionalSwitchExamples = + [ (["foo", "-w"], (Just "foo", True)), + (["-w", "foo"], (Just "foo", True)), + (["foo", "--watch"], (Just "foo", True)), + (["--watch", "foo"], (Just "foo", True)), + (["foo"], (Just "foo", False)), + (["--bar"], (Just "--bar", False)), + (["-w"], (Nothing, True)), + (["--watch"], (Nothing, True)) + ] argParseSpecs - (enableDisableSwitch True [long "example", env "EXAMPLE", conf "example"]) + ( (,) + <$> optional (setting [reader str, argument]) + <*> setting [switch True, short 'w', long "watch", value False] :: + Parser (Maybe String, Bool) + ) + optionalArgOptionalSwitchExamples + argParseSpecs + ( swap + <$> ( (,) + <$> setting [switch True, short 'w', long "watch", value False] + <*> optional (setting [reader str, argument]) + ) :: + Parser (Maybe String, Bool) + ) + optionalArgOptionalSwitchExamples + + let verbosityArgsExamples = + [ ([], ([], 0)), + (["-vvv"], ([], 3)), + (["--"], (["--"], 0)), + (["-v", "--"], (["--"], 1)), + (["-vv", "--"], (["--"], 2)), + (["--", "-v"], (["-v"], 0)), + (["a", "-v", "b", "-v"], (["a", "b"], 2)), + (["a", "--verbose", "-v", "b", "-v"], (["a", "b"], 3)), + (["a", "--verbose", "-v", "-v", "b", "-v"], (["a", "b"], 4)), + (["a", "--verbose", "-v", "-v", "b", "-v", "c"], (["a", "b", "c"], 4)), + (["a", "--verbose", "-v", "-vv", "b", "-v", "c"], (["a", "b", "c"], 5)), + (["a", "--verbose", "-v", "-vv", "-v", "b", "-v", "c"], (["a", "b", "c"], 6)) + ] + argParseSpecs + ( (,) + <$> many (setting [reader str, argument]) + <*> (length <$> many (setting [switch (), short 'v', long "verbose"])) :: + Parser ([String], Int) + ) + verbosityArgsExamples + argParseSpecs + ( swap + <$> ( (,) + <$> (length <$> many (setting [switch (), short 'v', long "verbose"])) + <*> many (setting [reader str, argument]) + ) :: + Parser ([String], Int) + ) + verbosityArgsExamples + + let optionsArgsExamples = + [ ([], ([], [])), + (["-p1"], ([], [1])), + (["-p1", "--port", "2"], ([], [1, 2])), + (["-p", "1", "-p", "2", "-p", "3"], ([], [1, 2, 3])), + (["--port=2"], ([], [2])), + (["--port=2", "-p3"], ([], [2, 3])), + (["--port", "3"], ([], [3])), + (["foo", "-p4"], (["foo"], [4])), + (["bar", "--port=5"], (["bar"], [5])), + (["quux", "--port", "6"], (["quux"], [6])), + (["-p7", "foo"], (["foo"], [7])), + (["--port=8", "bar"], (["bar"], [8])), + (["--port", "9", "quux"], (["quux"], [9])), + (["--", "-p1"], (["-p1"], [])), + (["--", "-p", "2"], (["-p", "2"], [])), + (["--", "--port=3"], (["--port=3"], [])), + (["--", "--port", "4"], (["--port", "4"], [])) + ] + argParseSpecs + ( (,) + <$> many (setting [reader str, argument]) + <*> many (setting [reader auto, option, short 'p', long "port"]) :: + Parser ([String], [Int]) + ) + optionsArgsExamples + argParseSpecs + ( swap + <$> ( (,) + <$> many (setting [reader auto, option, short 'p', long "port"]) + <*> many (setting [reader str, argument]) + ) :: + Parser ([String], [Int]) + ) + optionsArgsExamples + + argParseSpecs + (enableDisableSwitch [long "example", env "EXAMPLE", conf "example", value True]) [ ([], True), (["--enable-example"], True), (["--disable-example"], False) ] argParseSpecs - (enableDisableSwitch False [long "example", env "EXAMPLE", conf "example"]) + (enableDisableSwitch [long "example", env "EXAMPLE", conf "example", value False]) [ ([], False), (["--enable-example"], True), (["--disable-example"], False) ] + argParseSpecs + (optional $ enableDisableSwitch [long "example", env "EXAMPLE", conf "example"]) + [ ([], Nothing), + (["--enable-example"], Just True), + (["--disable-example"], Just False) + ] + envParseSpecs - (enableDisableSwitch True [long "example", env "EXAMPLE", env "ALTERNATIVE", conf "example"]) + (enableDisableSwitch [long "example", env "EXAMPLE", env "ALTERNATIVE", conf "example", value True]) [ ([], True), ([("EXAMPLE", "False")], False), ([("ALTERNATIVE", "False")], False), @@ -507,7 +647,7 @@ ] envParseSpecs - (enableDisableSwitch False [long "example", env "EXAMPLE", env "ALTERNATIVE", conf "example"]) + (enableDisableSwitch [long "example", env "EXAMPLE", env "ALTERNATIVE", conf "example", value False]) [ ([], False), ([("EXAMPLE", "True")], True), ([("ALTERNATIVE", "True")], True), @@ -516,6 +656,45 @@ ] argParseSpecs + (yesNoSwitch [long "example", env "EXAMPLE", conf "example", value True]) + [ ([], True), + (["--example"], True), + (["--no-example"], False) + ] + + argParseSpecs + (yesNoSwitch [long "example", env "EXAMPLE", conf "example", value False]) + [ ([], False), + (["--example"], True), + (["--no-example"], False) + ] + + argParseSpecs + (optional $ yesNoSwitch [long "example", env "EXAMPLE", conf "example"]) + [ ([], Nothing), + (["--example"], Just True), + (["--no-example"], Just False) + ] + + envParseSpecs + (yesNoSwitch [long "example", env "EXAMPLE", env "ALTERNATIVE", conf "example", value True]) + [ ([], True), + ([("EXAMPLE", "False")], False), + ([("ALTERNATIVE", "False")], False), + ([("EXAMPLE", "True")], True), + ([("ALTERNATIVE", "True")], True) + ] + + envParseSpecs + (yesNoSwitch [long "example", env "EXAMPLE", env "ALTERNATIVE", conf "example", value False]) + [ ([], False), + ([("EXAMPLE", "True")], True), + ([("ALTERNATIVE", "True")], True), + ([("EXAMPLE", "False")], False), + ([("ALTERNATIVE", "False")], False) + ] + + argParseSpecs ( commands [ command "one" "first" $ pure '1', command "two" "second" $ pure '2' @@ -528,12 +707,12 @@ argParseSpecs ((Left <$> setting [switch True, long "bash-completion-script"]) <|> (Right <$> setting [reader str, argument])) [ (["--bash-completion-script"], Left True), - (["arg"], Right "arg") + (["arg"], Right ("arg" :: String)) ] argParseSpecs ((Left <$> setting [switch True, long "bash-completion-script"]) <|> (Right <$> optional (setting [reader str, argument]))) [ (["--bash-completion-script"], Left True), - (["arg"], Right (Just "arg")) + (["arg"], Right (Just ("arg" :: String))) ] argParseSpecs @@ -549,6 +728,7 @@ [ ([], Nothing), (["--foo", "foo"], Just ("foo", Nothing)) ] + -- Default values should not count as parsed: argParseSpecs ( choice @@ -577,30 +757,153 @@ [ (["--before", "'m'"], ('m', Nothing)) ] + -- source location does not matter + argParseSpecs + ( optional + ( let foo = setting [reader str, option, long "foo"] + in (,) + <$> foo + <*> optional + ( subAll + "bar" + ( allOrNothing + ( (,) + <$> foo + <*> setting [reader str, option, long "bar"] + ) + ) + ) + ) :: + Parser (Maybe (String, Maybe (String, String))) + ) + [ ([], Nothing), + (["--foo", "foo"], Just ("foo", Nothing)) + ] + + -- Failing after consuming args leaves the args unconsumed + argParseSpecs + ( choice + [ (++) + <$> many (setting [reader str, argument]) + <*> setting [switch ["ho"], long "--switch"], + many $ setting [reader str, argument] + ] + ) + [ (["args", "here"], ["args", "here" :: String]) + ] + + -- Unrecognised args should be forgivable + argParseSpecs + ( let fallback = setting [reader str, option, long "foo"] + withCommand = commands [command "run" "command in front" fallback] + in withCommand <|> fallback + ) + [ (["run", "--foo", "bar"], "bar" :: String), + (["--foo", "bar"], "bar" :: String) + ] + + -- Alt-ing commands concats the commands + argParseSpecs + ( let fallback = setting [reader str, option, long "foo"] + withCommand1 = commands [command "run1" "command in front" fallback] + withCommand2 = commands [command "run2" "command in front" fallback] + in withCommand1 <|> withCommand2 <|> fallback + ) + [ (["run1", "--foo", "bar"], "bar" :: String), + (["run2", "--foo", "bar"], "bar" :: String), + (["--foo", "bar"], "bar" :: String) + ] + + -- Alt-ing commands concats the commands, even recursively + argParseSpecs + ( let fallback = setting [reader str, option, long "foo"] + withCommand1 = commands [command "run1" "command in front" fallback] + withCommand2 = commands [command "run2" "command in front" fallback] + in withCommand1 <|> (withCommand2 <|> fallback) + ) + [ (["run1", "--foo", "bar"], "bar" :: String), + (["run2", "--foo", "bar"], "bar" :: String), + (["--foo", "bar"], "bar" :: String) + ] + + -- Required config value + confParseSpecs + (setting [conf "hi"] :: Parser String) + [ (Just [("hi", "ho")], "ho") + ] + + -- Optional config value + confParseSpecs + (optional $ setting [conf "hi"] :: Parser (Maybe String)) + [ (Nothing, Nothing), + (Just [("hi", "ho")], Just "ho") + ] + + -- Multiple possible codecs + confParseSpecs + ( setting + [ confWith "hi" (Left <$> codec), + confWith "foo" (Right <$> codec) + ] + ) + [ (Just [("hi", toJSON (5 :: Int))], Left 5), + (Just [("foo", "bar")], Right "bar" :: Either Int String) + ] + + argParseSpecs + ( withDefault + False + ( setting + [ argument, + reader auto + ] + ) + ) + [ (["True"], True), + ([], False) + ] + argParseSpecs :: (HasCallStack) => (Show a, Eq a) => Parser a -> [([String], a)] -> Spec argParseSpecs p table = withFrozenCallStack $ mapM_ (\(args, result) -> argParseSpec args p result) table argParseSpec :: (HasCallStack) => (Show a, Eq a) => [String] -> Parser a -> a -> Spec argParseSpec args p expected = withFrozenCallStack $ do - it (unwords ["parses", show args, "as", show expected]) $ do + it (unwords ["parses args", show args, "as", show expected]) $ do let argMap = parseArgs args - errOrRes <- runParserOn p argMap EnvMap.empty Nothing - case errOrRes of - Left err -> expectationFailure $ T.unpack $ renderChunksText With24BitColours $ renderErrors err - Right actual -> actual `shouldBe` expected + errOrRes <- runParserOn Nothing p argMap EnvMap.empty Nothing + context (showParserABit p) $ + case errOrRes of + Left errs -> + expectationFailure $ + unlines + [ T.unpack $ renderChunksText With24BitColours $ renderErrors errs, + ppShow errs + ] + Right actual -> actual `shouldBe` expected envParseSpecs :: (HasCallStack) => (Show a, Eq a) => Parser a -> [([(String, String)], a)] -> Spec envParseSpecs p table = withFrozenCallStack $ mapM_ (\(envs, result) -> envParseSpec envs p result) table envParseSpec :: (HasCallStack) => (Show a, Eq a) => [(String, String)] -> Parser a -> a -> Spec envParseSpec envVars p expected = withFrozenCallStack $ do - it (unwords ["parses", show envVars, "as", show expected]) $ do + it (unwords ["parses environment", show envVars, "as", show expected]) $ do let envMap = EnvMap.parse envVars - errOrRes <- runParserOn p emptyArgs envMap Nothing + errOrRes <- runParserOn Nothing p emptyArgs envMap Nothing case errOrRes of Left err -> expectationFailure $ T.unpack $ renderChunksText With24BitColours $ renderErrors err Right actual -> actual `shouldBe` expected +confParseSpecs :: (HasCallStack) => (Show a, Eq a) => Parser a -> [(Maybe JSON.Object, a)] -> Spec +confParseSpecs p table = withFrozenCallStack $ mapM_ (\(mConf, result) -> confParseSpec mConf p result) table + +confParseSpec :: (HasCallStack) => (Show a, Eq a) => Maybe JSON.Object -> Parser a -> a -> Spec +confParseSpec mConf p expected = withFrozenCallStack $ do + it (unwords ["parses configuration", show mConf, "as", show expected]) $ do + errOrRes <- runParserOn Nothing p emptyArgs EnvMap.empty mConf + case errOrRes of + Left err -> expectationFailure $ T.unpack $ renderChunksText With24BitColours $ renderErrors err + Right actual -> actual `shouldBe` expected + shouldParse :: (Show a, Eq a) => Parser a -> @@ -610,7 +913,7 @@ a -> IO () shouldParse p args e mConf expected = do - errOrRes <- runParserOn p args e mConf + errOrRes <- runParserOn Nothing p args e mConf context (showParserABit p) $ case errOrRes of Left errs -> expectationFailure $ T.unpack $ renderChunksText With24BitColours $ renderErrors errs Right actual -> actual `shouldBe` expected @@ -624,7 +927,7 @@ (NonEmpty ParseErrorMessage -> Bool) -> IO () shouldFail p args e mConf isExpected = do - errOrRes <- runParserOn p args e mConf + errOrRes <- runParserOn Nothing p args e mConf case errOrRes of Left errs -> NE.map parseErrorMessage errs `shouldSatisfy` isExpected Right actual -> expectationFailure $ show actual diff --git a/test/OptEnvConf/TestUtils.hs b/test/OptEnvConf/TestUtils.hs new file mode 100644 --- /dev/null +++ b/test/OptEnvConf/TestUtils.hs @@ -0,0 +1,9 @@ +module OptEnvConf.TestUtils (pureGoldenChunksFile) where + +import Data.Text (Text) +import Test.Syd +import Text.Colour + +pureGoldenChunksFile :: FilePath -> [Chunk] -> GoldenTest Text +pureGoldenChunksFile fp cs = + pureGoldenTextFile fp $ renderChunksText With24BitColours cs diff --git a/test/OptEnvConf/ToplevelSpec.hs b/test/OptEnvConf/ToplevelSpec.hs new file mode 100644 --- /dev/null +++ b/test/OptEnvConf/ToplevelSpec.hs @@ -0,0 +1,58 @@ +module OptEnvConf.ToplevelSpec where + +import Data.Version +import OptEnvConf +import System.Environment +import System.Exit +import Test.Syd + +spec :: Spec +spec = do + let dummyVersion = makeVersion [0, 0, 0] + let dummyProgDesc = "dummy" + let dummyParser = pure 'a' + let dummyRun = runParser dummyVersion dummyProgDesc dummyParser + sequential $ do + it "can fail fast when too many unrecognsied arguments are given" $ + withArgs ["-option1", "option", "--option2", "option", "--option3", "option", "--option4", "option"] $ + dummyRun `shouldThrow` (== ExitFailure 1) + + describe "--help" $ do + it "can show help text with --help" $ + withArgs ["--help"] $ + dummyRun `shouldThrow` (== ExitSuccess) + it "can show help text with --help even when there are more args" $ + withArgs ["--help", "more", "args", "here"] $ + dummyRun `shouldThrow` (== ExitSuccess) + it "can show help text with -h" $ + withArgs ["-h"] $ + dummyRun `shouldThrow` (== ExitSuccess) + it "can show help text with --help even when there are more args" $ + withArgs ["-h", "more", "args", "here"] $ + dummyRun `shouldThrow` (== ExitSuccess) + + describe "--version" $ do + it "can show version info with --version" $ + withArgs ["--version"] $ + dummyRun `shouldThrow` (== ExitSuccess) + + describe "--run-settings-check" $ do + it "can run a settings check with --run-settings-check" $ + withArgs ["--run-settings-check"] $ + dummyRun `shouldThrow` (== ExitSuccess) + it "can run a settings check with --run-settings-check even when there are more args" $ + withArgs ["--run-settings-check", "more", "args", "here"] $ + runParser + dummyVersion + dummyProgDesc + ( many + ( setting + [ help "something that reads args", + argument, + reader str, + metavar "STR" + ] + ) :: + Parser [String] + ) + `shouldThrow` (== ExitSuccess) diff --git a/test_resources/completion/bash-completion-script.bash b/test_resources/completion/bash-completion-script.bash --- a/test_resources/completion/bash-completion-script.bash +++ b/test_resources/completion/bash-completion-script.bash @@ -10,7 +10,6 @@ done COMPREPLY=( $(/usr/bin/example-executable "${CMDLINE[@]}") ) - echo "${COMPREPLY[@]}" > hm.log } complete -o filenames -F _opt_env_conf_completion_example_executable example-executable diff --git a/test_resources/docs/args/config-docs.txt b/test_resources/docs/args/config-docs.txt deleted file mode 100644 --- a/test_resources/docs/args/config-docs.txt +++ /dev/null @@ -1,1 +0,0 @@ -AnyDocsAnd [] diff --git a/test_resources/docs/args/config.txt b/test_resources/docs/args/config.txt deleted file mode 100644 --- a/test_resources/docs/args/config.txt +++ /dev/null diff --git a/test_resources/docs/args/docs.txt b/test_resources/docs/args/docs.txt deleted file mode 100644 --- a/test_resources/docs/args/docs.txt +++ /dev/null @@ -1,12 +0,0 @@ -AnyDocsSingle - SetDoc - { setDocTryArgument = True - , setDocTrySwitch = False - , setDocTryOption = False - , setDocDasheds = [] - , setDocEnvVars = Nothing - , setDocConfKeys = Nothing - , setDocDefault = Nothing - , setDocMetavar = Just "ARGUMENT" - , setDocHelp = Just "Argument" - } diff --git a/test_resources/docs/args/env-docs.txt b/test_resources/docs/args/env-docs.txt deleted file mode 100644 --- a/test_resources/docs/args/env-docs.txt +++ /dev/null @@ -1,1 +0,0 @@ -AnyDocsAnd [] diff --git a/test_resources/docs/args/env.txt b/test_resources/docs/args/env.txt deleted file mode 100644 --- a/test_resources/docs/args/env.txt +++ /dev/null diff --git a/test_resources/docs/args/help.txt b/test_resources/docs/args/help.txt deleted file mode 100644 --- a/test_resources/docs/args/help.txt +++ /dev/null @@ -1,15 +0,0 @@ -Usage: args (-h|--help) | --version | ARGUMENT - -args parser - -Available settings: - Show this help text - switch: -h|--help - - Output version information: 0.0.0 - switch: --version - - Argument - argument: ARGUMENT - - diff --git a/test_resources/docs/args/man.txt b/test_resources/docs/args/man.txt deleted file mode 100644 --- a/test_resources/docs/args/man.txt +++ /dev/null @@ -1,26 +0,0 @@ -.Dd $Mdocdate$ -.Dt args 1 -.Os -.Sh NAME -.Nm args -.Nd args parser -.Sh VERSION -0.0.0 -.Sh SYNOPSIS -args (-h|--help) | --version | ARGUMENT -.Sh SETTINGS - Show this help text - switch: -h|--help - - Output version information: 0.0.0 - switch: --version - - Argument - argument: ARGUMENT - - -.Sh OPTIONS - -h|--help Show this help text - --version Output version information: 0.0.0 - ARGUMENT Argument - diff --git a/test_resources/docs/args/opt-docs.txt b/test_resources/docs/args/opt-docs.txt deleted file mode 100644 --- a/test_resources/docs/args/opt-docs.txt +++ /dev/null @@ -1,10 +0,0 @@ -AnyDocsSingle - OptDoc - { optDocTryArgument = True - , optDocTrySwitch = False - , optDocTryOption = False - , optDocDasheds = [] - , optDocDefault = Nothing - , optDocMetavar = Just "ARGUMENT" - , optDocHelp = Just "Argument" - } diff --git a/test_resources/docs/args/opt-long.txt b/test_resources/docs/args/opt-long.txt deleted file mode 100644 --- a/test_resources/docs/args/opt-long.txt +++ /dev/null @@ -1,3 +0,0 @@ - -h|--help Show this help text - --version Output version information: 0.0.0 - ARGUMENT Argument diff --git a/test_resources/docs/args/opt-short.txt b/test_resources/docs/args/opt-short.txt deleted file mode 100644 --- a/test_resources/docs/args/opt-short.txt +++ /dev/null @@ -1,1 +0,0 @@ -args (-h|--help) | --version | ARGUMENT diff --git a/test_resources/docs/args/reference.txt b/test_resources/docs/args/reference.txt deleted file mode 100644 --- a/test_resources/docs/args/reference.txt +++ /dev/null @@ -1,18 +0,0 @@ -Usage: args (-h|--help) | --version | ARGUMENT - -All settings: - Show this help text - switch: -h|--help - - Output version information: 0.0.0 - switch: --version - - Argument - argument: ARGUMENT - - -Options: - -h|--help Show this help text - --version Output version information: 0.0.0 - ARGUMENT Argument - diff --git a/test_resources/docs/args/show.txt b/test_resources/docs/args/show.txt deleted file mode 100644 --- a/test_resources/docs/args/show.txt +++ /dev/null @@ -1,18 +0,0 @@ -Check - Nothing - True - _ - (Many - (Setting - Nothing - (Setting - [] - [ _ ] - True - Nothing - False - Nothing - Nothing - Nothing - (Just "ARGUMENT") - (Just "Argument")))) diff --git a/test_resources/docs/args/version.txt b/test_resources/docs/args/version.txt deleted file mode 100644 --- a/test_resources/docs/args/version.txt +++ /dev/null @@ -1,1 +0,0 @@ -args 0.0.0 diff --git a/test_resources/docs/big-config/config-docs.txt b/test_resources/docs/big-config/config-docs.txt --- a/test_resources/docs/big-config/config-docs.txt +++ b/test_resources/docs/big-config/config-docs.txt @@ -1,7 +1,10 @@ -AnyDocsSingle - EnvDoc - { envDocVars = "CONFIG_FILE" :| [] - , envDocDefault = Nothing - , envDocMetavar = Just "FILE_PATH" - , envDocHelp = Just "Path to the configuration file" - } +AnyDocsOr + [ AnyDocsSingle + EnvDoc + { envDocVars = "CONFIG_FILE" :| [] + , envDocDefault = Nothing + , envDocExamples = [] + , envDocMetavar = Just "FILE_PATH" + , envDocHelp = Just "Path to the configuration file" + } + ] diff --git a/test_resources/docs/big-config/config.txt b/test_resources/docs/big-config/config.txt --- a/test_resources/docs/big-config/config.txt +++ b/test_resources/docs/big-config/config.txt @@ -1,6 +1,10 @@ - multi-line config codec explanation, the same option twice. + big configuration object big: # or null - : + # BigConfig + map: # required : -  # 64 bit signed integer + : +  # 64 bit signed integer + sub: # optional +  diff --git a/test_resources/docs/big-config/docs.txt b/test_resources/docs/big-config/docs.txt --- a/test_resources/docs/big-config/docs.txt +++ b/test_resources/docs/big-config/docs.txt @@ -1,42 +1,58 @@ AnyDocsAnd - [ AnyDocsSingle - SetDoc - { setDocTryArgument = False - , setDocTrySwitch = False - , setDocTryOption = True - , setDocDasheds = [ DashedLong ('c' :| "onfig-file") ] - , setDocEnvVars = Just ("CONFIG_FILE" :| []) - , setDocConfKeys = Nothing - , setDocDefault = Nothing - , setDocMetavar = Just "FILE_PATH" - , setDocHelp = Just "Path to the configuration file" - } + [ AnyDocsOr + [ AnyDocsSingle + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = False + , setDocTryOption = True + , setDocDasheds = [ DashedLong ('c' :| "onfig-file") ] + , setDocEnvVars = Just ("CONFIG_FILE" :| []) + , setDocConfKeys = Nothing + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Just "FILE_PATH" + , setDocHelp = Just "Path to the configuration file" + }) + , AnyDocsSingle Nothing + ] , AnyDocsSingle - SetDoc - { setDocTryArgument = False - , setDocTrySwitch = False - , setDocTryOption = False - , setDocDasheds = [] - , setDocEnvVars = Nothing - , setDocConfKeys = - Just - (( "big" :| [] - , AnyOfSchema - (NullSchema :| - [ MapSchema - (MapSchema - (NumberSchema - (Just - NumberBounds - { numberBoundsLower = -9.223372036854775808e18 - , numberBoundsUpper = 9.223372036854775807e18 - }))) - ]) - ) :| - []) - , setDocDefault = Nothing - , setDocMetavar = Nothing - , setDocHelp = - Just "multi-line config codec explanation, the same option twice." - } + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = False + , setDocTryOption = False + , setDocDasheds = [] + , setDocEnvVars = Nothing + , setDocConfKeys = + Just + (( "big" :| [] + , AnyOfSchema + (NullSchema :| + [ CommentSchema + "BigConfig" + (ObjectSchema + (ObjectAllOfSchema + (ObjectKeySchema + "map" + Required + (MapSchema + (MapSchema + (IntegerSchema + Bounds + { boundsLower = Just (-9223372036854775808) + , boundsUpper = Just 9223372036854775807 + }))) + Nothing :| + [ ObjectKeySchema + "sub" (Optional Nothing) StringSchema Nothing + ]))) + ]) + ) :| + []) + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Nothing + , setDocHelp = Just "big configuration object" + }) ] diff --git a/test_resources/docs/big-config/env-docs.txt b/test_resources/docs/big-config/env-docs.txt --- a/test_resources/docs/big-config/env-docs.txt +++ b/test_resources/docs/big-config/env-docs.txt @@ -1,21 +1,33 @@ -AnyDocsSingle - ConfDoc - { confDocKeys = - ( "big" :| [] - , AnyOfSchema - (NullSchema :| - [ MapSchema - (MapSchema - (NumberSchema - (Just - NumberBounds - { numberBoundsLower = -9.223372036854775808e18 - , numberBoundsUpper = 9.223372036854775807e18 - }))) - ]) - ) :| - [] - , confDocDefault = Nothing - , confDocHelp = - Just "multi-line config codec explanation, the same option twice." - } +AnyDocsAnd + [ AnyDocsOr [] + , AnyDocsSingle + ConfDoc + { confDocKeys = + ( "big" :| [] + , AnyOfSchema + (NullSchema :| + [ CommentSchema + "BigConfig" + (ObjectSchema + (ObjectAllOfSchema + (ObjectKeySchema + "map" + Required + (MapSchema + (MapSchema + (IntegerSchema + Bounds + { boundsLower = Just (-9223372036854775808) + , boundsUpper = Just 9223372036854775807 + }))) + Nothing :| + [ ObjectKeySchema "sub" (Optional Nothing) StringSchema Nothing + ]))) + ]) + ) :| + [] + , confDocDefault = Nothing + , confDocExamples = [] + , confDocHelp = Just "big configuration object" + } + ] diff --git a/test_resources/docs/big-config/help.txt b/test_resources/docs/big-config/help.txt --- a/test_resources/docs/big-config/help.txt +++ b/test_resources/docs/big-config/help.txt @@ -1,4 +1,4 @@ -Usage: big-config (-h|--help) | --version | (--config-file FILE_PATH) +Usage: big-config [--config-file FILE_PATH] example with a big configuration @@ -12,12 +12,15 @@ Path to the configuration file option: --config-file FILE_PATH env: CONFIG_FILE FILE_PATH - - multi-line config codec explanation, the same option twice. + + big configuration object config: big: # or null - : + # BigConfig + map: # required : -  # 64 bit signed integer - + : +  # 64 bit signed integer + sub: # optional +  diff --git a/test_resources/docs/big-config/man.txt b/test_resources/docs/big-config/man.txt --- a/test_resources/docs/big-config/man.txt +++ b/test_resources/docs/big-config/man.txt @@ -7,7 +7,7 @@ .Sh VERSION 0.0.0 .Sh SYNOPSIS -big-config (-h|--help) | --version | (--config-file FILE_PATH) +big-config [--config-file FILE_PATH] .Sh SETTINGS Show this help text switch: -h|--help @@ -18,28 +18,35 @@ Path to the configuration file option: --config-file FILE_PATH env: CONFIG_FILE FILE_PATH - - multi-line config codec explanation, the same option twice. + + big configuration object config: big: # or null - : + # BigConfig + map: # required : - # 64 bit signed integer - + : + # 64 bit signed integer + sub: # optional + .Sh OPTIONS - -h|--help Show this help text - --version Output version information: 0.0.0 - --config-file Path to the configuration file + -h|--help Show this help text + --version Output version information: 0.0.0 + --config-file Path to the configuration file .Sh ENVIRONMENT VARIABLES CONFIG_FILE FILE_PATH Path to the configuration file .Sh CONFIGURATION VALUES - multi-line config codec explanation, the same option twice. + big configuration object big: # or null - : + # BigConfig + map: # required : - # 64 bit signed integer + : + # 64 bit signed integer + sub: # optional + diff --git a/test_resources/docs/big-config/nix-options.nix b/test_resources/docs/big-config/nix-options.nix new file mode 100644 --- /dev/null +++ b/test_resources/docs/big-config/nix-options.nix @@ -0,0 +1,18 @@ +{ lib }: +{ + big = lib.mkOption { + default = null; + description = "big configuration object"; + type = lib.types.nullOr (lib.types.submodule { + options = { + map = lib.mkOption { + type = lib.types.attrsOf (lib.types.attrsOf lib.types.int); + }; + sub = lib.mkOption { + default = null; + type = lib.types.nullOr lib.types.str; + }; + }; + }); + }; +} diff --git a/test_resources/docs/big-config/opt-docs.txt b/test_resources/docs/big-config/opt-docs.txt --- a/test_resources/docs/big-config/opt-docs.txt +++ b/test_resources/docs/big-config/opt-docs.txt @@ -1,10 +1,17 @@ -AnyDocsSingle - OptDoc - { optDocTryArgument = False - , optDocTrySwitch = False - , optDocTryOption = True - , optDocDasheds = [ DashedLong ('c' :| "onfig-file") ] - , optDocDefault = Nothing - , optDocMetavar = Just "FILE_PATH" - , optDocHelp = Just "Path to the configuration file" - } +AnyDocsAnd + [ AnyDocsOr + [ AnyDocsSingle + (Just + OptDoc + { optDocTryArgument = False + , optDocTrySwitch = False + , optDocTryOption = True + , optDocDasheds = [ DashedLong ('c' :| "onfig-file") ] + , optDocDefault = Nothing + , optDocExamples = [] + , optDocMetavar = Just "FILE_PATH" + , optDocHelp = Just "Path to the configuration file" + }) + ] + , AnyDocsSingle Nothing + ] diff --git a/test_resources/docs/big-config/opt-long.txt b/test_resources/docs/big-config/opt-long.txt --- a/test_resources/docs/big-config/opt-long.txt +++ b/test_resources/docs/big-config/opt-long.txt @@ -1,3 +1,1 @@ - -h|--help Show this help text - --version Output version information: 0.0.0 - --config-file Path to the configuration file + --config-file Path to the configuration file diff --git a/test_resources/docs/big-config/opt-short.txt b/test_resources/docs/big-config/opt-short.txt --- a/test_resources/docs/big-config/opt-short.txt +++ b/test_resources/docs/big-config/opt-short.txt @@ -1,1 +1,1 @@ -big-config (-h|--help) | --version | (--config-file FILE_PATH) +big-config [--config-file FILE_PATH] diff --git a/test_resources/docs/big-config/reference.txt b/test_resources/docs/big-config/reference.txt --- a/test_resources/docs/big-config/reference.txt +++ b/test_resources/docs/big-config/reference.txt @@ -1,37 +1,44 @@ -Usage: big-config (-h|--help) | --version | (--config-file FILE_PATH) +Usage: big-config [--config-file FILE_PATH] All settings: Show this help text switch: -h|--help - Output version information: 0.0.0 + Output version information switch: --version Path to the configuration file option: --config-file FILE_PATH env: CONFIG_FILE FILE_PATH - - multi-line config codec explanation, the same option twice. + + big configuration object config: big: # or null - : + # BigConfig + map: # required : -  # 64 bit signed integer - + : +  # 64 bit signed integer + sub: # optional +  Options: - -h|--help Show this help text - --version Output version information: 0.0.0 - --config-file Path to the configuration file + -h|--help Show this help text + --version Output version information + --config-file Path to the configuration file Environment Variables: CONFIG_FILE FILE_PATH Path to the configuration file Configuration Values: - multi-line config codec explanation, the same option twice. + big configuration object big: # or null - : + # BigConfig + map: # required : -  # 64 bit signed integer + : +  # 64 bit signed integer + sub: # optional +  diff --git a/test_resources/docs/big-config/show.txt b/test_resources/docs/big-config/show.txt --- a/test_resources/docs/big-config/show.txt +++ b/test_resources/docs/big-config/show.txt @@ -1,5 +1,6 @@ WithConfig _ + Nothing (Check Nothing False @@ -23,42 +24,47 @@ (Just "FILE_PATH") (Just "Path to the configuration file")))) (Check Nothing False _ (Pure _)))) - (Check + (Setting Nothing - True - _ (Setting + [] + [] + False Nothing - (Setting - [] - [] - False - Nothing - False - Nothing - (Just - [ ( "big" :| [] - , BimapCodec - _ - _ - (EitherCodec - PossiblyJointUnion - NullCodec - (MapCodec - (MapCodec - (BimapCodec - _ - _ - (NumberCodec - Nothing - (Just - NumberBounds - { numberBoundsLower = -9.223372036854775808e18 - , numberBoundsUpper = 9.223372036854775807e18 - })))))) - ) - ]) - Nothing - Nothing - (Just - "multi-line config codec explanation, the same option twice.")))) + False + Nothing + (Just + (ConfigValSetting + ("big" :| []) + BimapCodec + _ + _ + (EitherCodec + PossiblyJointUnion + NullCodec + (ObjectOfCodec + (Just "BigConfig") + (ApCodec + (BimapCodec + _ + _ + (RequiredKeyCodec + "map" + Nothing + (MapCodec + (MapCodec + (BimapCodec + _ + _ + (IntegerCodec + Nothing + Bounds + { boundsLower = Just (-9223372036854775808) + , boundsUpper = Just 9223372036854775807 + })))))) + (BimapCodec + _ _ (OptionalKeyCodec "sub" Nothing (StringCodec Nothing)))))) :| + [])) + Nothing + Nothing + (Just "big configuration object"))) diff --git a/test_resources/docs/empty/docs.txt b/test_resources/docs/empty/docs.txt --- a/test_resources/docs/empty/docs.txt +++ b/test_resources/docs/empty/docs.txt @@ -1,1 +1,1 @@ -AnyDocsAnd [] +AnyDocsSingle Nothing diff --git a/test_resources/docs/empty/help.txt b/test_resources/docs/empty/help.txt --- a/test_resources/docs/empty/help.txt +++ b/test_resources/docs/empty/help.txt @@ -1,4 +1,4 @@ -Usage: empty (-h|--help) | --version +Usage: empty empty parser @@ -8,5 +8,4 @@ Output version information: 0.0.0 switch: --version - diff --git a/test_resources/docs/empty/man.txt b/test_resources/docs/empty/man.txt --- a/test_resources/docs/empty/man.txt +++ b/test_resources/docs/empty/man.txt @@ -7,16 +7,15 @@ .Sh VERSION 0.0.0 .Sh SYNOPSIS -empty (-h|--help) | --version +empty .Sh SETTINGS Show this help text switch: -h|--help Output version information: 0.0.0 switch: --version - .Sh OPTIONS - -h|--help Show this help text - --version Output version information: 0.0.0 + -h|--help Show this help text + --version Output version information: 0.0.0 diff --git a/test_resources/docs/empty/nix-options.nix b/test_resources/docs/empty/nix-options.nix new file mode 100644 --- /dev/null +++ b/test_resources/docs/empty/nix-options.nix @@ -0,0 +1,2 @@ +{ lib }: +{ } diff --git a/test_resources/docs/empty/opt-long.txt b/test_resources/docs/empty/opt-long.txt --- a/test_resources/docs/empty/opt-long.txt +++ b/test_resources/docs/empty/opt-long.txt @@ -1,2 +0,0 @@ - -h|--help Show this help text - --version Output version information: 0.0.0 diff --git a/test_resources/docs/empty/opt-short.txt b/test_resources/docs/empty/opt-short.txt --- a/test_resources/docs/empty/opt-short.txt +++ b/test_resources/docs/empty/opt-short.txt @@ -1,1 +1,1 @@ -empty (-h|--help) | --version +empty diff --git a/test_resources/docs/empty/reference.txt b/test_resources/docs/empty/reference.txt --- a/test_resources/docs/empty/reference.txt +++ b/test_resources/docs/empty/reference.txt @@ -1,14 +1,13 @@ -Usage: empty (-h|--help) | --version +Usage: empty All settings: Show this help text switch: -h|--help - Output version information: 0.0.0 + Output version information switch: --version - Options: - -h|--help Show this help text - --version Output version information: 0.0.0 + -h|--help Show this help text + --version Output version information diff --git a/test_resources/docs/enable-disable-optional/config-docs.txt b/test_resources/docs/enable-disable-optional/config-docs.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/enable-disable-optional/config-docs.txt @@ -0,0 +1,10 @@ +AnyDocsOr + [ AnyDocsSingle + EnvDoc + { envDocVars = "EXAMPLE" :| [] + , envDocDefault = Nothing + , envDocExamples = [] + , envDocMetavar = Just "BOOL" + , envDocHelp = Just "Example of an enable/disable switch" + } + ] diff --git a/test_resources/docs/enable-disable-optional/config.txt b/test_resources/docs/enable-disable-optional/config.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/enable-disable-optional/config.txt @@ -0,0 +1,4 @@ + Example of an enable/disable switch + example: + # or null +  diff --git a/test_resources/docs/enable-disable-optional/docs.txt b/test_resources/docs/enable-disable-optional/docs.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/enable-disable-optional/docs.txt @@ -0,0 +1,55 @@ +AnyDocsAnd + [ AnyDocsSingle Nothing + , AnyDocsOr + [ AnyDocsSingle + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = True + , setDocTryOption = False + , setDocDasheds = [ DashedLong ('(' :| "enable|disable)-example") ] + , setDocEnvVars = Nothing + , setDocConfKeys = Nothing + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Nothing + , setDocHelp = Just "Example of an enable/disable switch" + }) + , AnyDocsSingle Nothing + , AnyDocsSingle Nothing + , AnyDocsSingle + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = False + , setDocTryOption = False + , setDocDasheds = [] + , setDocEnvVars = Just ("EXAMPLE" :| []) + , setDocConfKeys = Nothing + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Just "BOOL" + , setDocHelp = Just "Example of an enable/disable switch" + }) + , AnyDocsSingle + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = False + , setDocTryOption = False + , setDocDasheds = [] + , setDocEnvVars = Nothing + , setDocConfKeys = + Just + (( "example" :| [] + , AnyOfSchema (NullSchema :| [ BoolSchema ]) + ) :| + []) + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Nothing + , setDocHelp = Just "Example of an enable/disable switch" + }) + , AnyDocsSingle Nothing + ] + ] diff --git a/test_resources/docs/enable-disable-optional/env-docs.txt b/test_resources/docs/enable-disable-optional/env-docs.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/enable-disable-optional/env-docs.txt @@ -0,0 +1,11 @@ +AnyDocsOr + [ AnyDocsSingle + ConfDoc + { confDocKeys = + ( "example" :| [] , AnyOfSchema (NullSchema :| [ BoolSchema ]) ) :| + [] + , confDocDefault = Nothing + , confDocExamples = [] + , confDocHelp = Just "Example of an enable/disable switch" + } + ] diff --git a/test_resources/docs/enable-disable-optional/env.txt b/test_resources/docs/enable-disable-optional/env.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/enable-disable-optional/env.txt @@ -0,0 +1,1 @@ + EXAMPLE BOOL Example of an enable/disable switch diff --git a/test_resources/docs/enable-disable-optional/help.txt b/test_resources/docs/enable-disable-optional/help.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/enable-disable-optional/help.txt @@ -0,0 +1,18 @@ +Usage: enable-disable-optional [--(enable|disable)-example] + +enableDisableSwitch' example + +Available settings: + Show this help text + switch: -h|--help + + Output version information: 0.0.0 + switch: --version + + Example of an enable/disable switch + switch: --(enable|disable)-example + env: EXAMPLE BOOL + config: + example: # or null +  + diff --git a/test_resources/docs/enable-disable-optional/man.txt b/test_resources/docs/enable-disable-optional/man.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/enable-disable-optional/man.txt @@ -0,0 +1,38 @@ +.Dd $Mdocdate$ +.Dt enable-disable-optional 1 +.Os +.Sh NAME +.Nm enable-disable-optional +.Nd enableDisableSwitch' example +.Sh VERSION +0.0.0 +.Sh SYNOPSIS +enable-disable-optional [--(enable|disable)-example] +.Sh SETTINGS + Show this help text + switch: -h|--help + + Output version information: 0.0.0 + switch: --version + + Example of an enable/disable switch + switch: --(enable|disable)-example + env: EXAMPLE BOOL + config: + example: # or null + + +.Sh OPTIONS + -h|--help Show this help text + --version Output version information: 0.0.0 + --(enable|disable)-example Example of an enable/disable switch + +.Sh ENVIRONMENT VARIABLES + EXAMPLE BOOL Example of an enable/disable switch + +.Sh CONFIGURATION VALUES + Example of an enable/disable switch + example: + # or null + + diff --git a/test_resources/docs/enable-disable-optional/nix-options.nix b/test_resources/docs/enable-disable-optional/nix-options.nix new file mode 100644 --- /dev/null +++ b/test_resources/docs/enable-disable-optional/nix-options.nix @@ -0,0 +1,8 @@ +{ lib }: +{ + example = lib.mkOption { + default = null; + description = "Example of an enable/disable switch"; + type = lib.types.nullOr lib.types.bool; + }; +} diff --git a/test_resources/docs/enable-disable-optional/opt-docs.txt b/test_resources/docs/enable-disable-optional/opt-docs.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/enable-disable-optional/opt-docs.txt @@ -0,0 +1,16 @@ +AnyDocsOr + [ AnyDocsSingle + (Just + OptDoc + { optDocTryArgument = False + , optDocTrySwitch = True + , optDocTryOption = False + , optDocDasheds = [ DashedLong ('(' :| "enable|disable)-example") ] + , optDocDefault = Nothing + , optDocExamples = [] + , optDocMetavar = Nothing + , optDocHelp = Just "Example of an enable/disable switch" + }) + , AnyDocsSingle Nothing + , AnyDocsSingle Nothing + ] diff --git a/test_resources/docs/enable-disable-optional/opt-long.txt b/test_resources/docs/enable-disable-optional/opt-long.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/enable-disable-optional/opt-long.txt @@ -0,0 +1,1 @@ + --(enable|disable)-example Example of an enable/disable switch diff --git a/test_resources/docs/enable-disable-optional/opt-short.txt b/test_resources/docs/enable-disable-optional/opt-short.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/enable-disable-optional/opt-short.txt @@ -0,0 +1,1 @@ +enable-disable-optional [--(enable|disable)-example] diff --git a/test_resources/docs/enable-disable-optional/reference.txt b/test_resources/docs/enable-disable-optional/reference.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/enable-disable-optional/reference.txt @@ -0,0 +1,30 @@ +Usage: enable-disable-optional [--(enable|disable)-example] + +All settings: + Show this help text + switch: -h|--help + + Output version information + switch: --version + + Example of an enable/disable switch + switch: --(enable|disable)-example + env: EXAMPLE BOOL + config: + example: # or null +  + +Options: + -h|--help Show this help text + --version Output version information + --(enable|disable)-example Example of an enable/disable switch + +Environment Variables: + EXAMPLE BOOL Example of an enable/disable switch + +Configuration Values: + Example of an enable/disable switch + example: + # or null +  + diff --git a/test_resources/docs/enable-disable-optional/show.txt b/test_resources/docs/enable-disable-optional/show.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/enable-disable-optional/show.txt @@ -0,0 +1,102 @@ +WithConfig + _ + Nothing + (Pure _) + (Alt + (Alt + (Check + Nothing + True + _ + (Setting + Nothing + (Setting + [ DashedLong ('(' :| "enable|disable)-example") ] + [] + False + (Just _) + False + Nothing + Nothing + Nothing + Nothing + (Just "Example of an enable/disable switch")))) + (Alt + (Check + Nothing + True + _ + (Setting + Nothing + (Setting + [ DashedLong ('d' :| "isable-example") ] + [] + False + (Just _) + False + Nothing + Nothing + Nothing + Nothing + Nothing))) + (Alt + (Check + Nothing + True + _ + (Setting + Nothing + (Setting + [ DashedLong ('e' :| "nable-example") ] + [] + False + (Just _) + False + Nothing + Nothing + Nothing + Nothing + Nothing))) + (Alt + (Check + Nothing + True + _ + (Setting + Nothing + (Setting + [] + [ _ ] + False + Nothing + False + (Just ("EXAMPLE" :| [])) + Nothing + Nothing + (Just "BOOL") + (Just "Example of an enable/disable switch")))) + (Check + Nothing + True + _ + (Setting + Nothing + (Setting + [] + [] + False + Nothing + False + Nothing + (Just + (ConfigValSetting + ("example" :| []) + BimapCodec + _ + _ + (EitherCodec PossiblyJointUnion NullCodec (BoolCodec Nothing)) :| + [])) + Nothing + Nothing + (Just "Example of an enable/disable switch")))))))) + (Pure _)) diff --git a/test_resources/docs/enable-disable-optional/version.txt b/test_resources/docs/enable-disable-optional/version.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/enable-disable-optional/version.txt @@ -0,0 +1,1 @@ +enable-disable-optional 0.0.0 diff --git a/test_resources/docs/enable-disable/config-docs.txt b/test_resources/docs/enable-disable/config-docs.txt --- a/test_resources/docs/enable-disable/config-docs.txt +++ b/test_resources/docs/enable-disable/config-docs.txt @@ -1,15 +1,9 @@ -AnyDocsAnd +AnyDocsOr [ AnyDocsSingle EnvDoc - { envDocVars = "CONFIG_FILE" :| [] - , envDocDefault = Nothing - , envDocMetavar = Just "FILE_PATH" - , envDocHelp = Just "Path to the configuration file" - } - , AnyDocsSingle - EnvDoc { envDocVars = "EXAMPLE" :| [] , envDocDefault = Nothing + , envDocExamples = [] , envDocMetavar = Just "BOOL" , envDocHelp = Just "Example of an enable/disable switch" } diff --git a/test_resources/docs/enable-disable/docs.txt b/test_resources/docs/enable-disable/docs.txt --- a/test_resources/docs/enable-disable/docs.txt +++ b/test_resources/docs/enable-disable/docs.txt @@ -1,57 +1,55 @@ AnyDocsAnd - [ AnyDocsSingle - SetDoc - { setDocTryArgument = False - , setDocTrySwitch = False - , setDocTryOption = True - , setDocDasheds = [ DashedLong ('c' :| "onfig-file") ] - , setDocEnvVars = Just ("CONFIG_FILE" :| []) - , setDocConfKeys = Nothing - , setDocDefault = Nothing - , setDocMetavar = Just "FILE_PATH" - , setDocHelp = Just "Path to the configuration file" - } + [ AnyDocsSingle Nothing , AnyDocsOr [ AnyDocsSingle - SetDoc - { setDocTryArgument = False - , setDocTrySwitch = True - , setDocTryOption = False - , setDocDasheds = [ DashedLong ('(' :| "enable|disable)-example") ] - , setDocEnvVars = Nothing - , setDocConfKeys = Nothing - , setDocDefault = Nothing - , setDocMetavar = Nothing - , setDocHelp = Just "Example of an enable/disable switch" - } + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = True + , setDocTryOption = False + , setDocDasheds = [ DashedLong ('(' :| "enable|disable)-example") ] + , setDocEnvVars = Nothing + , setDocConfKeys = Nothing + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Nothing + , setDocHelp = Just "Example of an enable/disable switch" + }) + , AnyDocsSingle Nothing + , AnyDocsSingle Nothing , AnyDocsSingle - SetDoc - { setDocTryArgument = False - , setDocTrySwitch = False - , setDocTryOption = False - , setDocDasheds = [] - , setDocEnvVars = Just ("EXAMPLE" :| []) - , setDocConfKeys = Nothing - , setDocDefault = Nothing - , setDocMetavar = Just "BOOL" - , setDocHelp = Just "Example of an enable/disable switch" - } + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = False + , setDocTryOption = False + , setDocDasheds = [] + , setDocEnvVars = Just ("EXAMPLE" :| []) + , setDocConfKeys = Nothing + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Just "BOOL" + , setDocHelp = Just "Example of an enable/disable switch" + }) , AnyDocsSingle - SetDoc - { setDocTryArgument = False - , setDocTrySwitch = False - , setDocTryOption = False - , setDocDasheds = [] - , setDocEnvVars = Nothing - , setDocConfKeys = - Just - (( "example" :| [] - , AnyOfSchema (NullSchema :| [ BoolSchema ]) - ) :| - []) - , setDocDefault = Nothing - , setDocMetavar = Nothing - , setDocHelp = Just "Example of an enable/disable switch" - } + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = False + , setDocTryOption = False + , setDocDasheds = [] + , setDocEnvVars = Nothing + , setDocConfKeys = + Just + (( "example" :| [] + , AnyOfSchema (NullSchema :| [ BoolSchema ]) + ) :| + []) + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Nothing + , setDocHelp = Just "Example of an enable/disable switch" + }) + , AnyDocsSingle Nothing ] ] diff --git a/test_resources/docs/enable-disable/env-docs.txt b/test_resources/docs/enable-disable/env-docs.txt --- a/test_resources/docs/enable-disable/env-docs.txt +++ b/test_resources/docs/enable-disable/env-docs.txt @@ -1,8 +1,11 @@ -AnyDocsSingle - ConfDoc - { confDocKeys = - ( "example" :| [] , AnyOfSchema (NullSchema :| [ BoolSchema ]) ) :| - [] - , confDocDefault = Nothing - , confDocHelp = Just "Example of an enable/disable switch" - } +AnyDocsOr + [ AnyDocsSingle + ConfDoc + { confDocKeys = + ( "example" :| [] , AnyOfSchema (NullSchema :| [ BoolSchema ]) ) :| + [] + , confDocDefault = Nothing + , confDocExamples = [] + , confDocHelp = Just "Example of an enable/disable switch" + } + ] diff --git a/test_resources/docs/enable-disable/env.txt b/test_resources/docs/enable-disable/env.txt --- a/test_resources/docs/enable-disable/env.txt +++ b/test_resources/docs/enable-disable/env.txt @@ -1,2 +1,1 @@ - CONFIG_FILE FILE_PATH Path to the configuration file - EXAMPLE BOOL Example of an enable/disable switch + EXAMPLE BOOL Example of an enable/disable switch diff --git a/test_resources/docs/enable-disable/help.txt b/test_resources/docs/enable-disable/help.txt --- a/test_resources/docs/enable-disable/help.txt +++ b/test_resources/docs/enable-disable/help.txt @@ -1,4 +1,4 @@ -Usage: enable-disable (-h|--help) | --version | (--config-file FILE_PATH --(enable|disable)-example) +Usage: enable-disable [--(enable|disable)-example] enableDisableSwitch example @@ -9,15 +9,10 @@ Output version information: 0.0.0 switch: --version - Path to the configuration file - option: --config-file FILE_PATH - env: CONFIG_FILE FILE_PATH - Example of an enable/disable switch switch: --(enable|disable)-example env: EXAMPLE BOOL config: example: # or null  - diff --git a/test_resources/docs/enable-disable/man.txt b/test_resources/docs/enable-disable/man.txt --- a/test_resources/docs/enable-disable/man.txt +++ b/test_resources/docs/enable-disable/man.txt @@ -7,7 +7,7 @@ .Sh VERSION 0.0.0 .Sh SYNOPSIS -enable-disable (-h|--help) | --version | (--config-file FILE_PATH --(enable|disable)-example) +enable-disable [--(enable|disable)-example] .Sh SETTINGS Show this help text switch: -h|--help @@ -15,10 +15,6 @@ Output version information: 0.0.0 switch: --version - Path to the configuration file - option: --config-file FILE_PATH - env: CONFIG_FILE FILE_PATH - Example of an enable/disable switch switch: --(enable|disable)-example env: EXAMPLE BOOL @@ -26,16 +22,13 @@ example: # or null - .Sh OPTIONS - -h|--help Show this help text - --version Output version information: 0.0.0 - --config-file Path to the configuration file - --(enable|disable)-example Example of an enable/disable switch + -h|--help Show this help text + --version Output version information: 0.0.0 + --(enable|disable)-example Example of an enable/disable switch .Sh ENVIRONMENT VARIABLES - CONFIG_FILE FILE_PATH Path to the configuration file - EXAMPLE BOOL Example of an enable/disable switch + EXAMPLE BOOL Example of an enable/disable switch .Sh CONFIGURATION VALUES Example of an enable/disable switch diff --git a/test_resources/docs/enable-disable/nix-options.nix b/test_resources/docs/enable-disable/nix-options.nix new file mode 100644 --- /dev/null +++ b/test_resources/docs/enable-disable/nix-options.nix @@ -0,0 +1,8 @@ +{ lib }: +{ + example = lib.mkOption { + default = null; + description = "Example of an enable/disable switch"; + type = lib.types.nullOr lib.types.bool; + }; +} diff --git a/test_resources/docs/enable-disable/opt-docs.txt b/test_resources/docs/enable-disable/opt-docs.txt --- a/test_resources/docs/enable-disable/opt-docs.txt +++ b/test_resources/docs/enable-disable/opt-docs.txt @@ -1,22 +1,16 @@ -AnyDocsAnd +AnyDocsOr [ AnyDocsSingle - OptDoc - { optDocTryArgument = False - , optDocTrySwitch = False - , optDocTryOption = True - , optDocDasheds = [ DashedLong ('c' :| "onfig-file") ] - , optDocDefault = Nothing - , optDocMetavar = Just "FILE_PATH" - , optDocHelp = Just "Path to the configuration file" - } - , AnyDocsSingle - OptDoc - { optDocTryArgument = False - , optDocTrySwitch = True - , optDocTryOption = False - , optDocDasheds = [ DashedLong ('(' :| "enable|disable)-example") ] - , optDocDefault = Nothing - , optDocMetavar = Nothing - , optDocHelp = Just "Example of an enable/disable switch" - } + (Just + OptDoc + { optDocTryArgument = False + , optDocTrySwitch = True + , optDocTryOption = False + , optDocDasheds = [ DashedLong ('(' :| "enable|disable)-example") ] + , optDocDefault = Nothing + , optDocExamples = [] + , optDocMetavar = Nothing + , optDocHelp = Just "Example of an enable/disable switch" + }) + , AnyDocsSingle Nothing + , AnyDocsSingle Nothing ] diff --git a/test_resources/docs/enable-disable/opt-long.txt b/test_resources/docs/enable-disable/opt-long.txt --- a/test_resources/docs/enable-disable/opt-long.txt +++ b/test_resources/docs/enable-disable/opt-long.txt @@ -1,4 +1,1 @@ - -h|--help Show this help text - --version Output version information: 0.0.0 - --config-file Path to the configuration file - --(enable|disable)-example Example of an enable/disable switch + --(enable|disable)-example Example of an enable/disable switch diff --git a/test_resources/docs/enable-disable/opt-short.txt b/test_resources/docs/enable-disable/opt-short.txt --- a/test_resources/docs/enable-disable/opt-short.txt +++ b/test_resources/docs/enable-disable/opt-short.txt @@ -1,1 +1,1 @@ -enable-disable (-h|--help) | --version | (--config-file FILE_PATH --(enable|disable)-example) +enable-disable [--(enable|disable)-example] diff --git a/test_resources/docs/enable-disable/reference.txt b/test_resources/docs/enable-disable/reference.txt --- a/test_resources/docs/enable-disable/reference.txt +++ b/test_resources/docs/enable-disable/reference.txt @@ -1,16 +1,12 @@ -Usage: enable-disable (-h|--help) | --version | (--config-file FILE_PATH --(enable|disable)-example) +Usage: enable-disable [--(enable|disable)-example] All settings: Show this help text switch: -h|--help - Output version information: 0.0.0 + Output version information switch: --version - Path to the configuration file - option: --config-file FILE_PATH - env: CONFIG_FILE FILE_PATH - Example of an enable/disable switch switch: --(enable|disable)-example env: EXAMPLE BOOL @@ -18,16 +14,13 @@ example: # or null  - Options: - -h|--help Show this help text - --version Output version information: 0.0.0 - --config-file Path to the configuration file - --(enable|disable)-example Example of an enable/disable switch + -h|--help Show this help text + --version Output version information + --(enable|disable)-example Example of an enable/disable switch Environment Variables: - CONFIG_FILE FILE_PATH Path to the configuration file - EXAMPLE BOOL Example of an enable/disable switch + EXAMPLE BOOL Example of an enable/disable switch Configuration Values: Example of an enable/disable switch diff --git a/test_resources/docs/enable-disable/show.txt b/test_resources/docs/enable-disable/show.txt --- a/test_resources/docs/enable-disable/show.txt +++ b/test_resources/docs/enable-disable/show.txt @@ -1,28 +1,7 @@ WithConfig _ - (Check - Nothing - False - _ - (Alt - (Check - Nothing - False - _ - (Setting - Nothing - (Setting - [ DashedLong ('c' :| "onfig-file") ] - [ _ ] - False - Nothing - True - (Just ("CONFIG_FILE" :| [])) - Nothing - Nothing - (Just "FILE_PATH") - (Just "Path to the configuration file")))) - (Check Nothing False _ (Pure _)))) + Nothing + (Pure _) (Alt (Check Nothing @@ -110,13 +89,13 @@ False Nothing (Just - [ ( "example" :| [] - , BimapCodec - _ - _ - (EitherCodec PossiblyJointUnion NullCodec (BoolCodec Nothing)) - ) - ]) + (ConfigValSetting + ("example" :| []) + BimapCodec + _ + _ + (EitherCodec PossiblyJointUnion NullCodec (BoolCodec Nothing)) :| + [])) Nothing Nothing (Just "Example of an enable/disable switch")))) diff --git a/test_resources/docs/greet/config-docs.txt b/test_resources/docs/greet/config-docs.txt --- a/test_resources/docs/greet/config-docs.txt +++ b/test_resources/docs/greet/config-docs.txt @@ -1,15 +1,19 @@ AnyDocsAnd - [ AnyDocsSingle - EnvDoc - { envDocVars = "GREET_CONFIG_FILE" :| [] - , envDocDefault = Nothing - , envDocMetavar = Just "FILE_PATH" - , envDocHelp = Just "Path to the configuration file" - } + [ AnyDocsOr + [ AnyDocsSingle + EnvDoc + { envDocVars = "GREET_CONFIG_FILE" :| [] + , envDocDefault = Nothing + , envDocExamples = [] + , envDocMetavar = Just "FILE_PATH" + , envDocHelp = Just "Path to the configuration file" + } + ] , AnyDocsSingle EnvDoc { envDocVars = "GREET_GREETING" :| [] , envDocDefault = Just "\"Hello\"" + , envDocExamples = [ "Greetings" ] , envDocMetavar = Just "GREETING" , envDocHelp = Just "Greeting to use" } @@ -17,6 +21,7 @@ EnvDoc { envDocVars = "GREET_POLITE" :| [] , envDocDefault = Just "False" + , envDocExamples = [] , envDocMetavar = Just "ANY" , envDocHelp = Just "Whether to be polite" } diff --git a/test_resources/docs/greet/config.txt b/test_resources/docs/greet/config.txt --- a/test_resources/docs/greet/config.txt +++ b/test_resources/docs/greet/config.txt @@ -1,8 +1,11 @@ Greeting to use + default: "Hello" + example: Greetings greeting: # or null  Whether to be polite + default: False polite: # or null  diff --git a/test_resources/docs/greet/docs.txt b/test_resources/docs/greet/docs.txt --- a/test_resources/docs/greet/docs.txt +++ b/test_resources/docs/greet/docs.txt @@ -1,59 +1,70 @@ AnyDocsAnd - [ AnyDocsSingle - SetDoc - { setDocTryArgument = False - , setDocTrySwitch = False - , setDocTryOption = True - , setDocDasheds = [ DashedLong ('c' :| "onfig-file") ] - , setDocEnvVars = Just ("GREET_CONFIG_FILE" :| []) - , setDocConfKeys = Nothing - , setDocDefault = Nothing - , setDocMetavar = Just "FILE_PATH" - , setDocHelp = Just "Path to the configuration file" - } + [ AnyDocsOr + [ AnyDocsSingle + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = False + , setDocTryOption = True + , setDocDasheds = [ DashedLong ('c' :| "onfig-file") ] + , setDocEnvVars = Just ("GREET_CONFIG_FILE" :| []) + , setDocConfKeys = Nothing + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Just "FILE_PATH" + , setDocHelp = Just "Path to the configuration file" + }) + , AnyDocsSingle Nothing + ] , AnyDocsSingle - SetDoc - { setDocTryArgument = False - , setDocTrySwitch = False - , setDocTryOption = True - , setDocDasheds = - [ DashedShort 'g' , DashedLong ('g' :| "reeting") ] - , setDocEnvVars = Just ("GREET_GREETING" :| []) - , setDocConfKeys = - Just - (( "greeting" :| [] - , AnyOfSchema (NullSchema :| [ StringSchema ]) - ) :| - []) - , setDocDefault = Just "\"Hello\"" - , setDocMetavar = Just "GREETING" - , setDocHelp = Just "Greeting to use" - } + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = False + , setDocTryOption = True + , setDocDasheds = + [ DashedShort 'g' , DashedLong ('g' :| "reeting") ] + , setDocEnvVars = Just ("GREET_GREETING" :| []) + , setDocConfKeys = + Just + (( "greeting" :| [] + , AnyOfSchema (NullSchema :| [ StringSchema ]) + ) :| + []) + , setDocDefault = Just "\"Hello\"" + , setDocExamples = [ "Greetings" ] + , setDocMetavar = Just "GREETING" + , setDocHelp = Just "Greeting to use" + }) , AnyDocsSingle - SetDoc - { setDocTryArgument = True - , setDocTrySwitch = False - , setDocTryOption = False - , setDocDasheds = [] - , setDocEnvVars = Nothing - , setDocConfKeys = Nothing - , setDocDefault = Just "\"world\"" - , setDocMetavar = Just "SUBJECT" - , setDocHelp = Just "Who to greet" - } + (Just + SetDoc + { setDocTryArgument = True + , setDocTrySwitch = False + , setDocTryOption = False + , setDocDasheds = [] + , setDocEnvVars = Nothing + , setDocConfKeys = Nothing + , setDocDefault = Just "\"world\"" + , setDocExamples = [] + , setDocMetavar = Just "SUBJECT" + , setDocHelp = Just "Who to greet" + }) , AnyDocsSingle - SetDoc - { setDocTryArgument = False - , setDocTrySwitch = True - , setDocTryOption = False - , setDocDasheds = [ DashedShort 'p' , DashedLong ('p' :| "olite") ] - , setDocEnvVars = Just ("GREET_POLITE" :| []) - , setDocConfKeys = - Just - (( "polite" :| [] , AnyOfSchema (NullSchema :| [ BoolSchema ]) ) :| - []) - , setDocDefault = Just "False" - , setDocMetavar = Just "ANY" - , setDocHelp = Just "Whether to be polite" - } + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = True + , setDocTryOption = False + , setDocDasheds = [ DashedShort 'p' , DashedLong ('p' :| "olite") ] + , setDocEnvVars = Just ("GREET_POLITE" :| []) + , setDocConfKeys = + Just + (( "polite" :| [] , AnyOfSchema (NullSchema :| [ BoolSchema ]) ) :| + []) + , setDocDefault = Just "False" + , setDocExamples = [] + , setDocMetavar = Just "ANY" + , setDocHelp = Just "Whether to be polite" + }) ] diff --git a/test_resources/docs/greet/env-docs.txt b/test_resources/docs/greet/env-docs.txt --- a/test_resources/docs/greet/env-docs.txt +++ b/test_resources/docs/greet/env-docs.txt @@ -1,5 +1,6 @@ AnyDocsAnd - [ AnyDocsSingle + [ AnyDocsOr [] + , AnyDocsSingle ConfDoc { confDocKeys = ( "greeting" :| [] @@ -7,6 +8,7 @@ ) :| [] , confDocDefault = Just "\"Hello\"" + , confDocExamples = [ "Greetings" ] , confDocHelp = Just "Greeting to use" } , AnyDocsSingle @@ -15,6 +17,7 @@ ( "polite" :| [] , AnyOfSchema (NullSchema :| [ BoolSchema ]) ) :| [] , confDocDefault = Just "False" + , confDocExamples = [] , confDocHelp = Just "Whether to be polite" } ] diff --git a/test_resources/docs/greet/env.txt b/test_resources/docs/greet/env.txt --- a/test_resources/docs/greet/env.txt +++ b/test_resources/docs/greet/env.txt @@ -1,3 +1,3 @@ - GREET_CONFIG_FILE FILE_PATH Path to the configuration file - GREET_GREETING GREETING Greeting to use - GREET_POLITE ANY Whether to be polite + GREET_CONFIG_FILE FILE_PATH Path to the configuration file + GREET_GREETING GREETING Greeting to use default: "Hello" example: Greetings + GREET_POLITE ANY Whether to be polite default: False diff --git a/test_resources/docs/greet/help.txt b/test_resources/docs/greet/help.txt --- a/test_resources/docs/greet/help.txt +++ b/test_resources/docs/greet/help.txt @@ -1,4 +1,4 @@ -Usage: greet (-h|--help) | --version | (--config-file FILE_PATH -g|--greeting GREETING SUBJECT -p|--polite) +Usage: greet [--config-file FILE_PATH] [-g|--greeting GREETING] [SUBJECT] [-p|--polite] hello world example @@ -12,22 +12,25 @@ Path to the configuration file option: --config-file FILE_PATH env: GREET_CONFIG_FILE FILE_PATH - + Greeting to use option: -g|--greeting GREETING env: GREET_GREETING GREETING config: greeting: # or null  - + default: "Hello" + example: Greetings + Who to greet argument: SUBJECT - + default: "world" + Whether to be polite switch: -p|--polite env: GREET_POLITE ANY config: polite: # or null  - + default: False diff --git a/test_resources/docs/greet/man.txt b/test_resources/docs/greet/man.txt --- a/test_resources/docs/greet/man.txt +++ b/test_resources/docs/greet/man.txt @@ -7,7 +7,7 @@ .Sh VERSION 0.0.0 .Sh SYNOPSIS -greet (-h|--help) | --version | (--config-file FILE_PATH -g|--greeting GREETING SUBJECT -p|--polite) +greet [--config-file FILE_PATH] [-g|--greeting GREETING] [SUBJECT] [-p|--polite] .Sh SETTINGS Show this help text switch: -h|--help @@ -18,44 +18,50 @@ Path to the configuration file option: --config-file FILE_PATH env: GREET_CONFIG_FILE FILE_PATH - + Greeting to use option: -g|--greeting GREETING env: GREET_GREETING GREETING config: greeting: # or null - + default: "Hello" + example: Greetings + Who to greet argument: SUBJECT - + default: "world" + Whether to be polite switch: -p|--polite env: GREET_POLITE ANY config: polite: # or null - + default: False .Sh OPTIONS - -h|--help Show this help text - --version Output version information: 0.0.0 - --config-file Path to the configuration file - -g|--greeting Greeting to use default: "Hello" - SUBJECT Who to greet default: "world" - -p|--polite Whether to be polite default: False + -h|--help Show this help text + --version Output version information: 0.0.0 + --config-file Path to the configuration file + -g|--greeting Greeting to use default: "Hello" example: Greetings + SUBJECT Who to greet default: "world" + -p|--polite Whether to be polite default: False .Sh ENVIRONMENT VARIABLES - GREET_CONFIG_FILE FILE_PATH Path to the configuration file - GREET_GREETING GREETING Greeting to use - GREET_POLITE ANY Whether to be polite + GREET_CONFIG_FILE FILE_PATH Path to the configuration file + GREET_GREETING GREETING Greeting to use default: "Hello" example: Greetings + GREET_POLITE ANY Whether to be polite default: False .Sh CONFIGURATION VALUES Greeting to use + default: "Hello" + example: Greetings greeting: # or null Whether to be polite + default: False polite: # or null diff --git a/test_resources/docs/greet/nix-options.nix b/test_resources/docs/greet/nix-options.nix new file mode 100644 --- /dev/null +++ b/test_resources/docs/greet/nix-options.nix @@ -0,0 +1,13 @@ +{ lib }: +{ + greeting = lib.mkOption { + default = null; + description = "Greeting to use"; + type = lib.types.nullOr lib.types.str; + }; + polite = lib.mkOption { + default = null; + description = "Whether to be polite"; + type = lib.types.nullOr lib.types.bool; + }; +} diff --git a/test_resources/docs/greet/opt-docs.txt b/test_resources/docs/greet/opt-docs.txt --- a/test_resources/docs/greet/opt-docs.txt +++ b/test_resources/docs/greet/opt-docs.txt @@ -1,43 +1,53 @@ AnyDocsAnd - [ AnyDocsSingle - OptDoc - { optDocTryArgument = False - , optDocTrySwitch = False - , optDocTryOption = True - , optDocDasheds = [ DashedLong ('c' :| "onfig-file") ] - , optDocDefault = Nothing - , optDocMetavar = Just "FILE_PATH" - , optDocHelp = Just "Path to the configuration file" - } + [ AnyDocsOr + [ AnyDocsSingle + (Just + OptDoc + { optDocTryArgument = False + , optDocTrySwitch = False + , optDocTryOption = True + , optDocDasheds = [ DashedLong ('c' :| "onfig-file") ] + , optDocDefault = Nothing + , optDocExamples = [] + , optDocMetavar = Just "FILE_PATH" + , optDocHelp = Just "Path to the configuration file" + }) + ] , AnyDocsSingle - OptDoc - { optDocTryArgument = False - , optDocTrySwitch = False - , optDocTryOption = True - , optDocDasheds = - [ DashedShort 'g' , DashedLong ('g' :| "reeting") ] - , optDocDefault = Just "\"Hello\"" - , optDocMetavar = Just "GREETING" - , optDocHelp = Just "Greeting to use" - } + (Just + OptDoc + { optDocTryArgument = False + , optDocTrySwitch = False + , optDocTryOption = True + , optDocDasheds = + [ DashedShort 'g' , DashedLong ('g' :| "reeting") ] + , optDocDefault = Just "\"Hello\"" + , optDocExamples = [ "Greetings" ] + , optDocMetavar = Just "GREETING" + , optDocHelp = Just "Greeting to use" + }) , AnyDocsSingle - OptDoc - { optDocTryArgument = True - , optDocTrySwitch = False - , optDocTryOption = False - , optDocDasheds = [] - , optDocDefault = Just "\"world\"" - , optDocMetavar = Just "SUBJECT" - , optDocHelp = Just "Who to greet" - } + (Just + OptDoc + { optDocTryArgument = True + , optDocTrySwitch = False + , optDocTryOption = False + , optDocDasheds = [] + , optDocDefault = Just "\"world\"" + , optDocExamples = [] + , optDocMetavar = Just "SUBJECT" + , optDocHelp = Just "Who to greet" + }) , AnyDocsSingle - OptDoc - { optDocTryArgument = False - , optDocTrySwitch = True - , optDocTryOption = False - , optDocDasheds = [ DashedShort 'p' , DashedLong ('p' :| "olite") ] - , optDocDefault = Just "False" - , optDocMetavar = Just "ANY" - , optDocHelp = Just "Whether to be polite" - } + (Just + OptDoc + { optDocTryArgument = False + , optDocTrySwitch = True + , optDocTryOption = False + , optDocDasheds = [ DashedShort 'p' , DashedLong ('p' :| "olite") ] + , optDocDefault = Just "False" + , optDocExamples = [] + , optDocMetavar = Just "ANY" + , optDocHelp = Just "Whether to be polite" + }) ] diff --git a/test_resources/docs/greet/opt-long.txt b/test_resources/docs/greet/opt-long.txt --- a/test_resources/docs/greet/opt-long.txt +++ b/test_resources/docs/greet/opt-long.txt @@ -1,6 +1,4 @@ - -h|--help Show this help text - --version Output version information: 0.0.0 - --config-file Path to the configuration file - -g|--greeting Greeting to use default: "Hello" - SUBJECT Who to greet default: "world" - -p|--polite Whether to be polite default: False + --config-file Path to the configuration file + -g|--greeting Greeting to use default: "Hello" example: Greetings + SUBJECT Who to greet default: "world" + -p|--polite Whether to be polite default: False diff --git a/test_resources/docs/greet/opt-short.txt b/test_resources/docs/greet/opt-short.txt --- a/test_resources/docs/greet/opt-short.txt +++ b/test_resources/docs/greet/opt-short.txt @@ -1,1 +1,1 @@ -greet (-h|--help) | --version | (--config-file FILE_PATH -g|--greeting GREETING SUBJECT -p|--polite) +greet [--config-file FILE_PATH] [-g|--greeting GREETING] [SUBJECT] [-p|--polite] diff --git a/test_resources/docs/greet/reference.txt b/test_resources/docs/greet/reference.txt --- a/test_resources/docs/greet/reference.txt +++ b/test_resources/docs/greet/reference.txt @@ -1,53 +1,59 @@ -Usage: greet (-h|--help) | --version | (--config-file FILE_PATH -g|--greeting GREETING SUBJECT -p|--polite) +Usage: greet [--config-file FILE_PATH] [-g|--greeting GREETING] [SUBJECT] [-p|--polite] All settings: Show this help text switch: -h|--help - Output version information: 0.0.0 + Output version information switch: --version Path to the configuration file option: --config-file FILE_PATH env: GREET_CONFIG_FILE FILE_PATH - + Greeting to use option: -g|--greeting GREETING env: GREET_GREETING GREETING config: greeting: # or null  - + default: "Hello" + example: Greetings + Who to greet argument: SUBJECT - + default: "world" + Whether to be polite switch: -p|--polite env: GREET_POLITE ANY config: polite: # or null  - + default: False Options: - -h|--help Show this help text - --version Output version information: 0.0.0 - --config-file Path to the configuration file - -g|--greeting Greeting to use default: "Hello" - SUBJECT Who to greet default: "world" - -p|--polite Whether to be polite default: False + -h|--help Show this help text + --version Output version information + --config-file Path to the configuration file + -g|--greeting Greeting to use default: "Hello" example: Greetings + SUBJECT Who to greet default: "world" + -p|--polite Whether to be polite default: False Environment Variables: - GREET_CONFIG_FILE FILE_PATH Path to the configuration file - GREET_GREETING GREETING Greeting to use - GREET_POLITE ANY Whether to be polite + GREET_CONFIG_FILE FILE_PATH Path to the configuration file + GREET_GREETING GREETING Greeting to use default: "Hello" example: Greetings + GREET_POLITE ANY Whether to be polite default: False Configuration Values: Greeting to use + default: "Hello" + example: Greetings greeting: # or null  Whether to be polite + default: False polite: # or null  diff --git a/test_resources/docs/greet/show.txt b/test_resources/docs/greet/show.txt --- a/test_resources/docs/greet/show.txt +++ b/test_resources/docs/greet/show.txt @@ -1,5 +1,6 @@ WithConfig _ + Nothing (Check Nothing False @@ -39,16 +40,16 @@ True (Just ("GREET_GREETING" :| [])) (Just - [ ( "greeting" :| [] - , BimapCodec - _ - _ - (EitherCodec - PossiblyJointUnion - NullCodec - (BimapCodec _ _ (StringCodec Nothing))) - ) - ]) + (ConfigValSetting + ("greeting" :| []) + BimapCodec + _ + _ + (EitherCodec + PossiblyJointUnion + NullCodec + (BimapCodec _ _ (StringCodec Nothing))) :| + [])) (Just _) (Just "GREETING") (Just "Greeting to use")))) @@ -75,11 +76,13 @@ False (Just ("GREET_POLITE" :| [])) (Just - [ ( "polite" :| [] - , BimapCodec - _ _ (EitherCodec PossiblyJointUnion NullCodec (BoolCodec Nothing)) - ) - ]) + (ConfigValSetting + ("polite" :| []) + BimapCodec + _ + _ + (EitherCodec PossiblyJointUnion NullCodec (BoolCodec Nothing)) :| + [])) (Just _) (Just "ANY") (Just "Whether to be polite")))) diff --git a/test_resources/docs/hidden/docs.txt b/test_resources/docs/hidden/docs.txt --- a/test_resources/docs/hidden/docs.txt +++ b/test_resources/docs/hidden/docs.txt @@ -1,1 +1,1 @@ -AnyDocsAnd [] +AnyDocsSingle Nothing diff --git a/test_resources/docs/hidden/help.txt b/test_resources/docs/hidden/help.txt --- a/test_resources/docs/hidden/help.txt +++ b/test_resources/docs/hidden/help.txt @@ -1,4 +1,4 @@ -Usage: hidden (-h|--help) | --version +Usage: hidden example with hidden settings @@ -8,5 +8,4 @@ Output version information: 0.0.0 switch: --version - diff --git a/test_resources/docs/hidden/man.txt b/test_resources/docs/hidden/man.txt --- a/test_resources/docs/hidden/man.txt +++ b/test_resources/docs/hidden/man.txt @@ -7,16 +7,15 @@ .Sh VERSION 0.0.0 .Sh SYNOPSIS -hidden (-h|--help) | --version +hidden .Sh SETTINGS Show this help text switch: -h|--help Output version information: 0.0.0 switch: --version - .Sh OPTIONS - -h|--help Show this help text - --version Output version information: 0.0.0 + -h|--help Show this help text + --version Output version information: 0.0.0 diff --git a/test_resources/docs/hidden/nix-options.nix b/test_resources/docs/hidden/nix-options.nix new file mode 100644 --- /dev/null +++ b/test_resources/docs/hidden/nix-options.nix @@ -0,0 +1,2 @@ +{ lib }: +{ } diff --git a/test_resources/docs/hidden/opt-long.txt b/test_resources/docs/hidden/opt-long.txt --- a/test_resources/docs/hidden/opt-long.txt +++ b/test_resources/docs/hidden/opt-long.txt @@ -1,2 +0,0 @@ - -h|--help Show this help text - --version Output version information: 0.0.0 diff --git a/test_resources/docs/hidden/opt-short.txt b/test_resources/docs/hidden/opt-short.txt --- a/test_resources/docs/hidden/opt-short.txt +++ b/test_resources/docs/hidden/opt-short.txt @@ -1,1 +1,1 @@ -hidden (-h|--help) | --version +hidden diff --git a/test_resources/docs/hidden/reference.txt b/test_resources/docs/hidden/reference.txt --- a/test_resources/docs/hidden/reference.txt +++ b/test_resources/docs/hidden/reference.txt @@ -1,14 +1,13 @@ -Usage: hidden (-h|--help) | --version +Usage: hidden All settings: Show this help text switch: -h|--help - Output version information: 0.0.0 + Output version information switch: --version - Options: - -h|--help Show this help text - --version Output version information: 0.0.0 + -h|--help Show this help text + --version Output version information diff --git a/test_resources/docs/many-args/config-docs.txt b/test_resources/docs/many-args/config-docs.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/many-args/config-docs.txt @@ -0,0 +1,1 @@ +AnyDocsOr [] diff --git a/test_resources/docs/many-args/config.txt b/test_resources/docs/many-args/config.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/many-args/config.txt diff --git a/test_resources/docs/many-args/docs.txt b/test_resources/docs/many-args/docs.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/many-args/docs.txt @@ -0,0 +1,17 @@ +AnyDocsOr + [ AnyDocsSingle + (Just + SetDoc + { setDocTryArgument = True + , setDocTrySwitch = False + , setDocTryOption = False + , setDocDasheds = [] + , setDocEnvVars = Nothing + , setDocConfKeys = Nothing + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Just "ARGUMENT" + , setDocHelp = Just "Argument" + }) + , AnyDocsSingle Nothing + ] diff --git a/test_resources/docs/many-args/env-docs.txt b/test_resources/docs/many-args/env-docs.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/many-args/env-docs.txt @@ -0,0 +1,1 @@ +AnyDocsOr [] diff --git a/test_resources/docs/many-args/env.txt b/test_resources/docs/many-args/env.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/many-args/env.txt diff --git a/test_resources/docs/many-args/help.txt b/test_resources/docs/many-args/help.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/many-args/help.txt @@ -0,0 +1,14 @@ +Usage: many-args [ARGUMENT] + +many args parser + +Available settings: + Show this help text + switch: -h|--help + + Output version information: 0.0.0 + switch: --version + + Argument + argument: ARGUMENT + diff --git a/test_resources/docs/many-args/man.txt b/test_resources/docs/many-args/man.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/many-args/man.txt @@ -0,0 +1,25 @@ +.Dd $Mdocdate$ +.Dt many-args 1 +.Os +.Sh NAME +.Nm many-args +.Nd many args parser +.Sh VERSION +0.0.0 +.Sh SYNOPSIS +many-args [ARGUMENT] +.Sh SETTINGS + Show this help text + switch: -h|--help + + Output version information: 0.0.0 + switch: --version + + Argument + argument: ARGUMENT + +.Sh OPTIONS + -h|--help Show this help text + --version Output version information: 0.0.0 + ARGUMENT Argument + diff --git a/test_resources/docs/many-args/nix-options.nix b/test_resources/docs/many-args/nix-options.nix new file mode 100644 --- /dev/null +++ b/test_resources/docs/many-args/nix-options.nix @@ -0,0 +1,2 @@ +{ lib }: +{ } diff --git a/test_resources/docs/many-args/opt-docs.txt b/test_resources/docs/many-args/opt-docs.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/many-args/opt-docs.txt @@ -0,0 +1,14 @@ +AnyDocsOr + [ AnyDocsSingle + (Just + OptDoc + { optDocTryArgument = True + , optDocTrySwitch = False + , optDocTryOption = False + , optDocDasheds = [] + , optDocDefault = Nothing + , optDocExamples = [] + , optDocMetavar = Just "ARGUMENT" + , optDocHelp = Just "Argument" + }) + ] diff --git a/test_resources/docs/many-args/opt-long.txt b/test_resources/docs/many-args/opt-long.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/many-args/opt-long.txt @@ -0,0 +1,1 @@ + ARGUMENT Argument diff --git a/test_resources/docs/many-args/opt-short.txt b/test_resources/docs/many-args/opt-short.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/many-args/opt-short.txt @@ -0,0 +1,1 @@ +many-args [ARGUMENT] diff --git a/test_resources/docs/many-args/reference.txt b/test_resources/docs/many-args/reference.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/many-args/reference.txt @@ -0,0 +1,17 @@ +Usage: many-args [ARGUMENT] + +All settings: + Show this help text + switch: -h|--help + + Output version information + switch: --version + + Argument + argument: ARGUMENT + +Options: + -h|--help Show this help text + --version Output version information + ARGUMENT Argument + diff --git a/test_resources/docs/many-args/show.txt b/test_resources/docs/many-args/show.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/many-args/show.txt @@ -0,0 +1,14 @@ +Many + (Setting + Nothing + (Setting + [] + [ _ ] + True + Nothing + False + Nothing + Nothing + Nothing + (Just "ARGUMENT") + (Just "Argument"))) diff --git a/test_resources/docs/many-args/version.txt b/test_resources/docs/many-args/version.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/many-args/version.txt @@ -0,0 +1,1 @@ +many-args 0.0.0 diff --git a/test_resources/docs/optional/config-docs.txt b/test_resources/docs/optional/config-docs.txt --- a/test_resources/docs/optional/config-docs.txt +++ b/test_resources/docs/optional/config-docs.txt @@ -1,1 +1,1 @@ -AnyDocsAnd [] +AnyDocsOr [] diff --git a/test_resources/docs/optional/docs.txt b/test_resources/docs/optional/docs.txt --- a/test_resources/docs/optional/docs.txt +++ b/test_resources/docs/optional/docs.txt @@ -1,12 +1,17 @@ -AnyDocsSingle - SetDoc - { setDocTryArgument = True - , setDocTrySwitch = False - , setDocTryOption = False - , setDocDasheds = [] - , setDocEnvVars = Nothing - , setDocConfKeys = Nothing - , setDocDefault = Nothing - , setDocMetavar = Just "ARGUMENT" - , setDocHelp = Just "Argument" - } +AnyDocsOr + [ AnyDocsSingle + (Just + SetDoc + { setDocTryArgument = True + , setDocTrySwitch = False + , setDocTryOption = False + , setDocDasheds = [] + , setDocEnvVars = Nothing + , setDocConfKeys = Nothing + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Just "ARGUMENT" + , setDocHelp = Just "Argument" + }) + , AnyDocsSingle Nothing + ] diff --git a/test_resources/docs/optional/env-docs.txt b/test_resources/docs/optional/env-docs.txt --- a/test_resources/docs/optional/env-docs.txt +++ b/test_resources/docs/optional/env-docs.txt @@ -1,1 +1,1 @@ -AnyDocsAnd [] +AnyDocsOr [] diff --git a/test_resources/docs/optional/help.txt b/test_resources/docs/optional/help.txt --- a/test_resources/docs/optional/help.txt +++ b/test_resources/docs/optional/help.txt @@ -1,4 +1,4 @@ -Usage: optional (-h|--help) | --version | ARGUMENT +Usage: optional [ARGUMENT] optional argument @@ -11,5 +11,4 @@ Argument argument: ARGUMENT - diff --git a/test_resources/docs/optional/man.txt b/test_resources/docs/optional/man.txt --- a/test_resources/docs/optional/man.txt +++ b/test_resources/docs/optional/man.txt @@ -7,7 +7,7 @@ .Sh VERSION 0.0.0 .Sh SYNOPSIS -optional (-h|--help) | --version | ARGUMENT +optional [ARGUMENT] .Sh SETTINGS Show this help text switch: -h|--help @@ -17,10 +17,9 @@ Argument argument: ARGUMENT - .Sh OPTIONS - -h|--help Show this help text - --version Output version information: 0.0.0 - ARGUMENT Argument + -h|--help Show this help text + --version Output version information: 0.0.0 + ARGUMENT Argument diff --git a/test_resources/docs/optional/nix-options.nix b/test_resources/docs/optional/nix-options.nix new file mode 100644 --- /dev/null +++ b/test_resources/docs/optional/nix-options.nix @@ -0,0 +1,2 @@ +{ lib }: +{ } diff --git a/test_resources/docs/optional/opt-docs.txt b/test_resources/docs/optional/opt-docs.txt --- a/test_resources/docs/optional/opt-docs.txt +++ b/test_resources/docs/optional/opt-docs.txt @@ -1,10 +1,14 @@ -AnyDocsSingle - OptDoc - { optDocTryArgument = True - , optDocTrySwitch = False - , optDocTryOption = False - , optDocDasheds = [] - , optDocDefault = Nothing - , optDocMetavar = Just "ARGUMENT" - , optDocHelp = Just "Argument" - } +AnyDocsOr + [ AnyDocsSingle + (Just + OptDoc + { optDocTryArgument = True + , optDocTrySwitch = False + , optDocTryOption = False + , optDocDasheds = [] + , optDocDefault = Nothing + , optDocExamples = [] + , optDocMetavar = Just "ARGUMENT" + , optDocHelp = Just "Argument" + }) + ] diff --git a/test_resources/docs/optional/opt-long.txt b/test_resources/docs/optional/opt-long.txt --- a/test_resources/docs/optional/opt-long.txt +++ b/test_resources/docs/optional/opt-long.txt @@ -1,3 +1,1 @@ - -h|--help Show this help text - --version Output version information: 0.0.0 - ARGUMENT Argument + ARGUMENT Argument diff --git a/test_resources/docs/optional/opt-short.txt b/test_resources/docs/optional/opt-short.txt --- a/test_resources/docs/optional/opt-short.txt +++ b/test_resources/docs/optional/opt-short.txt @@ -1,1 +1,1 @@ -optional (-h|--help) | --version | ARGUMENT +optional [ARGUMENT] diff --git a/test_resources/docs/optional/reference.txt b/test_resources/docs/optional/reference.txt --- a/test_resources/docs/optional/reference.txt +++ b/test_resources/docs/optional/reference.txt @@ -1,18 +1,17 @@ -Usage: optional (-h|--help) | --version | ARGUMENT +Usage: optional [ARGUMENT] All settings: Show this help text switch: -h|--help - Output version information: 0.0.0 + Output version information switch: --version Argument argument: ARGUMENT - Options: - -h|--help Show this help text - --version Output version information: 0.0.0 - ARGUMENT Argument + -h|--help Show this help text + --version Output version information + ARGUMENT Argument diff --git a/test_resources/docs/same-help/config-docs.txt b/test_resources/docs/same-help/config-docs.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/same-help/config-docs.txt @@ -0,0 +1,30 @@ +AnyDocsAnd + [ AnyDocsOr + [ AnyDocsSingle + EnvDoc + { envDocVars = "INT" :| [] + , envDocDefault = Nothing + , envDocExamples = [] + , envDocMetavar = Just "INT" + , envDocHelp = Just "int or string" + } + , AnyDocsSingle + EnvDoc + { envDocVars = "STRING" :| [] + , envDocDefault = Nothing + , envDocExamples = [] + , envDocMetavar = Just "STR" + , envDocHelp = Just "int or string" + } + ] + , AnyDocsOr + [ AnyDocsSingle + EnvDoc + { envDocVars = "OTHER" :| [] + , envDocDefault = Nothing + , envDocExamples = [] + , envDocMetavar = Just "BOOL" + , envDocHelp = Just "int or string" + } + ] + ] diff --git a/test_resources/docs/same-help/config.txt b/test_resources/docs/same-help/config.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/same-help/config.txt @@ -0,0 +1,12 @@ + int or string + int: + # or null +  # 64 bit signed integer + int or string + string: + # or null +  + int or string + other: + # or null +  diff --git a/test_resources/docs/same-help/docs.txt b/test_resources/docs/same-help/docs.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/same-help/docs.txt @@ -0,0 +1,100 @@ +AnyDocsAnd + [ AnyDocsSingle Nothing + , AnyDocsOr + [ AnyDocsSingle + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = False + , setDocTryOption = True + , setDocDasheds = [ DashedLong ('i' :| "nt") ] + , setDocEnvVars = Just ("INT" :| []) + , setDocConfKeys = + Just + (( "int" :| [] + , AnyOfSchema + (NullSchema :| + [ IntegerSchema + Bounds + { boundsLower = Just (-9223372036854775808) + , boundsUpper = Just 9223372036854775807 + } + ]) + ) :| + []) + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Just "INT" + , setDocHelp = Just "int or string" + }) + , AnyDocsSingle + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = False + , setDocTryOption = True + , setDocDasheds = [ DashedLong ('s' :| "tring") ] + , setDocEnvVars = Just ("STRING" :| []) + , setDocConfKeys = + Just + (( "string" :| [] + , AnyOfSchema (NullSchema :| [ StringSchema ]) + ) :| + []) + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Just "STR" + , setDocHelp = Just "int or string" + }) + ] + , AnyDocsOr + [ AnyDocsSingle + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = True + , setDocTryOption = False + , setDocDasheds = [ DashedLong ('[' :| "no-]other") ] + , setDocEnvVars = Nothing + , setDocConfKeys = Nothing + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Nothing + , setDocHelp = Just "int or string" + }) + , AnyDocsSingle Nothing + , AnyDocsSingle Nothing + , AnyDocsSingle + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = False + , setDocTryOption = False + , setDocDasheds = [] + , setDocEnvVars = Just ("OTHER" :| []) + , setDocConfKeys = Nothing + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Just "BOOL" + , setDocHelp = Just "int or string" + }) + , AnyDocsSingle + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = False + , setDocTryOption = False + , setDocDasheds = [] + , setDocEnvVars = Nothing + , setDocConfKeys = + Just + (( "other" :| [] , AnyOfSchema (NullSchema :| [ BoolSchema ]) ) :| + []) + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Nothing + , setDocHelp = Just "int or string" + }) + , AnyDocsSingle Nothing + ] + ] diff --git a/test_resources/docs/same-help/env-docs.txt b/test_resources/docs/same-help/env-docs.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/same-help/env-docs.txt @@ -0,0 +1,44 @@ +AnyDocsAnd + [ AnyDocsOr + [ AnyDocsSingle + ConfDoc + { confDocKeys = + ( "int" :| [] + , AnyOfSchema + (NullSchema :| + [ IntegerSchema + Bounds + { boundsLower = Just (-9223372036854775808) + , boundsUpper = Just 9223372036854775807 + } + ]) + ) :| + [] + , confDocDefault = Nothing + , confDocExamples = [] + , confDocHelp = Just "int or string" + } + , AnyDocsSingle + ConfDoc + { confDocKeys = + ( "string" :| [] + , AnyOfSchema (NullSchema :| [ StringSchema ]) + ) :| + [] + , confDocDefault = Nothing + , confDocExamples = [] + , confDocHelp = Just "int or string" + } + ] + , AnyDocsOr + [ AnyDocsSingle + ConfDoc + { confDocKeys = + ( "other" :| [] , AnyOfSchema (NullSchema :| [ BoolSchema ]) ) :| + [] + , confDocDefault = Nothing + , confDocExamples = [] + , confDocHelp = Just "int or string" + } + ] + ] diff --git a/test_resources/docs/same-help/env.txt b/test_resources/docs/same-help/env.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/same-help/env.txt @@ -0,0 +1,3 @@ + INT INT int or string + STRING STR int or string + OTHER BOOL int or string diff --git a/test_resources/docs/same-help/help.txt b/test_resources/docs/same-help/help.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/same-help/help.txt @@ -0,0 +1,30 @@ +Usage: same-help [--int INT | --string STR] [--[no-]other] + +example where multiple options use the same help string + +Available settings: + Show this help text + switch: -h|--help + + Output version information: 0.0.0 + switch: --version + + int or string + option: --int INT + env: INT INT + config: + int: # or null +  # 64 bit signed integer + option: --string STR + env: STRING STR + config: + string: # or null +  + + int or string + switch: --[no-]other + env: OTHER BOOL + config: + other: # or null +  + diff --git a/test_resources/docs/same-help/man.txt b/test_resources/docs/same-help/man.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/same-help/man.txt @@ -0,0 +1,62 @@ +.Dd $Mdocdate$ +.Dt same-help 1 +.Os +.Sh NAME +.Nm same-help +.Nd example where multiple options use the same help string +.Sh VERSION +0.0.0 +.Sh SYNOPSIS +same-help [--int INT | --string STR] [--[no-]other] +.Sh SETTINGS + Show this help text + switch: -h|--help + + Output version information: 0.0.0 + switch: --version + + int or string + option: --int INT + env: INT INT + config: + int: # or null + # 64 bit signed integer + option: --string STR + env: STRING STR + config: + string: # or null + + + int or string + switch: --[no-]other + env: OTHER BOOL + config: + other: # or null + + +.Sh OPTIONS + -h|--help Show this help text + --version Output version information: 0.0.0 + --int int or string + --string int or string + --[no-]other int or string + +.Sh ENVIRONMENT VARIABLES + INT INT int or string + STRING STR int or string + OTHER BOOL int or string + +.Sh CONFIGURATION VALUES + int or string + int: + # or null + # 64 bit signed integer + int or string + string: + # or null + + int or string + other: + # or null + + diff --git a/test_resources/docs/same-help/nix-options.nix b/test_resources/docs/same-help/nix-options.nix new file mode 100644 --- /dev/null +++ b/test_resources/docs/same-help/nix-options.nix @@ -0,0 +1,18 @@ +{ lib }: +{ + int = lib.mkOption { + default = null; + description = "int or string"; + type = lib.types.nullOr lib.types.int; + }; + other = lib.mkOption { + default = null; + description = "int or string"; + type = lib.types.nullOr lib.types.bool; + }; + string = lib.mkOption { + default = null; + description = "int or string"; + type = lib.types.nullOr lib.types.str; + }; +} diff --git a/test_resources/docs/same-help/opt-docs.txt b/test_resources/docs/same-help/opt-docs.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/same-help/opt-docs.txt @@ -0,0 +1,44 @@ +AnyDocsAnd + [ AnyDocsOr + [ AnyDocsSingle + (Just + OptDoc + { optDocTryArgument = False + , optDocTrySwitch = False + , optDocTryOption = True + , optDocDasheds = [ DashedLong ('i' :| "nt") ] + , optDocDefault = Nothing + , optDocExamples = [] + , optDocMetavar = Just "INT" + , optDocHelp = Just "int or string" + }) + , AnyDocsSingle + (Just + OptDoc + { optDocTryArgument = False + , optDocTrySwitch = False + , optDocTryOption = True + , optDocDasheds = [ DashedLong ('s' :| "tring") ] + , optDocDefault = Nothing + , optDocExamples = [] + , optDocMetavar = Just "STR" + , optDocHelp = Just "int or string" + }) + ] + , AnyDocsOr + [ AnyDocsSingle + (Just + OptDoc + { optDocTryArgument = False + , optDocTrySwitch = True + , optDocTryOption = False + , optDocDasheds = [ DashedLong ('[' :| "no-]other") ] + , optDocDefault = Nothing + , optDocExamples = [] + , optDocMetavar = Nothing + , optDocHelp = Just "int or string" + }) + , AnyDocsSingle Nothing + , AnyDocsSingle Nothing + ] + ] diff --git a/test_resources/docs/same-help/opt-long.txt b/test_resources/docs/same-help/opt-long.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/same-help/opt-long.txt @@ -0,0 +1,3 @@ + --int int or string + --string int or string + --[no-]other int or string diff --git a/test_resources/docs/same-help/opt-short.txt b/test_resources/docs/same-help/opt-short.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/same-help/opt-short.txt @@ -0,0 +1,1 @@ +same-help [--int INT | --string STR] [--[no-]other] diff --git a/test_resources/docs/same-help/reference.txt b/test_resources/docs/same-help/reference.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/same-help/reference.txt @@ -0,0 +1,54 @@ +Usage: same-help [--int INT | --string STR] [--[no-]other] + +All settings: + Show this help text + switch: -h|--help + + Output version information + switch: --version + + int or string + option: --int INT + env: INT INT + config: + int: # or null +  # 64 bit signed integer + option: --string STR + env: STRING STR + config: + string: # or null +  + + int or string + switch: --[no-]other + env: OTHER BOOL + config: + other: # or null +  + +Options: + -h|--help Show this help text + --version Output version information + --int int or string + --string int or string + --[no-]other int or string + +Environment Variables: + INT INT int or string + STRING STR int or string + OTHER BOOL int or string + +Configuration Values: + int or string + int: + # or null +  # 64 bit signed integer + int or string + string: + # or null +  + int or string + other: + # or null +  + diff --git a/test_resources/docs/same-help/show.txt b/test_resources/docs/same-help/show.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/same-help/show.txt @@ -0,0 +1,146 @@ +WithConfig + _ + Nothing + (Pure _) + (Ap + (Alt + (Check + Nothing + True + _ + (Setting + Nothing + (Setting + [ DashedLong ('i' :| "nt") ] + [ _ ] + False + Nothing + True + (Just ("INT" :| [])) + (Just + (ConfigValSetting + ("int" :| []) + BimapCodec + _ + _ + (EitherCodec + PossiblyJointUnion + NullCodec + (BimapCodec + _ + _ + (IntegerCodec + Nothing + Bounds + { boundsLower = Just (-9223372036854775808) + , boundsUpper = Just 9223372036854775807 + }))) :| + [])) + Nothing + (Just "INT") + (Just "int or string")))) + (Check + Nothing + True + _ + (Setting + Nothing + (Setting + [ DashedLong ('s' :| "tring") ] + [ _ ] + False + Nothing + True + (Just ("STRING" :| [])) + (Just + (ConfigValSetting + ("string" :| []) + BimapCodec + _ + _ + (EitherCodec + PossiblyJointUnion + NullCodec + (BimapCodec _ _ (StringCodec Nothing))) :| + [])) + Nothing + (Just "STR") + (Just "int or string"))))) + (Alt + (Setting + Nothing + (Setting + [ DashedLong ('[' :| "no-]other") ] + [] + False + (Just _) + False + Nothing + Nothing + Nothing + Nothing + (Just "int or string"))) + (Alt + (Setting + Nothing + (Setting + [ DashedLong ('n' :| "o-other") ] + [] + False + (Just _) + False + Nothing + Nothing + Nothing + Nothing + Nothing)) + (Alt + (Setting + Nothing + (Setting + [ DashedLong ('o' :| "ther") ] + [] + False + (Just _) + False + Nothing + Nothing + Nothing + Nothing + Nothing)) + (Alt + (Setting + Nothing + (Setting + [] + [ _ ] + False + Nothing + False + (Just ("OTHER" :| [])) + Nothing + Nothing + (Just "BOOL") + (Just "int or string"))) + (Alt + (Setting + Nothing + (Setting + [] + [] + False + Nothing + False + Nothing + (Just + (ConfigValSetting + ("other" :| []) + BimapCodec + _ + _ + (EitherCodec PossiblyJointUnion NullCodec (BoolCodec Nothing)) :| + [])) + Nothing + Nothing + (Just "int or string"))) + (Pure _))))))) diff --git a/test_resources/docs/same-help/version.txt b/test_resources/docs/same-help/version.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/same-help/version.txt @@ -0,0 +1,1 @@ +same-help 0.0.0 diff --git a/test_resources/docs/secret/config-docs.txt b/test_resources/docs/secret/config-docs.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/secret/config-docs.txt @@ -0,0 +1,50 @@ +AnyDocsAnd + [ AnyDocsSingle + EnvDoc + { envDocVars = "FIRST_SECRET_FILE" :| [] + , envDocDefault = Nothing + , envDocExamples = [] + , envDocMetavar = Just "FILE_PATH" + , envDocHelp = Just "First example secret" + } + , AnyDocsOr + [ AnyDocsSingle + EnvDoc + { envDocVars = "SECOND_SECRET" :| [] + , envDocDefault = Nothing + , envDocExamples = [] + , envDocMetavar = Just "SECRET" + , envDocHelp = Just "Second example secret, bare or in a file" + } + , AnyDocsSingle + EnvDoc + { envDocVars = "SECOND_SECRET_FILE" :| [] + , envDocDefault = Nothing + , envDocExamples = [] + , envDocMetavar = Just "FILE_PATH" + , envDocHelp = Just "Second example secret, bare or in a file" + } + ] + , AnyDocsOr [] + , AnyDocsOr + [ AnyDocsSingle + EnvDoc + { envDocVars = "second-secret" :| [] + , envDocDefault = Nothing + , envDocExamples = [] + , envDocMetavar = Just "SECRET" + , envDocHelp = + Just "Second example secret, bare or in a file, only env" + } + , AnyDocsSingle + EnvDoc + { envDocVars = "second-secret_FILE" :| [] + , envDocDefault = Nothing + , envDocExamples = [] + , envDocMetavar = Just "FILE_PATH" + , envDocHelp = + Just "Second example secret, bare or in a file, only env" + } + ] + , AnyDocsOr [] + ] diff --git a/test_resources/docs/secret/config.txt b/test_resources/docs/secret/config.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/secret/config.txt @@ -0,0 +1,20 @@ + First example secret + first-secret-file: + # or null +  + Second example secret, bare or in a file + second-secret: + # or null +  + Second example secret, bare or in a file + second-secret-file: + # or null +  + Second example secret, bare or in a file, only conf + second-secret: + # or null +  + Second example secret, bare or in a file, only conf + second-secret-file: + # or null +  diff --git a/test_resources/docs/secret/docs.txt b/test_resources/docs/secret/docs.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/secret/docs.txt @@ -0,0 +1,224 @@ +AnyDocsAnd + [ AnyDocsSingle Nothing + , AnyDocsSingle + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = False + , setDocTryOption = True + , setDocDasheds = [ DashedLong ('f' :| "irst-secret-file") ] + , setDocEnvVars = Just ("FIRST_SECRET_FILE" :| []) + , setDocConfKeys = + Just + (( "first-secret-file" :| [] + , AnyOfSchema (NullSchema :| [ StringSchema ]) + ) :| + []) + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Just "FILE_PATH" + , setDocHelp = Just "First example secret" + }) + , AnyDocsOr + [ AnyDocsSingle + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = False + , setDocTryOption = True + , setDocDasheds = [ DashedLong ('s' :| "econd-secret") ] + , setDocEnvVars = Nothing + , setDocConfKeys = Nothing + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Just "SECRET" + , setDocHelp = Just "Second example secret, bare or in a file" + }) + , AnyDocsSingle + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = False + , setDocTryOption = True + , setDocDasheds = [ DashedLong ('s' :| "econd-secret-file") ] + , setDocEnvVars = Nothing + , setDocConfKeys = Nothing + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Just "FILE_PATH" + , setDocHelp = Just "Second example secret, bare or in a file" + }) + , AnyDocsSingle + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = False + , setDocTryOption = False + , setDocDasheds = [] + , setDocEnvVars = Just ("SECOND_SECRET" :| []) + , setDocConfKeys = Nothing + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Just "SECRET" + , setDocHelp = Just "Second example secret, bare or in a file" + }) + , AnyDocsSingle + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = False + , setDocTryOption = False + , setDocDasheds = [] + , setDocEnvVars = Just ("SECOND_SECRET_FILE" :| []) + , setDocConfKeys = Nothing + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Just "FILE_PATH" + , setDocHelp = Just "Second example secret, bare or in a file" + }) + , AnyDocsSingle + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = False + , setDocTryOption = False + , setDocDasheds = [] + , setDocEnvVars = Nothing + , setDocConfKeys = + Just + (( "second-secret" :| [] + , AnyOfSchema (NullSchema :| [ StringSchema ]) + ) :| + []) + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Just "SECRET" + , setDocHelp = Just "Second example secret, bare or in a file" + }) + , AnyDocsSingle + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = False + , setDocTryOption = False + , setDocDasheds = [] + , setDocEnvVars = Nothing + , setDocConfKeys = + Just + (( "second-secret-file" :| [] + , AnyOfSchema (NullSchema :| [ StringSchema ]) + ) :| + []) + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Just "FILE_PATH" + , setDocHelp = Just "Second example secret, bare or in a file" + }) + ] + , AnyDocsOr + [ AnyDocsSingle + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = False + , setDocTryOption = True + , setDocDasheds = [ DashedLong ('s' :| "econd-secret") ] + , setDocEnvVars = Nothing + , setDocConfKeys = Nothing + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Just "SECRET" + , setDocHelp = + Just "Second example secret, bare or in a file, only option" + }) + , AnyDocsSingle + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = False + , setDocTryOption = True + , setDocDasheds = [ DashedLong ('s' :| "econd-secret-file") ] + , setDocEnvVars = Nothing + , setDocConfKeys = Nothing + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Just "FILE_PATH" + , setDocHelp = + Just "Second example secret, bare or in a file, only option" + }) + ] + , AnyDocsOr + [ AnyDocsSingle + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = False + , setDocTryOption = False + , setDocDasheds = [] + , setDocEnvVars = Just ("second-secret" :| []) + , setDocConfKeys = Nothing + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Just "SECRET" + , setDocHelp = + Just "Second example secret, bare or in a file, only env" + }) + , AnyDocsSingle + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = False + , setDocTryOption = False + , setDocDasheds = [] + , setDocEnvVars = Just ("second-secret_FILE" :| []) + , setDocConfKeys = Nothing + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Just "FILE_PATH" + , setDocHelp = + Just "Second example secret, bare or in a file, only env" + }) + ] + , AnyDocsOr + [ AnyDocsSingle + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = False + , setDocTryOption = False + , setDocDasheds = [] + , setDocEnvVars = Nothing + , setDocConfKeys = + Just + (( "second-secret" :| [] + , AnyOfSchema (NullSchema :| [ StringSchema ]) + ) :| + []) + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Just "SECRET" + , setDocHelp = + Just "Second example secret, bare or in a file, only conf" + }) + , AnyDocsSingle + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = False + , setDocTryOption = False + , setDocDasheds = [] + , setDocEnvVars = Nothing + , setDocConfKeys = + Just + (( "second-secret-file" :| [] + , AnyOfSchema (NullSchema :| [ StringSchema ]) + ) :| + []) + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Just "FILE_PATH" + , setDocHelp = + Just "Second example secret, bare or in a file, only conf" + }) + ] + ] diff --git a/test_resources/docs/secret/env-docs.txt b/test_resources/docs/secret/env-docs.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/secret/env-docs.txt @@ -0,0 +1,65 @@ +AnyDocsAnd + [ AnyDocsSingle + ConfDoc + { confDocKeys = + ( "first-secret-file" :| [] + , AnyOfSchema (NullSchema :| [ StringSchema ]) + ) :| + [] + , confDocDefault = Nothing + , confDocExamples = [] + , confDocHelp = Just "First example secret" + } + , AnyDocsOr + [ AnyDocsSingle + ConfDoc + { confDocKeys = + ( "second-secret" :| [] + , AnyOfSchema (NullSchema :| [ StringSchema ]) + ) :| + [] + , confDocDefault = Nothing + , confDocExamples = [] + , confDocHelp = Just "Second example secret, bare or in a file" + } + , AnyDocsSingle + ConfDoc + { confDocKeys = + ( "second-secret-file" :| [] + , AnyOfSchema (NullSchema :| [ StringSchema ]) + ) :| + [] + , confDocDefault = Nothing + , confDocExamples = [] + , confDocHelp = Just "Second example secret, bare or in a file" + } + ] + , AnyDocsOr [] + , AnyDocsOr [] + , AnyDocsOr + [ AnyDocsSingle + ConfDoc + { confDocKeys = + ( "second-secret" :| [] + , AnyOfSchema (NullSchema :| [ StringSchema ]) + ) :| + [] + , confDocDefault = Nothing + , confDocExamples = [] + , confDocHelp = + Just "Second example secret, bare or in a file, only conf" + } + , AnyDocsSingle + ConfDoc + { confDocKeys = + ( "second-secret-file" :| [] + , AnyOfSchema (NullSchema :| [ StringSchema ]) + ) :| + [] + , confDocDefault = Nothing + , confDocExamples = [] + , confDocHelp = + Just "Second example secret, bare or in a file, only conf" + } + ] + ] diff --git a/test_resources/docs/secret/env.txt b/test_resources/docs/secret/env.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/secret/env.txt @@ -0,0 +1,5 @@ + FIRST_SECRET_FILE FILE_PATH First example secret + SECOND_SECRET SECRET Second example secret, bare or in a file + SECOND_SECRET_FILE FILE_PATH Second example secret, bare or in a file + second-secret SECRET Second example secret, bare or in a file, only env + second-secret_FILE FILE_PATH Second example secret, bare or in a file, only env diff --git a/test_resources/docs/secret/help.txt b/test_resources/docs/secret/help.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/secret/help.txt @@ -0,0 +1,46 @@ +Usage: secret --first-secret-file FILE_PATH [--second-secret SECRET | --second-secret-file FILE_PATH] [--second-secret SECRET | --second-secret-file FILE_PATH] + +Secrets example + +Available settings: + Show this help text + switch: -h|--help + + Output version information: 0.0.0 + switch: --version + + First example secret + option: --first-secret-file FILE_PATH + env: FIRST_SECRET_FILE FILE_PATH + config: + first-secret-file: # or null +  + + Second example secret, bare or in a file + option: --second-secret SECRET + option: --second-secret-file FILE_PATH + env: SECOND_SECRET SECRET + env: SECOND_SECRET_FILE FILE_PATH + config: + second-secret: # or null +  + config: + second-secret-file: # or null +  + + Second example secret, bare or in a file, only option + option: --second-secret SECRET + option: --second-secret-file FILE_PATH + + Second example secret, bare or in a file, only env + env: second-secret SECRET + env: second-secret_FILE FILE_PATH + + Second example secret, bare or in a file, only conf + config: + second-secret: # or null +  + config: + second-secret-file: # or null +  + diff --git a/test_resources/docs/secret/man.txt b/test_resources/docs/secret/man.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/secret/man.txt @@ -0,0 +1,90 @@ +.Dd $Mdocdate$ +.Dt secret 1 +.Os +.Sh NAME +.Nm secret +.Nd Secrets example +.Sh VERSION +0.0.0 +.Sh SYNOPSIS +secret --first-secret-file FILE_PATH [--second-secret SECRET | --second-secret-file FILE_PATH] [--second-secret SECRET | --second-secret-file FILE_PATH] +.Sh SETTINGS + Show this help text + switch: -h|--help + + Output version information: 0.0.0 + switch: --version + + First example secret + option: --first-secret-file FILE_PATH + env: FIRST_SECRET_FILE FILE_PATH + config: + first-secret-file: # or null + + + Second example secret, bare or in a file + option: --second-secret SECRET + option: --second-secret-file FILE_PATH + env: SECOND_SECRET SECRET + env: SECOND_SECRET_FILE FILE_PATH + config: + second-secret: # or null + + config: + second-secret-file: # or null + + + Second example secret, bare or in a file, only option + option: --second-secret SECRET + option: --second-secret-file FILE_PATH + + Second example secret, bare or in a file, only env + env: second-secret SECRET + env: second-secret_FILE FILE_PATH + + Second example secret, bare or in a file, only conf + config: + second-secret: # or null + + config: + second-secret-file: # or null + + +.Sh OPTIONS + -h|--help Show this help text + --version Output version information: 0.0.0 + --first-secret-file First example secret + --second-secret Second example secret, bare or in a file + --second-secret-file Second example secret, bare or in a file + --second-secret Second example secret, bare or in a file, only option + --second-secret-file Second example secret, bare or in a file, only option + +.Sh ENVIRONMENT VARIABLES + FIRST_SECRET_FILE FILE_PATH First example secret + SECOND_SECRET SECRET Second example secret, bare or in a file + SECOND_SECRET_FILE FILE_PATH Second example secret, bare or in a file + second-secret SECRET Second example secret, bare or in a file, only env + second-secret_FILE FILE_PATH Second example secret, bare or in a file, only env + +.Sh CONFIGURATION VALUES + First example secret + first-secret-file: + # or null + + Second example secret, bare or in a file + second-secret: + # or null + + Second example secret, bare or in a file + second-secret-file: + # or null + + Second example secret, bare or in a file, only conf + second-secret: + # or null + + Second example secret, bare or in a file, only conf + second-secret-file: + # or null + + diff --git a/test_resources/docs/secret/nix-options.nix b/test_resources/docs/secret/nix-options.nix new file mode 100644 --- /dev/null +++ b/test_resources/docs/secret/nix-options.nix @@ -0,0 +1,18 @@ +{ lib }: +{ + first-secret-file = lib.mkOption { + default = null; + description = "First example secret"; + type = lib.types.nullOr lib.types.str; + }; + second-secret = lib.mkOption { + default = null; + description = "Second example secret, bare or in a file, only conf"; + type = lib.types.nullOr lib.types.str; + }; + second-secret-file = lib.mkOption { + default = null; + description = "Second example secret, bare or in a file, only conf"; + type = lib.types.nullOr lib.types.str; + }; +} diff --git a/test_resources/docs/secret/opt-docs.txt b/test_resources/docs/secret/opt-docs.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/secret/opt-docs.txt @@ -0,0 +1,74 @@ +AnyDocsAnd + [ AnyDocsSingle + (Just + OptDoc + { optDocTryArgument = False + , optDocTrySwitch = False + , optDocTryOption = True + , optDocDasheds = [ DashedLong ('f' :| "irst-secret-file") ] + , optDocDefault = Nothing + , optDocExamples = [] + , optDocMetavar = Just "FILE_PATH" + , optDocHelp = Just "First example secret" + }) + , AnyDocsOr + [ AnyDocsSingle + (Just + OptDoc + { optDocTryArgument = False + , optDocTrySwitch = False + , optDocTryOption = True + , optDocDasheds = [ DashedLong ('s' :| "econd-secret") ] + , optDocDefault = Nothing + , optDocExamples = [] + , optDocMetavar = Just "SECRET" + , optDocHelp = Just "Second example secret, bare or in a file" + }) + , AnyDocsSingle + (Just + OptDoc + { optDocTryArgument = False + , optDocTrySwitch = False + , optDocTryOption = True + , optDocDasheds = [ DashedLong ('s' :| "econd-secret-file") ] + , optDocDefault = Nothing + , optDocExamples = [] + , optDocMetavar = Just "FILE_PATH" + , optDocHelp = Just "Second example secret, bare or in a file" + }) + , AnyDocsSingle Nothing + , AnyDocsSingle Nothing + , AnyDocsSingle Nothing + , AnyDocsSingle Nothing + ] + , AnyDocsOr + [ AnyDocsSingle + (Just + OptDoc + { optDocTryArgument = False + , optDocTrySwitch = False + , optDocTryOption = True + , optDocDasheds = [ DashedLong ('s' :| "econd-secret") ] + , optDocDefault = Nothing + , optDocExamples = [] + , optDocMetavar = Just "SECRET" + , optDocHelp = + Just "Second example secret, bare or in a file, only option" + }) + , AnyDocsSingle + (Just + OptDoc + { optDocTryArgument = False + , optDocTrySwitch = False + , optDocTryOption = True + , optDocDasheds = [ DashedLong ('s' :| "econd-secret-file") ] + , optDocDefault = Nothing + , optDocExamples = [] + , optDocMetavar = Just "FILE_PATH" + , optDocHelp = + Just "Second example secret, bare or in a file, only option" + }) + ] + , AnyDocsOr [ AnyDocsSingle Nothing , AnyDocsSingle Nothing ] + , AnyDocsOr [ AnyDocsSingle Nothing , AnyDocsSingle Nothing ] + ] diff --git a/test_resources/docs/secret/opt-long.txt b/test_resources/docs/secret/opt-long.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/secret/opt-long.txt @@ -0,0 +1,5 @@ + --first-secret-file First example secret + --second-secret Second example secret, bare or in a file + --second-secret-file Second example secret, bare or in a file + --second-secret Second example secret, bare or in a file, only option + --second-secret-file Second example secret, bare or in a file, only option diff --git a/test_resources/docs/secret/opt-short.txt b/test_resources/docs/secret/opt-short.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/secret/opt-short.txt @@ -0,0 +1,1 @@ +secret --first-secret-file FILE_PATH [--second-secret SECRET | --second-secret-file FILE_PATH] [--second-secret SECRET | --second-secret-file FILE_PATH] diff --git a/test_resources/docs/secret/reference.txt b/test_resources/docs/secret/reference.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/secret/reference.txt @@ -0,0 +1,82 @@ +Usage: secret --first-secret-file FILE_PATH [--second-secret SECRET | --second-secret-file FILE_PATH] [--second-secret SECRET | --second-secret-file FILE_PATH] + +All settings: + Show this help text + switch: -h|--help + + Output version information + switch: --version + + First example secret + option: --first-secret-file FILE_PATH + env: FIRST_SECRET_FILE FILE_PATH + config: + first-secret-file: # or null +  + + Second example secret, bare or in a file + option: --second-secret SECRET + option: --second-secret-file FILE_PATH + env: SECOND_SECRET SECRET + env: SECOND_SECRET_FILE FILE_PATH + config: + second-secret: # or null +  + config: + second-secret-file: # or null +  + + Second example secret, bare or in a file, only option + option: --second-secret SECRET + option: --second-secret-file FILE_PATH + + Second example secret, bare or in a file, only env + env: second-secret SECRET + env: second-secret_FILE FILE_PATH + + Second example secret, bare or in a file, only conf + config: + second-secret: # or null +  + config: + second-secret-file: # or null +  + +Options: + -h|--help Show this help text + --version Output version information + --first-secret-file First example secret + --second-secret Second example secret, bare or in a file + --second-secret-file Second example secret, bare or in a file + --second-secret Second example secret, bare or in a file, only option + --second-secret-file Second example secret, bare or in a file, only option + +Environment Variables: + FIRST_SECRET_FILE FILE_PATH First example secret + SECOND_SECRET SECRET Second example secret, bare or in a file + SECOND_SECRET_FILE FILE_PATH Second example secret, bare or in a file + second-secret SECRET Second example secret, bare or in a file, only env + second-secret_FILE FILE_PATH Second example secret, bare or in a file, only env + +Configuration Values: + First example secret + first-secret-file: + # or null +  + Second example secret, bare or in a file + second-secret: + # or null +  + Second example secret, bare or in a file + second-secret-file: + # or null +  + Second example secret, bare or in a file, only conf + second-secret: + # or null +  + Second example secret, bare or in a file, only conf + second-secret-file: + # or null +  + diff --git a/test_resources/docs/secret/show.txt b/test_resources/docs/secret/show.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/secret/show.txt @@ -0,0 +1,291 @@ +WithConfig + _ + Nothing + (Pure _) + (Ap + (Ap + (Ap + (Ap + (Check + Nothing + False + _ + (Check + Nothing + False + _ + (Setting + Nothing + (Setting + [ DashedLong ('f' :| "irst-secret-file") ] + [ _ ] + False + Nothing + True + (Just ("FIRST_SECRET_FILE" :| [])) + (Just + (ConfigValSetting + ("first-secret-file" :| []) + BimapCodec + _ + _ + (EitherCodec + PossiblyJointUnion + NullCodec + (BimapCodec _ _ (StringCodec Nothing))) :| + [])) + Nothing + (Just "FILE_PATH") + (Just "First example secret"))))) + (Alt + (Check + Nothing + True + _ + (Setting + Nothing + (Setting + [ DashedLong ('s' :| "econd-secret") ] + [ _ , _ ] + False + Nothing + True + Nothing + Nothing + Nothing + (Just "SECRET") + (Just "Second example secret, bare or in a file")))) + (Alt + (Check + Nothing + False + _ + (Setting + Nothing + (Setting + [ DashedLong ('s' :| "econd-secret-file") ] + [ _ , _ ] + False + Nothing + True + Nothing + Nothing + Nothing + (Just "FILE_PATH") + (Just "Second example secret, bare or in a file")))) + (Alt + (Check + Nothing + True + _ + (Setting + Nothing + (Setting + [] + [ _ , _ ] + False + Nothing + False + (Just ("SECOND_SECRET" :| [])) + Nothing + Nothing + (Just "SECRET") + (Just "Second example secret, bare or in a file")))) + (Alt + (Check + Nothing + False + _ + (Setting + Nothing + (Setting + [] + [ _ , _ ] + False + Nothing + False + (Just ("SECOND_SECRET_FILE" :| [])) + Nothing + Nothing + (Just "FILE_PATH") + (Just "Second example secret, bare or in a file")))) + (Alt + (Check + Nothing + True + _ + (Setting + Nothing + (Setting + [] + [ _ , _ ] + False + Nothing + False + Nothing + (Just + (ConfigValSetting + ("second-secret" :| []) + BimapCodec + _ + _ + (EitherCodec + PossiblyJointUnion + NullCodec + (BimapCodec _ _ (StringCodec Nothing))) :| + [])) + Nothing + (Just "SECRET") + (Just "Second example secret, bare or in a file")))) + (Check + Nothing + False + _ + (Setting + Nothing + (Setting + [] + [ _ , _ ] + False + Nothing + False + Nothing + (Just + (ConfigValSetting + ("second-secret-file" :| []) + BimapCodec + _ + _ + (EitherCodec + PossiblyJointUnion + NullCodec + (BimapCodec _ _ (StringCodec Nothing))) :| + [])) + Nothing + (Just "FILE_PATH") + (Just "Second example secret, bare or in a file")))))))))) + (Alt + (Check + Nothing + True + _ + (Setting + Nothing + (Setting + [ DashedLong ('s' :| "econd-secret") ] + [ _ , _ ] + False + Nothing + True + Nothing + Nothing + Nothing + (Just "SECRET") + (Just "Second example secret, bare or in a file, only option")))) + (Check + Nothing + False + _ + (Setting + Nothing + (Setting + [ DashedLong ('s' :| "econd-secret-file") ] + [ _ , _ ] + False + Nothing + True + Nothing + Nothing + Nothing + (Just "FILE_PATH") + (Just "Second example secret, bare or in a file, only option")))))) + (Alt + (Check + Nothing + True + _ + (Setting + Nothing + (Setting + [] + [ _ , _ ] + False + Nothing + False + (Just ("second-secret" :| [])) + Nothing + Nothing + (Just "SECRET") + (Just "Second example secret, bare or in a file, only env")))) + (Check + Nothing + False + _ + (Setting + Nothing + (Setting + [] + [ _ , _ ] + False + Nothing + False + (Just ("second-secret_FILE" :| [])) + Nothing + Nothing + (Just "FILE_PATH") + (Just "Second example secret, bare or in a file, only env")))))) + (Alt + (Check + Nothing + True + _ + (Setting + Nothing + (Setting + [] + [ _ , _ ] + False + Nothing + False + Nothing + (Just + (ConfigValSetting + ("second-secret" :| []) + BimapCodec + _ + _ + (EitherCodec + PossiblyJointUnion + NullCodec + (BimapCodec _ _ (StringCodec Nothing))) :| + [])) + Nothing + (Just "SECRET") + (Just "Second example secret, bare or in a file, only conf")))) + (Check + Nothing + False + _ + (Setting + Nothing + (Setting + [] + [ _ , _ ] + False + Nothing + False + Nothing + (Just + (ConfigValSetting + ("second-secret-file" :| []) + BimapCodec + _ + _ + (EitherCodec + PossiblyJointUnion + NullCodec + (BimapCodec _ _ (StringCodec Nothing))) :| + [])) + Nothing + (Just "FILE_PATH") + (Just "Second example secret, bare or in a file, only conf")))))) diff --git a/test_resources/docs/secret/version.txt b/test_resources/docs/secret/version.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/secret/version.txt @@ -0,0 +1,1 @@ +secret 0.0.0 diff --git a/test_resources/docs/some-args/config-docs.txt b/test_resources/docs/some-args/config-docs.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/some-args/config-docs.txt @@ -0,0 +1,1 @@ +AnyDocsOr [] diff --git a/test_resources/docs/some-args/config.txt b/test_resources/docs/some-args/config.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/some-args/config.txt diff --git a/test_resources/docs/some-args/docs.txt b/test_resources/docs/some-args/docs.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/some-args/docs.txt @@ -0,0 +1,33 @@ +AnyDocsAnd + [ AnyDocsSingle + (Just + SetDoc + { setDocTryArgument = True + , setDocTrySwitch = False + , setDocTryOption = False + , setDocDasheds = [] + , setDocEnvVars = Nothing + , setDocConfKeys = Nothing + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Just "ARGUMENT" + , setDocHelp = Just "Argument" + }) + , AnyDocsOr + [ AnyDocsSingle + (Just + SetDoc + { setDocTryArgument = True + , setDocTrySwitch = False + , setDocTryOption = False + , setDocDasheds = [] + , setDocEnvVars = Nothing + , setDocConfKeys = Nothing + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Just "ARGUMENT" + , setDocHelp = Just "Argument" + }) + , AnyDocsSingle Nothing + ] + ] diff --git a/test_resources/docs/some-args/env-docs.txt b/test_resources/docs/some-args/env-docs.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/some-args/env-docs.txt @@ -0,0 +1,1 @@ +AnyDocsOr [] diff --git a/test_resources/docs/some-args/env.txt b/test_resources/docs/some-args/env.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/some-args/env.txt diff --git a/test_resources/docs/some-args/help.txt b/test_resources/docs/some-args/help.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/some-args/help.txt @@ -0,0 +1,17 @@ +Usage: some-args ARGUMENT [ARGUMENT] + +some args parser + +Available settings: + Show this help text + switch: -h|--help + + Output version information: 0.0.0 + switch: --version + + Argument + argument: ARGUMENT + + Argument + argument: ARGUMENT + diff --git a/test_resources/docs/some-args/man.txt b/test_resources/docs/some-args/man.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/some-args/man.txt @@ -0,0 +1,33 @@ +.Dd $Mdocdate$ +.Dt some-args 1 +.Os +.Sh NAME +.Nm some-args +.Nd some args parser +.Sh VERSION +0.0.0 +.Sh SYNOPSIS +some-args ARGUMENT [ARGUMENT] +.Sh SETTINGS + Show this help text + switch: -h|--help + + Output version information: 0.0.0 + switch: --version + + Argument + argument: ARGUMENT + + Argument + argument: ARGUMENT + +.Sh OPTIONS + -h|--help Show this help text + --version Output version information: 0.0.0 + ARGUMENT Argument + ARGUMENT Argument + +.Sh ENVIRONMENT VARIABLES + +.Sh CONFIGURATION VALUES + diff --git a/test_resources/docs/some-args/nix-options.nix b/test_resources/docs/some-args/nix-options.nix new file mode 100644 --- /dev/null +++ b/test_resources/docs/some-args/nix-options.nix @@ -0,0 +1,2 @@ +{ lib }: +{ } diff --git a/test_resources/docs/some-args/opt-docs.txt b/test_resources/docs/some-args/opt-docs.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/some-args/opt-docs.txt @@ -0,0 +1,28 @@ +AnyDocsAnd + [ AnyDocsSingle + (Just + OptDoc + { optDocTryArgument = True + , optDocTrySwitch = False + , optDocTryOption = False + , optDocDasheds = [] + , optDocDefault = Nothing + , optDocExamples = [] + , optDocMetavar = Just "ARGUMENT" + , optDocHelp = Just "Argument" + }) + , AnyDocsOr + [ AnyDocsSingle + (Just + OptDoc + { optDocTryArgument = True + , optDocTrySwitch = False + , optDocTryOption = False + , optDocDasheds = [] + , optDocDefault = Nothing + , optDocExamples = [] + , optDocMetavar = Just "ARGUMENT" + , optDocHelp = Just "Argument" + }) + ] + ] diff --git a/test_resources/docs/some-args/opt-long.txt b/test_resources/docs/some-args/opt-long.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/some-args/opt-long.txt @@ -0,0 +1,2 @@ + ARGUMENT Argument + ARGUMENT Argument diff --git a/test_resources/docs/some-args/opt-short.txt b/test_resources/docs/some-args/opt-short.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/some-args/opt-short.txt @@ -0,0 +1,1 @@ +some-args ARGUMENT [ARGUMENT] diff --git a/test_resources/docs/some-args/reference.txt b/test_resources/docs/some-args/reference.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/some-args/reference.txt @@ -0,0 +1,25 @@ +Usage: some-args ARGUMENT [ARGUMENT] + +All settings: + Show this help text + switch: -h|--help + + Output version information + switch: --version + + Argument + argument: ARGUMENT + + Argument + argument: ARGUMENT + +Options: + -h|--help Show this help text + --version Output version information + ARGUMENT Argument + ARGUMENT Argument + +Environment Variables: + +Configuration Values: + diff --git a/test_resources/docs/some-args/show.txt b/test_resources/docs/some-args/show.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/some-args/show.txt @@ -0,0 +1,18 @@ +Check + Nothing + True + _ + (Some + (Setting + Nothing + (Setting + [] + [ _ ] + True + Nothing + False + Nothing + Nothing + Nothing + (Just "ARGUMENT") + (Just "Argument")))) diff --git a/test_resources/docs/some-args/version.txt b/test_resources/docs/some-args/version.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/some-args/version.txt @@ -0,0 +1,1 @@ +some-args 0.0.0 diff --git a/test_resources/docs/sub-commands/config-docs.txt b/test_resources/docs/sub-commands/config-docs.txt --- a/test_resources/docs/sub-commands/config-docs.txt +++ b/test_resources/docs/sub-commands/config-docs.txt @@ -1,12 +1,16 @@ AnyDocsAnd - [ AnyDocsSingle - EnvDoc - { envDocVars = "CONFIG_FILE" :| [] - , envDocDefault = Nothing - , envDocMetavar = Just "FILE_PATH" - , envDocHelp = Just "Path to the configuration file" - } + [ AnyDocsOr + [ AnyDocsSingle + EnvDoc + { envDocVars = "CONFIG_FILE" :| [] + , envDocDefault = Nothing + , envDocExamples = [] + , envDocMetavar = Just "FILE_PATH" + , envDocHelp = Just "Path to the configuration file" + } + ] , AnyDocsCommands + Nothing [ CommandDoc { commandDocArgument = "top" , commandDocHelp = "command without subcommands" @@ -15,6 +19,7 @@ EnvDoc { envDocVars = "NAME" :| [] , envDocDefault = Nothing + , envDocExamples = [ "john" ] , envDocMetavar = Just "NAME" , envDocHelp = Just "name" } @@ -25,6 +30,7 @@ , commandDocs = AnyDocsAnd [ AnyDocsCommands + Nothing [ CommandDoc { commandDocArgument = "a" , commandDocHelp = "A" @@ -37,6 +43,7 @@ } ] , AnyDocsCommands + (Just "c") [ CommandDoc { commandDocArgument = "c" , commandDocHelp = "C" diff --git a/test_resources/docs/sub-commands/config.txt b/test_resources/docs/sub-commands/config.txt --- a/test_resources/docs/sub-commands/config.txt +++ b/test_resources/docs/sub-commands/config.txt @@ -1,4 +1,5 @@ name + example: john name: # or null  diff --git a/test_resources/docs/sub-commands/docs.txt b/test_resources/docs/sub-commands/docs.txt --- a/test_resources/docs/sub-commands/docs.txt +++ b/test_resources/docs/sub-commands/docs.txt @@ -1,36 +1,44 @@ AnyDocsAnd - [ AnyDocsSingle - SetDoc - { setDocTryArgument = False - , setDocTrySwitch = False - , setDocTryOption = True - , setDocDasheds = [ DashedLong ('c' :| "onfig-file") ] - , setDocEnvVars = Just ("CONFIG_FILE" :| []) - , setDocConfKeys = Nothing - , setDocDefault = Nothing - , setDocMetavar = Just "FILE_PATH" - , setDocHelp = Just "Path to the configuration file" - } + [ AnyDocsOr + [ AnyDocsSingle + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = False + , setDocTryOption = True + , setDocDasheds = [ DashedLong ('c' :| "onfig-file") ] + , setDocEnvVars = Just ("CONFIG_FILE" :| []) + , setDocConfKeys = Nothing + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Just "FILE_PATH" + , setDocHelp = Just "Path to the configuration file" + }) + , AnyDocsSingle Nothing + ] , AnyDocsCommands + Nothing [ CommandDoc { commandDocArgument = "top" , commandDocHelp = "command without subcommands" , commandDocs = AnyDocsSingle - SetDoc - { setDocTryArgument = False - , setDocTrySwitch = False - , setDocTryOption = True - , setDocDasheds = [ DashedLong ('n' :| "ame") ] - , setDocEnvVars = Just ("NAME" :| []) - , setDocConfKeys = - Just - (( "name" :| [] , AnyOfSchema (NullSchema :| [ StringSchema ]) ) :| - []) - , setDocDefault = Nothing - , setDocMetavar = Just "NAME" - , setDocHelp = Just "name" - } + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = False + , setDocTryOption = True + , setDocDasheds = [ DashedLong ('n' :| "ame") ] + , setDocEnvVars = Just ("NAME" :| []) + , setDocConfKeys = + Just + (( "name" :| [] , AnyOfSchema (NullSchema :| [ StringSchema ]) ) :| + []) + , setDocDefault = Nothing + , setDocExamples = [ "john" ] + , setDocMetavar = Just "NAME" + , setDocHelp = Just "name" + }) } , CommandDoc { commandDocArgument = "sub" @@ -38,27 +46,29 @@ , commandDocs = AnyDocsAnd [ AnyDocsCommands + Nothing [ CommandDoc { commandDocArgument = "a" , commandDocHelp = "A" - , commandDocs = AnyDocsAnd [] + , commandDocs = AnyDocsSingle Nothing } , CommandDoc { commandDocArgument = "b" , commandDocHelp = "B" - , commandDocs = AnyDocsAnd [] + , commandDocs = AnyDocsSingle Nothing } ] , AnyDocsCommands + (Just "c") [ CommandDoc { commandDocArgument = "c" , commandDocHelp = "C" - , commandDocs = AnyDocsAnd [] + , commandDocs = AnyDocsSingle Nothing } , CommandDoc { commandDocArgument = "d" , commandDocHelp = "D" - , commandDocs = AnyDocsAnd [] + , commandDocs = AnyDocsSingle Nothing } ] ] diff --git a/test_resources/docs/sub-commands/env-docs.txt b/test_resources/docs/sub-commands/env-docs.txt --- a/test_resources/docs/sub-commands/env-docs.txt +++ b/test_resources/docs/sub-commands/env-docs.txt @@ -1,46 +1,53 @@ -AnyDocsCommands - [ CommandDoc - { commandDocArgument = "top" - , commandDocHelp = "command without subcommands" - , commandDocs = - AnyDocsSingle - ConfDoc - { confDocKeys = - ( "name" :| [] , AnyOfSchema (NullSchema :| [ StringSchema ]) ) :| - [] - , confDocDefault = Nothing - , confDocHelp = Just "name" - } - } - , CommandDoc - { commandDocArgument = "sub" - , commandDocHelp = "command with subcommands" - , commandDocs = - AnyDocsAnd - [ AnyDocsCommands - [ CommandDoc - { commandDocArgument = "a" - , commandDocHelp = "A" - , commandDocs = AnyDocsAnd [] - } - , CommandDoc - { commandDocArgument = "b" - , commandDocHelp = "B" - , commandDocs = AnyDocsAnd [] - } - ] - , AnyDocsCommands - [ CommandDoc - { commandDocArgument = "c" - , commandDocHelp = "C" - , commandDocs = AnyDocsAnd [] - } - , CommandDoc - { commandDocArgument = "d" - , commandDocHelp = "D" - , commandDocs = AnyDocsAnd [] - } +AnyDocsAnd + [ AnyDocsOr [] + , AnyDocsCommands + Nothing + [ CommandDoc + { commandDocArgument = "top" + , commandDocHelp = "command without subcommands" + , commandDocs = + AnyDocsSingle + ConfDoc + { confDocKeys = + ( "name" :| [] , AnyOfSchema (NullSchema :| [ StringSchema ]) ) :| + [] + , confDocDefault = Nothing + , confDocExamples = [ "john" ] + , confDocHelp = Just "name" + } + } + , CommandDoc + { commandDocArgument = "sub" + , commandDocHelp = "command with subcommands" + , commandDocs = + AnyDocsAnd + [ AnyDocsCommands + Nothing + [ CommandDoc + { commandDocArgument = "a" + , commandDocHelp = "A" + , commandDocs = AnyDocsAnd [] + } + , CommandDoc + { commandDocArgument = "b" + , commandDocHelp = "B" + , commandDocs = AnyDocsAnd [] + } + ] + , AnyDocsCommands + (Just "c") + [ CommandDoc + { commandDocArgument = "c" + , commandDocHelp = "C" + , commandDocs = AnyDocsAnd [] + } + , CommandDoc + { commandDocArgument = "d" + , commandDocHelp = "D" + , commandDocs = AnyDocsAnd [] + } + ] ] - ] - } + } + ] ] diff --git a/test_resources/docs/sub-commands/env.txt b/test_resources/docs/sub-commands/env.txt --- a/test_resources/docs/sub-commands/env.txt +++ b/test_resources/docs/sub-commands/env.txt @@ -1,2 +1,2 @@ - CONFIG_FILE FILE_PATH Path to the configuration file - NAME NAME name + CONFIG_FILE FILE_PATH Path to the configuration file + NAME NAME name example: john diff --git a/test_resources/docs/sub-commands/help.txt b/test_resources/docs/sub-commands/help.txt --- a/test_resources/docs/sub-commands/help.txt +++ b/test_resources/docs/sub-commands/help.txt @@ -1,4 +1,4 @@ -Usage: sub-commands (-h|--help) | --version | (--config-file FILE_PATH top --name NAME | sub a | b c | d) +Usage: sub-commands [--config-file FILE_PATH] COMMAND example with subcommands @@ -12,30 +12,8 @@ Path to the configuration file option: --config-file FILE_PATH env: CONFIG_FILE FILE_PATH - - command without subcommands - command: top - name - option: --name NAME - env: NAME NAME - config: - name: # or null -  - - - command with subcommands - command: sub - A - command: a - - B - command: b - - C - command: c - - D - command: d - - + +Available commands: + top command without subcommands + sub command with subcommands diff --git a/test_resources/docs/sub-commands/man.txt b/test_resources/docs/sub-commands/man.txt --- a/test_resources/docs/sub-commands/man.txt +++ b/test_resources/docs/sub-commands/man.txt @@ -7,7 +7,7 @@ .Sh VERSION 0.0.0 .Sh SYNOPSIS -sub-commands (-h|--help) | --version | (--config-file FILE_PATH top --name NAME | sub a | b c | d) +sub-commands [--config-file FILE_PATH] COMMAND .Sh SETTINGS Show this help text switch: -h|--help @@ -18,7 +18,8 @@ Path to the configuration file option: --config-file FILE_PATH env: CONFIG_FILE FILE_PATH - + +.Sh COMMANDS command without subcommands command: top name @@ -27,6 +28,7 @@ config: name: # or null + example: john command with subcommands @@ -38,7 +40,7 @@ command: b C - command: c + command: c (default) D command: d @@ -46,23 +48,24 @@ .Sh OPTIONS - -h|--help Show this help text - --version Output version information: 0.0.0 - --config-file Path to the configuration file + -h|--help Show this help text + --version Output version information: 0.0.0 + --config-file Path to the configuration file top command without subcommands - --name name + --name name example: john sub command with subcommands a A b B - c C + c (default) C d D .Sh ENVIRONMENT VARIABLES - CONFIG_FILE FILE_PATH Path to the configuration file - NAME NAME name + CONFIG_FILE FILE_PATH Path to the configuration file + NAME NAME name example: john .Sh CONFIGURATION VALUES name + example: john name: # or null diff --git a/test_resources/docs/sub-commands/nix-options.nix b/test_resources/docs/sub-commands/nix-options.nix new file mode 100644 --- /dev/null +++ b/test_resources/docs/sub-commands/nix-options.nix @@ -0,0 +1,8 @@ +{ lib }: +{ + name = lib.mkOption { + default = null; + description = "name"; + type = lib.types.nullOr lib.types.str; + }; +} diff --git a/test_resources/docs/sub-commands/opt-docs.txt b/test_resources/docs/sub-commands/opt-docs.txt --- a/test_resources/docs/sub-commands/opt-docs.txt +++ b/test_resources/docs/sub-commands/opt-docs.txt @@ -1,29 +1,36 @@ AnyDocsAnd - [ AnyDocsSingle - OptDoc - { optDocTryArgument = False - , optDocTrySwitch = False - , optDocTryOption = True - , optDocDasheds = [ DashedLong ('c' :| "onfig-file") ] - , optDocDefault = Nothing - , optDocMetavar = Just "FILE_PATH" - , optDocHelp = Just "Path to the configuration file" - } + [ AnyDocsOr + [ AnyDocsSingle + (Just + OptDoc + { optDocTryArgument = False + , optDocTrySwitch = False + , optDocTryOption = True + , optDocDasheds = [ DashedLong ('c' :| "onfig-file") ] + , optDocDefault = Nothing + , optDocExamples = [] + , optDocMetavar = Just "FILE_PATH" + , optDocHelp = Just "Path to the configuration file" + }) + ] , AnyDocsCommands + Nothing [ CommandDoc { commandDocArgument = "top" , commandDocHelp = "command without subcommands" , commandDocs = AnyDocsSingle - OptDoc - { optDocTryArgument = False - , optDocTrySwitch = False - , optDocTryOption = True - , optDocDasheds = [ DashedLong ('n' :| "ame") ] - , optDocDefault = Nothing - , optDocMetavar = Just "NAME" - , optDocHelp = Just "name" - } + (Just + OptDoc + { optDocTryArgument = False + , optDocTrySwitch = False + , optDocTryOption = True + , optDocDasheds = [ DashedLong ('n' :| "ame") ] + , optDocDefault = Nothing + , optDocExamples = [ "john" ] + , optDocMetavar = Just "NAME" + , optDocHelp = Just "name" + }) } , CommandDoc { commandDocArgument = "sub" @@ -31,6 +38,7 @@ , commandDocs = AnyDocsAnd [ AnyDocsCommands + Nothing [ CommandDoc { commandDocArgument = "a" , commandDocHelp = "A" @@ -43,6 +51,7 @@ } ] , AnyDocsCommands + (Just "c") [ CommandDoc { commandDocArgument = "c" , commandDocHelp = "C" diff --git a/test_resources/docs/sub-commands/opt-long.txt b/test_resources/docs/sub-commands/opt-long.txt --- a/test_resources/docs/sub-commands/opt-long.txt +++ b/test_resources/docs/sub-commands/opt-long.txt @@ -1,10 +1,8 @@ - -h|--help Show this help text - --version Output version information: 0.0.0 - --config-file Path to the configuration file + --config-file Path to the configuration file top command without subcommands - --name name + --name name example: john sub command with subcommands a A b B - c C + c (default) C d D diff --git a/test_resources/docs/sub-commands/opt-short.txt b/test_resources/docs/sub-commands/opt-short.txt --- a/test_resources/docs/sub-commands/opt-short.txt +++ b/test_resources/docs/sub-commands/opt-short.txt @@ -1,1 +1,1 @@ -sub-commands (-h|--help) | --version | (--config-file FILE_PATH top --name NAME | sub a | b c | d) +sub-commands [--config-file FILE_PATH] COMMAND diff --git a/test_resources/docs/sub-commands/reference.txt b/test_resources/docs/sub-commands/reference.txt --- a/test_resources/docs/sub-commands/reference.txt +++ b/test_resources/docs/sub-commands/reference.txt @@ -1,16 +1,17 @@ -Usage: sub-commands (-h|--help) | --version | (--config-file FILE_PATH top --name NAME | sub a | b c | d) +Usage: sub-commands [--config-file FILE_PATH] COMMAND All settings: Show this help text switch: -h|--help - Output version information: 0.0.0 + Output version information switch: --version Path to the configuration file option: --config-file FILE_PATH env: CONFIG_FILE FILE_PATH - + +All commands: command without subcommands command: top name @@ -19,6 +20,7 @@ config: name: # or null  + example: john command with subcommands @@ -30,7 +32,7 @@ command: b C - command: c + command: c (default) D command: d @@ -38,23 +40,24 @@ Options: - -h|--help Show this help text - --version Output version information: 0.0.0 - --config-file Path to the configuration file + -h|--help Show this help text + --version Output version information + --config-file Path to the configuration file top command without subcommands - --name name + --name name example: john sub command with subcommands a A b B - c C + c (default) C d D Environment Variables: - CONFIG_FILE FILE_PATH Path to the configuration file - NAME NAME name + CONFIG_FILE FILE_PATH Path to the configuration file + NAME NAME name example: john Configuration Values: name + example: john name: # or null  diff --git a/test_resources/docs/sub-commands/show.txt b/test_resources/docs/sub-commands/show.txt --- a/test_resources/docs/sub-commands/show.txt +++ b/test_resources/docs/sub-commands/show.txt @@ -1,5 +1,6 @@ WithConfig _ + Nothing (Check Nothing False @@ -24,16 +25,8 @@ (Just "Path to the configuration file")))) (Check Nothing False _ (Pure _)))) (Commands - (Just - SrcLoc - { srcLocPackage = "main" - , srcLocModule = "OptEnvConf.APISpec" - , srcLocFile = "test/OptEnvConf/APISpec.hs" - , srcLocStartLine = 273 - , srcLocStartCol = 5 - , srcLocEndLine = 273 - , srcLocEndCol = 13 - }) + Nothing + Nothing [ Command "top" "command without subcommands" @@ -51,16 +44,16 @@ True (Just ("NAME" :| [])) (Just - [ ( "name" :| [] - , BimapCodec - _ - _ - (EitherCodec - PossiblyJointUnion - NullCodec - (BimapCodec _ _ (StringCodec Nothing))) - ) - ]) + (ConfigValSetting + ("name" :| []) + BimapCodec + _ + _ + (EitherCodec + PossiblyJointUnion + NullCodec + (BimapCodec _ _ (StringCodec Nothing))) :| + [])) Nothing (Just "NAME") (Just "name")))) @@ -69,27 +62,11 @@ "command with subcommands" (Ap (Commands - (Just - SrcLoc - { srcLocPackage = "main" - , srcLocModule = "OptEnvConf.APISpec" - , srcLocFile = "test/OptEnvConf/APISpec.hs" - , srcLocStartLine = 289 - , srcLocStartCol = 3 - , srcLocEndLine = 289 - , srcLocEndCol = 11 - }) + Nothing + Nothing [ Command "a" "A" (Pure _) , Command "b" "B" (Pure _) ]) (Commands - (Just - SrcLoc - { srcLocPackage = "main" - , srcLocModule = "OptEnvConf.APISpec" - , srcLocFile = "test/OptEnvConf/APISpec.hs" - , srcLocStartLine = 298 - , srcLocStartCol = 3 - , srcLocEndLine = 298 - , srcLocEndCol = 11 - }) + Nothing + (Just "c") [ Command "c" "C" (Pure _) , Command "d" "D" (Pure _) ])) ]) diff --git a/test_resources/docs/sub-settings/config-docs.txt b/test_resources/docs/sub-settings/config-docs.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/sub-settings/config-docs.txt @@ -0,0 +1,20 @@ +AnyDocsAnd + [ AnyDocsOr + [ AnyDocsSingle + EnvDoc + { envDocVars = "CONFIG_FILE" :| [] + , envDocDefault = Nothing + , envDocExamples = [] + , envDocMetavar = Just "FILE_PATH" + , envDocHelp = Just "Path to the configuration file" + } + ] + , AnyDocsSingle + EnvDoc + { envDocVars = "FOO_BAR_QUUX" :| [] + , envDocDefault = Nothing + , envDocExamples = [] + , envDocMetavar = Just "STR" + , envDocHelp = Just "Example with sub-settings" + } + ] diff --git a/test_resources/docs/sub-settings/config.txt b/test_resources/docs/sub-settings/config.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/sub-settings/config.txt @@ -0,0 +1,4 @@ + Example with sub-settings + foo.bar.quux: + # or null +  diff --git a/test_resources/docs/sub-settings/docs.txt b/test_resources/docs/sub-settings/docs.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/sub-settings/docs.txt @@ -0,0 +1,38 @@ +AnyDocsAnd + [ AnyDocsOr + [ AnyDocsSingle + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = False + , setDocTryOption = True + , setDocDasheds = [ DashedLong ('c' :| "onfig-file") ] + , setDocEnvVars = Just ("CONFIG_FILE" :| []) + , setDocConfKeys = Nothing + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Just "FILE_PATH" + , setDocHelp = Just "Path to the configuration file" + }) + , AnyDocsSingle Nothing + ] + , AnyDocsSingle + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = False + , setDocTryOption = True + , setDocDasheds = [ DashedLong ('f' :| "oo-bar-quux") ] + , setDocEnvVars = Just ("FOO_BAR_QUUX" :| []) + , setDocConfKeys = + Just + (( "foo" :| [ "bar" , "quux" ] + , AnyOfSchema (NullSchema :| [ StringSchema ]) + ) :| + []) + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Just "STR" + , setDocHelp = Just "Example with sub-settings" + }) + ] diff --git a/test_resources/docs/sub-settings/env-docs.txt b/test_resources/docs/sub-settings/env-docs.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/sub-settings/env-docs.txt @@ -0,0 +1,14 @@ +AnyDocsAnd + [ AnyDocsOr [] + , AnyDocsSingle + ConfDoc + { confDocKeys = + ( "foo" :| [ "bar" , "quux" ] + , AnyOfSchema (NullSchema :| [ StringSchema ]) + ) :| + [] + , confDocDefault = Nothing + , confDocExamples = [] + , confDocHelp = Just "Example with sub-settings" + } + ] diff --git a/test_resources/docs/sub-settings/env.txt b/test_resources/docs/sub-settings/env.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/sub-settings/env.txt @@ -0,0 +1,2 @@ + CONFIG_FILE FILE_PATH Path to the configuration file + FOO_BAR_QUUX STR Example with sub-settings diff --git a/test_resources/docs/sub-settings/help.txt b/test_resources/docs/sub-settings/help.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/sub-settings/help.txt @@ -0,0 +1,22 @@ +Usage: sub-settings [--config-file FILE_PATH] --foo-bar-quux STR + +example with a sub settings + +Available settings: + Show this help text + switch: -h|--help + + Output version information: 0.0.0 + switch: --version + + Path to the configuration file + option: --config-file FILE_PATH + env: CONFIG_FILE FILE_PATH + + Example with sub-settings + option: --foo-bar-quux STR + env: FOO_BAR_QUUX STR + config: + foo.bar.quux: # or null +  + diff --git a/test_resources/docs/sub-settings/man.txt b/test_resources/docs/sub-settings/man.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/sub-settings/man.txt @@ -0,0 +1,44 @@ +.Dd $Mdocdate$ +.Dt sub-settings 1 +.Os +.Sh NAME +.Nm sub-settings +.Nd example with a sub settings +.Sh VERSION +0.0.0 +.Sh SYNOPSIS +sub-settings [--config-file FILE_PATH] --foo-bar-quux STR +.Sh SETTINGS + Show this help text + switch: -h|--help + + Output version information: 0.0.0 + switch: --version + + Path to the configuration file + option: --config-file FILE_PATH + env: CONFIG_FILE FILE_PATH + + Example with sub-settings + option: --foo-bar-quux STR + env: FOO_BAR_QUUX STR + config: + foo.bar.quux: # or null + + +.Sh OPTIONS + -h|--help Show this help text + --version Output version information: 0.0.0 + --config-file Path to the configuration file + --foo-bar-quux Example with sub-settings + +.Sh ENVIRONMENT VARIABLES + CONFIG_FILE FILE_PATH Path to the configuration file + FOO_BAR_QUUX STR Example with sub-settings + +.Sh CONFIGURATION VALUES + Example with sub-settings + foo.bar.quux: + # or null + + diff --git a/test_resources/docs/sub-settings/nix-options.nix b/test_resources/docs/sub-settings/nix-options.nix new file mode 100644 --- /dev/null +++ b/test_resources/docs/sub-settings/nix-options.nix @@ -0,0 +1,22 @@ +{ lib }: +{ + foo = lib.mkOption { + default = { }; + type = lib.types.submodule { + options = { + bar = lib.mkOption { + default = { }; + type = lib.types.submodule { + options = { + quux = lib.mkOption { + default = null; + description = "Example with sub-settings"; + type = lib.types.nullOr lib.types.str; + }; + }; + }; + }; + }; + }; + }; +} diff --git a/test_resources/docs/sub-settings/opt-docs.txt b/test_resources/docs/sub-settings/opt-docs.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/sub-settings/opt-docs.txt @@ -0,0 +1,28 @@ +AnyDocsAnd + [ AnyDocsOr + [ AnyDocsSingle + (Just + OptDoc + { optDocTryArgument = False + , optDocTrySwitch = False + , optDocTryOption = True + , optDocDasheds = [ DashedLong ('c' :| "onfig-file") ] + , optDocDefault = Nothing + , optDocExamples = [] + , optDocMetavar = Just "FILE_PATH" + , optDocHelp = Just "Path to the configuration file" + }) + ] + , AnyDocsSingle + (Just + OptDoc + { optDocTryArgument = False + , optDocTrySwitch = False + , optDocTryOption = True + , optDocDasheds = [ DashedLong ('f' :| "oo-bar-quux") ] + , optDocDefault = Nothing + , optDocExamples = [] + , optDocMetavar = Just "STR" + , optDocHelp = Just "Example with sub-settings" + }) + ] diff --git a/test_resources/docs/sub-settings/opt-long.txt b/test_resources/docs/sub-settings/opt-long.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/sub-settings/opt-long.txt @@ -0,0 +1,2 @@ + --config-file Path to the configuration file + --foo-bar-quux Example with sub-settings diff --git a/test_resources/docs/sub-settings/opt-short.txt b/test_resources/docs/sub-settings/opt-short.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/sub-settings/opt-short.txt @@ -0,0 +1,1 @@ +sub-settings [--config-file FILE_PATH] --foo-bar-quux STR diff --git a/test_resources/docs/sub-settings/reference.txt b/test_resources/docs/sub-settings/reference.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/sub-settings/reference.txt @@ -0,0 +1,36 @@ +Usage: sub-settings [--config-file FILE_PATH] --foo-bar-quux STR + +All settings: + Show this help text + switch: -h|--help + + Output version information + switch: --version + + Path to the configuration file + option: --config-file FILE_PATH + env: CONFIG_FILE FILE_PATH + + Example with sub-settings + option: --foo-bar-quux STR + env: FOO_BAR_QUUX STR + config: + foo.bar.quux: # or null +  + +Options: + -h|--help Show this help text + --version Output version information + --config-file Path to the configuration file + --foo-bar-quux Example with sub-settings + +Environment Variables: + CONFIG_FILE FILE_PATH Path to the configuration file + FOO_BAR_QUUX STR Example with sub-settings + +Configuration Values: + Example with sub-settings + foo.bar.quux: + # or null +  + diff --git a/test_resources/docs/sub-settings/show.txt b/test_resources/docs/sub-settings/show.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/sub-settings/show.txt @@ -0,0 +1,49 @@ +WithConfig + _ + Nothing + (Check + Nothing + False + _ + (Alt + (Check + Nothing + False + _ + (Setting + Nothing + (Setting + [ DashedLong ('c' :| "onfig-file") ] + [ _ ] + False + Nothing + True + (Just ("CONFIG_FILE" :| [])) + Nothing + Nothing + (Just "FILE_PATH") + (Just "Path to the configuration file")))) + (Check Nothing False _ (Pure _)))) + (Setting + Nothing + (Setting + [ DashedLong ('f' :| "oo-bar-quux") ] + [ _ ] + False + Nothing + True + (Just ("FOO_BAR_QUUX" :| [])) + (Just + (ConfigValSetting + ("foo" :| [ "bar" , "quux" ]) + BimapCodec + _ + _ + (EitherCodec + PossiblyJointUnion + NullCodec + (BimapCodec _ _ (StringCodec Nothing))) :| + [])) + Nothing + (Just "STR") + (Just "Example with sub-settings"))) diff --git a/test_resources/docs/sub-settings/version.txt b/test_resources/docs/sub-settings/version.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/sub-settings/version.txt @@ -0,0 +1,1 @@ +sub-settings 0.0.0 diff --git a/test_resources/docs/sum-type/config-docs.txt b/test_resources/docs/sum-type/config-docs.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/sum-type/config-docs.txt @@ -0,0 +1,10 @@ +AnyDocsOr + [ AnyDocsSingle + EnvDoc + { envDocVars = "sum-type" :| [] + , envDocDefault = Nothing + , envDocExamples = [] + , envDocMetavar = Just "SUM_TYPE" + , envDocHelp = Just "example" + } + ] diff --git a/test_resources/docs/sum-type/config.txt b/test_resources/docs/sum-type/config.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/sum-type/config.txt @@ -0,0 +1,4 @@ + example + sum-type: + # or null +  diff --git a/test_resources/docs/sum-type/docs.txt b/test_resources/docs/sum-type/docs.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/sum-type/docs.txt @@ -0,0 +1,80 @@ +AnyDocsAnd + [ AnyDocsSingle Nothing + , AnyDocsOr + [ AnyDocsSingle + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = True + , setDocTryOption = False + , setDocDasheds = [ DashedShort 'a' ] + , setDocEnvVars = Nothing + , setDocConfKeys = Nothing + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Nothing + , setDocHelp = Just "a" + }) + , AnyDocsSingle + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = True + , setDocTryOption = False + , setDocDasheds = [ DashedShort 'b' ] + , setDocEnvVars = Nothing + , setDocConfKeys = Nothing + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Nothing + , setDocHelp = Just "b" + }) + , AnyDocsSingle + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = False + , setDocTryOption = False + , setDocDasheds = [] + , setDocEnvVars = Just ("sum-type" :| []) + , setDocConfKeys = Nothing + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Just "SUM_TYPE" + , setDocHelp = Just "example" + }) + , AnyDocsSingle + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = False + , setDocTryOption = False + , setDocDasheds = [] + , setDocEnvVars = Nothing + , setDocConfKeys = + Just + (( "sum-type" :| [] + , AnyOfSchema (NullSchema :| [ StringSchema ]) + ) :| + []) + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Nothing + , setDocHelp = Just "example" + }) + , AnyDocsSingle + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = False + , setDocTryOption = False + , setDocDasheds = [] + , setDocEnvVars = Nothing + , setDocConfKeys = Nothing + , setDocDefault = Just "a" + , setDocExamples = [] + , setDocMetavar = Nothing + , setDocHelp = Just "example" + }) + ] + ] diff --git a/test_resources/docs/sum-type/env-docs.txt b/test_resources/docs/sum-type/env-docs.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/sum-type/env-docs.txt @@ -0,0 +1,13 @@ +AnyDocsOr + [ AnyDocsSingle + ConfDoc + { confDocKeys = + ( "sum-type" :| [] + , AnyOfSchema (NullSchema :| [ StringSchema ]) + ) :| + [] + , confDocDefault = Nothing + , confDocExamples = [] + , confDocHelp = Just "example" + } + ] diff --git a/test_resources/docs/sum-type/env.txt b/test_resources/docs/sum-type/env.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/sum-type/env.txt @@ -0,0 +1,1 @@ + sum-type SUM_TYPE example diff --git a/test_resources/docs/sum-type/help.txt b/test_resources/docs/sum-type/help.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/sum-type/help.txt @@ -0,0 +1,24 @@ +Usage: sum-type [-a | -b] + +Sum type example + +Available settings: + Show this help text + switch: -h|--help + + Output version information: 0.0.0 + switch: --version + + a + switch: -a + + b + switch: -b + + example + env: sum-type SUM_TYPE + config: + sum-type: # or null +  + default: a + diff --git a/test_resources/docs/sum-type/man.txt b/test_resources/docs/sum-type/man.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/sum-type/man.txt @@ -0,0 +1,45 @@ +.Dd $Mdocdate$ +.Dt sum-type 1 +.Os +.Sh NAME +.Nm sum-type +.Nd Sum type example +.Sh VERSION +0.0.0 +.Sh SYNOPSIS +sum-type [-a | -b] +.Sh SETTINGS + Show this help text + switch: -h|--help + + Output version information: 0.0.0 + switch: --version + + a + switch: -a + + b + switch: -b + + example + env: sum-type SUM_TYPE + config: + sum-type: # or null + + default: a + +.Sh OPTIONS + -h|--help Show this help text + --version Output version information: 0.0.0 + -a a + -b b + +.Sh ENVIRONMENT VARIABLES + sum-type SUM_TYPE example + +.Sh CONFIGURATION VALUES + example + sum-type: + # or null + + diff --git a/test_resources/docs/sum-type/nix-options.nix b/test_resources/docs/sum-type/nix-options.nix new file mode 100644 --- /dev/null +++ b/test_resources/docs/sum-type/nix-options.nix @@ -0,0 +1,8 @@ +{ lib }: +{ + sum-type = lib.mkOption { + default = null; + description = "example"; + type = lib.types.nullOr lib.types.str; + }; +} diff --git a/test_resources/docs/sum-type/opt-docs.txt b/test_resources/docs/sum-type/opt-docs.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/sum-type/opt-docs.txt @@ -0,0 +1,29 @@ +AnyDocsOr + [ AnyDocsSingle + (Just + OptDoc + { optDocTryArgument = False + , optDocTrySwitch = True + , optDocTryOption = False + , optDocDasheds = [ DashedShort 'a' ] + , optDocDefault = Nothing + , optDocExamples = [] + , optDocMetavar = Nothing + , optDocHelp = Just "a" + }) + , AnyDocsSingle + (Just + OptDoc + { optDocTryArgument = False + , optDocTrySwitch = True + , optDocTryOption = False + , optDocDasheds = [ DashedShort 'b' ] + , optDocDefault = Nothing + , optDocExamples = [] + , optDocMetavar = Nothing + , optDocHelp = Just "b" + }) + , AnyDocsSingle Nothing + , AnyDocsSingle Nothing + , AnyDocsSingle Nothing + ] diff --git a/test_resources/docs/sum-type/opt-long.txt b/test_resources/docs/sum-type/opt-long.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/sum-type/opt-long.txt @@ -0,0 +1,2 @@ + -a a + -b b diff --git a/test_resources/docs/sum-type/opt-short.txt b/test_resources/docs/sum-type/opt-short.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/sum-type/opt-short.txt @@ -0,0 +1,1 @@ +sum-type [-a | -b] diff --git a/test_resources/docs/sum-type/reference.txt b/test_resources/docs/sum-type/reference.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/sum-type/reference.txt @@ -0,0 +1,37 @@ +Usage: sum-type [-a | -b] + +All settings: + Show this help text + switch: -h|--help + + Output version information + switch: --version + + a + switch: -a + + b + switch: -b + + example + env: sum-type SUM_TYPE + config: + sum-type: # or null +  + default: a + +Options: + -h|--help Show this help text + --version Output version information + -a a + -b b + +Environment Variables: + sum-type SUM_TYPE example + +Configuration Values: + example + sum-type: + # or null +  + diff --git a/test_resources/docs/sum-type/show.txt b/test_resources/docs/sum-type/show.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/sum-type/show.txt @@ -0,0 +1,83 @@ +WithConfig + _ + Nothing + (Pure _) + (Alt + (Setting + Nothing + (Setting + [ DashedShort 'a' ] + [] + False + (Just _) + False + Nothing + Nothing + Nothing + Nothing + (Just "a"))) + (Alt + (Setting + Nothing + (Setting + [ DashedShort 'b' ] + [] + False + (Just _) + False + Nothing + Nothing + Nothing + Nothing + (Just "b"))) + (Alt + (Setting + Nothing + (Setting + [] + [ _ ] + False + Nothing + False + (Just ("sum-type" :| [])) + Nothing + Nothing + (Just "SUM_TYPE") + (Just "example"))) + (Alt + (Setting + Nothing + (Setting + [] + [] + False + Nothing + False + Nothing + (Just + (ConfigValSetting + ("sum-type" :| []) + BimapCodec + _ + _ + (EitherCodec + PossiblyJointUnion + NullCodec + (BimapCodec _ _ (StringCodec Nothing))) :| + [])) + Nothing + Nothing + (Just "example"))) + (Setting + Nothing + (Setting + [] + [] + False + Nothing + False + Nothing + Nothing + (Just _) + Nothing + (Just "example"))))))) diff --git a/test_resources/docs/sum-type/version.txt b/test_resources/docs/sum-type/version.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/sum-type/version.txt @@ -0,0 +1,1 @@ +sum-type 0.0.0 diff --git a/test_resources/docs/three-commands/config-docs.txt b/test_resources/docs/three-commands/config-docs.txt --- a/test_resources/docs/three-commands/config-docs.txt +++ b/test_resources/docs/three-commands/config-docs.txt @@ -1,42 +1,38 @@ -AnyDocsAnd - [ AnyDocsSingle - EnvDoc - { envDocVars = "CONFIG_FILE" :| [] - , envDocDefault = Nothing - , envDocMetavar = Just "FILE_PATH" - , envDocHelp = Just "Path to the configuration file" - } - , AnyDocsCommands - [ CommandDoc - { commandDocArgument = "one" - , commandDocHelp = "first" - , commandDocs = AnyDocsAnd [] - } - , CommandDoc - { commandDocArgument = "two" - , commandDocHelp = "second" - , commandDocs = - AnyDocsAnd +AnyDocsCommands + (Just "one") + [ CommandDoc + { commandDocArgument = "one" + , commandDocHelp = "first" + , commandDocs = AnyDocsAnd [] + } + , CommandDoc + { commandDocArgument = "two" + , commandDocHelp = "second" + , commandDocs = + AnyDocsAnd + [ AnyDocsSingle + EnvDoc + { envDocVars = "NUMBER" :| [] + , envDocDefault = Nothing + , envDocExamples = [ "5" ] + , envDocMetavar = Just "INT" + , envDocHelp = Just "number" + } + , AnyDocsOr [ AnyDocsSingle EnvDoc - { envDocVars = "NUMBER" :| [] - , envDocDefault = Nothing - , envDocMetavar = Just "INT" - , envDocHelp = Just "number" - } - , AnyDocsSingle - EnvDoc { envDocVars = "ENABLE" :| [] , envDocDefault = Nothing + , envDocExamples = [] , envDocMetavar = Just "BOOL" , envDocHelp = Just "enable extra" } ] - } - , CommandDoc - { commandDocArgument = "three" - , commandDocHelp = "third" - , commandDocs = AnyDocsAnd [] - } - ] + ] + } + , CommandDoc + { commandDocArgument = "three-very-long-command-name" + , commandDocHelp = "third" + , commandDocs = AnyDocsAnd [] + } ] diff --git a/test_resources/docs/three-commands/config.txt b/test_resources/docs/three-commands/config.txt --- a/test_resources/docs/three-commands/config.txt +++ b/test_resources/docs/three-commands/config.txt @@ -1,7 +1,8 @@ number + example: 5 number: # or null -  # 64 bit signed integer +  # 64 bit signed integer enable extra enable: # or null diff --git a/test_resources/docs/three-commands/docs.txt b/test_resources/docs/three-commands/docs.txt --- a/test_resources/docs/three-commands/docs.txt +++ b/test_resources/docs/three-commands/docs.txt @@ -1,33 +1,25 @@ AnyDocsAnd - [ AnyDocsSingle - SetDoc - { setDocTryArgument = False - , setDocTrySwitch = False - , setDocTryOption = True - , setDocDasheds = [ DashedLong ('c' :| "onfig-file") ] - , setDocEnvVars = Just ("CONFIG_FILE" :| []) - , setDocConfKeys = Nothing - , setDocDefault = Nothing - , setDocMetavar = Just "FILE_PATH" - , setDocHelp = Just "Path to the configuration file" - } + [ AnyDocsSingle Nothing , AnyDocsCommands + (Just "one") [ CommandDoc { commandDocArgument = "one" , commandDocHelp = "first" , commandDocs = AnyDocsSingle - SetDoc - { setDocTryArgument = True - , setDocTrySwitch = False - , setDocTryOption = False - , setDocDasheds = [] - , setDocEnvVars = Nothing - , setDocConfKeys = Nothing - , setDocDefault = Nothing - , setDocMetavar = Just "STR" - , setDocHelp = Just "argument" - } + (Just + SetDoc + { setDocTryArgument = True + , setDocTrySwitch = False + , setDocTryOption = False + , setDocDasheds = [] + , setDocEnvVars = Nothing + , setDocConfKeys = Nothing + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Just "STR" + , setDocHelp = Just "argument" + }) } , CommandDoc { commandDocArgument = "two" @@ -35,77 +27,89 @@ , commandDocs = AnyDocsAnd [ AnyDocsSingle - SetDoc - { setDocTryArgument = False - , setDocTrySwitch = False - , setDocTryOption = True - , setDocDasheds = [ DashedLong ('n' :| "umber") , DashedShort 'n' ] - , setDocEnvVars = Just ("NUMBER" :| []) - , setDocConfKeys = - Just - (( "number" :| [] - , AnyOfSchema - (NullSchema :| - [ NumberSchema - (Just - NumberBounds - { numberBoundsLower = -9.223372036854775808e18 - , numberBoundsUpper = 9.223372036854775807e18 - }) - ]) - ) :| - []) - , setDocDefault = Nothing - , setDocMetavar = Just "INT" - , setDocHelp = Just "number" - } + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = False + , setDocTryOption = True + , setDocDasheds = [ DashedLong ('n' :| "umber") , DashedShort 'n' ] + , setDocEnvVars = Just ("NUMBER" :| []) + , setDocConfKeys = + Just + (( "number" :| [] + , AnyOfSchema + (NullSchema :| + [ IntegerSchema + Bounds + { boundsLower = Just (-9223372036854775808) + , boundsUpper = Just 9223372036854775807 + } + ]) + ) :| + []) + , setDocDefault = Nothing + , setDocExamples = [ "5" ] + , setDocMetavar = Just "INT" + , setDocHelp = Just "number" + }) , AnyDocsOr [ AnyDocsSingle - SetDoc - { setDocTryArgument = False - , setDocTrySwitch = True - , setDocTryOption = False - , setDocDasheds = [ DashedLong ('(' :| "enable|disable)-enable") ] - , setDocEnvVars = Nothing - , setDocConfKeys = Nothing - , setDocDefault = Nothing - , setDocMetavar = Nothing - , setDocHelp = Just "enable extra" - } + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = True + , setDocTryOption = False + , setDocDasheds = [ DashedLong ('(' :| "enable|disable)-enable") ] + , setDocEnvVars = Nothing + , setDocConfKeys = Nothing + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Nothing + , setDocHelp = Just "enable extra" + }) + , AnyDocsSingle Nothing + , AnyDocsSingle Nothing , AnyDocsSingle - SetDoc - { setDocTryArgument = False - , setDocTrySwitch = False - , setDocTryOption = False - , setDocDasheds = [] - , setDocEnvVars = Just ("ENABLE" :| []) - , setDocConfKeys = Nothing - , setDocDefault = Nothing - , setDocMetavar = Just "BOOL" - , setDocHelp = Just "enable extra" - } + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = False + , setDocTryOption = False + , setDocDasheds = [] + , setDocEnvVars = Just ("ENABLE" :| []) + , setDocConfKeys = Nothing + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Just "BOOL" + , setDocHelp = Just "enable extra" + }) , AnyDocsSingle - SetDoc - { setDocTryArgument = False - , setDocTrySwitch = False - , setDocTryOption = False - , setDocDasheds = [] - , setDocEnvVars = Nothing - , setDocConfKeys = - Just - (( "enable" :| [] , AnyOfSchema (NullSchema :| [ BoolSchema ]) ) :| - []) - , setDocDefault = Nothing - , setDocMetavar = Nothing - , setDocHelp = Just "enable extra" - } + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = False + , setDocTryOption = False + , setDocDasheds = [] + , setDocEnvVars = Nothing + , setDocConfKeys = + Just + (( "enable" :| [] + , AnyOfSchema (NullSchema :| [ BoolSchema ]) + ) :| + []) + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Nothing + , setDocHelp = Just "enable extra" + }) + , AnyDocsSingle Nothing ] ] } , CommandDoc - { commandDocArgument = "three" + { commandDocArgument = "three-very-long-command-name" , commandDocHelp = "third" - , commandDocs = AnyDocsAnd [] + , commandDocs = AnyDocsSingle Nothing } ] ] diff --git a/test_resources/docs/three-commands/env-docs.txt b/test_resources/docs/three-commands/env-docs.txt --- a/test_resources/docs/three-commands/env-docs.txt +++ b/test_resources/docs/three-commands/env-docs.txt @@ -1,4 +1,5 @@ AnyDocsCommands + (Just "one") [ CommandDoc { commandDocArgument = "one" , commandDocHelp = "first" @@ -15,30 +16,33 @@ ( "number" :| [] , AnyOfSchema (NullSchema :| - [ NumberSchema - (Just - NumberBounds - { numberBoundsLower = -9.223372036854775808e18 - , numberBoundsUpper = 9.223372036854775807e18 - }) + [ IntegerSchema + Bounds + { boundsLower = Just (-9223372036854775808) + , boundsUpper = Just 9223372036854775807 + } ]) ) :| [] , confDocDefault = Nothing + , confDocExamples = [ "5" ] , confDocHelp = Just "number" } - , AnyDocsSingle - ConfDoc - { confDocKeys = - ( "enable" :| [] , AnyOfSchema (NullSchema :| [ BoolSchema ]) ) :| - [] - , confDocDefault = Nothing - , confDocHelp = Just "enable extra" - } + , AnyDocsOr + [ AnyDocsSingle + ConfDoc + { confDocKeys = + ( "enable" :| [] , AnyOfSchema (NullSchema :| [ BoolSchema ]) ) :| + [] + , confDocDefault = Nothing + , confDocExamples = [] + , confDocHelp = Just "enable extra" + } + ] ] } , CommandDoc - { commandDocArgument = "three" + { commandDocArgument = "three-very-long-command-name" , commandDocHelp = "third" , commandDocs = AnyDocsAnd [] } diff --git a/test_resources/docs/three-commands/env.txt b/test_resources/docs/three-commands/env.txt --- a/test_resources/docs/three-commands/env.txt +++ b/test_resources/docs/three-commands/env.txt @@ -1,3 +1,2 @@ - CONFIG_FILE FILE_PATH Path to the configuration file - NUMBER INT number - ENABLE BOOL enable extra + NUMBER INT number example: 5 + ENABLE BOOL enable extra diff --git a/test_resources/docs/three-commands/help.txt b/test_resources/docs/three-commands/help.txt --- a/test_resources/docs/three-commands/help.txt +++ b/test_resources/docs/three-commands/help.txt @@ -1,4 +1,4 @@ -Usage: three-commands (-h|--help) | --version | (--config-file FILE_PATH one STR | two --number|-n INT --(enable|disable)-enable | three) +Usage: three-commands [COMMAND] example with three commands @@ -9,34 +9,8 @@ Output version information: 0.0.0 switch: --version - Path to the configuration file - option: --config-file FILE_PATH - env: CONFIG_FILE FILE_PATH - - first - command: one - argument - argument: STR - - - second - command: two - number - option: --number|-n INT - env: NUMBER INT - config: - number: # or null -  # 64 bit signed integer - - enable extra - switch: --(enable|disable)-enable - env: ENABLE BOOL - config: - enable: # or null -  - - - third - command: three - +Available commands: + one (default) first + two second + three-very-long-command-name third diff --git a/test_resources/docs/three-commands/man.txt b/test_resources/docs/three-commands/man.txt --- a/test_resources/docs/three-commands/man.txt +++ b/test_resources/docs/three-commands/man.txt @@ -7,7 +7,7 @@ .Sh VERSION 0.0.0 .Sh SYNOPSIS -three-commands (-h|--help) | --version | (--config-file FILE_PATH one STR | two --number|-n INT --(enable|disable)-enable | three) +three-commands [COMMAND] .Sh SETTINGS Show this help text switch: -h|--help @@ -15,12 +15,9 @@ Output version information: 0.0.0 switch: --version - Path to the configuration file - option: --config-file FILE_PATH - env: CONFIG_FILE FILE_PATH - +.Sh COMMANDS first - command: one + command: one (default) argument argument: STR @@ -32,7 +29,8 @@ env: NUMBER INT config: number: # or null - # 64 bit signed integer + # 64 bit signed integer + example: 5 enable extra switch: --(enable|disable)-enable @@ -43,30 +41,29 @@ third - command: three + command: three-very-long-command-name .Sh OPTIONS - -h|--help Show this help text - --version Output version information: 0.0.0 - --config-file Path to the configuration file - one first - STR argument + -h|--help Show this help text + --version Output version information: 0.0.0 + one (default) first + STR argument two second - --number|-n number - --(enable|disable)-enable enable extra - three third + --number|-n number example: 5 + --(enable|disable)-enable enable extra + three-very-long-command-name third .Sh ENVIRONMENT VARIABLES - CONFIG_FILE FILE_PATH Path to the configuration file - NUMBER INT number - ENABLE BOOL enable extra + NUMBER INT number example: 5 + ENABLE BOOL enable extra .Sh CONFIGURATION VALUES number + example: 5 number: # or null - # 64 bit signed integer + # 64 bit signed integer enable extra enable: # or null diff --git a/test_resources/docs/three-commands/nix-options.nix b/test_resources/docs/three-commands/nix-options.nix new file mode 100644 --- /dev/null +++ b/test_resources/docs/three-commands/nix-options.nix @@ -0,0 +1,13 @@ +{ lib }: +{ + enable = lib.mkOption { + default = null; + description = "enable extra"; + type = lib.types.nullOr lib.types.bool; + }; + number = lib.mkOption { + default = null; + description = "number"; + type = lib.types.nullOr lib.types.int; + }; +} diff --git a/test_resources/docs/three-commands/opt-docs.txt b/test_resources/docs/three-commands/opt-docs.txt --- a/test_resources/docs/three-commands/opt-docs.txt +++ b/test_resources/docs/three-commands/opt-docs.txt @@ -1,61 +1,60 @@ -AnyDocsAnd - [ AnyDocsSingle - OptDoc - { optDocTryArgument = False - , optDocTrySwitch = False - , optDocTryOption = True - , optDocDasheds = [ DashedLong ('c' :| "onfig-file") ] - , optDocDefault = Nothing - , optDocMetavar = Just "FILE_PATH" - , optDocHelp = Just "Path to the configuration file" - } - , AnyDocsCommands - [ CommandDoc - { commandDocArgument = "one" - , commandDocHelp = "first" - , commandDocs = - AnyDocsSingle - OptDoc - { optDocTryArgument = True - , optDocTrySwitch = False - , optDocTryOption = False - , optDocDasheds = [] - , optDocDefault = Nothing - , optDocMetavar = Just "STR" - , optDocHelp = Just "argument" - } - } - , CommandDoc - { commandDocArgument = "two" - , commandDocHelp = "second" - , commandDocs = - AnyDocsAnd +AnyDocsCommands + (Just "one") + [ CommandDoc + { commandDocArgument = "one" + , commandDocHelp = "first" + , commandDocs = + AnyDocsSingle + (Just + OptDoc + { optDocTryArgument = True + , optDocTrySwitch = False + , optDocTryOption = False + , optDocDasheds = [] + , optDocDefault = Nothing + , optDocExamples = [] + , optDocMetavar = Just "STR" + , optDocHelp = Just "argument" + }) + } + , CommandDoc + { commandDocArgument = "two" + , commandDocHelp = "second" + , commandDocs = + AnyDocsAnd + [ AnyDocsSingle + (Just + OptDoc + { optDocTryArgument = False + , optDocTrySwitch = False + , optDocTryOption = True + , optDocDasheds = [ DashedLong ('n' :| "umber") , DashedShort 'n' ] + , optDocDefault = Nothing + , optDocExamples = [ "5" ] + , optDocMetavar = Just "INT" + , optDocHelp = Just "number" + }) + , AnyDocsOr [ AnyDocsSingle - OptDoc - { optDocTryArgument = False - , optDocTrySwitch = False - , optDocTryOption = True - , optDocDasheds = [ DashedLong ('n' :| "umber") , DashedShort 'n' ] - , optDocDefault = Nothing - , optDocMetavar = Just "INT" - , optDocHelp = Just "number" - } - , AnyDocsSingle - OptDoc - { optDocTryArgument = False - , optDocTrySwitch = True - , optDocTryOption = False - , optDocDasheds = [ DashedLong ('(' :| "enable|disable)-enable") ] - , optDocDefault = Nothing - , optDocMetavar = Nothing - , optDocHelp = Just "enable extra" - } + (Just + OptDoc + { optDocTryArgument = False + , optDocTrySwitch = True + , optDocTryOption = False + , optDocDasheds = [ DashedLong ('(' :| "enable|disable)-enable") ] + , optDocDefault = Nothing + , optDocExamples = [] + , optDocMetavar = Nothing + , optDocHelp = Just "enable extra" + }) + , AnyDocsSingle Nothing + , AnyDocsSingle Nothing ] - } - , CommandDoc - { commandDocArgument = "three" - , commandDocHelp = "third" - , commandDocs = AnyDocsAnd [] - } - ] + ] + } + , CommandDoc + { commandDocArgument = "three-very-long-command-name" + , commandDocHelp = "third" + , commandDocs = AnyDocsAnd [] + } ] diff --git a/test_resources/docs/three-commands/opt-long.txt b/test_resources/docs/three-commands/opt-long.txt --- a/test_resources/docs/three-commands/opt-long.txt +++ b/test_resources/docs/three-commands/opt-long.txt @@ -1,9 +1,6 @@ - -h|--help Show this help text - --version Output version information: 0.0.0 - --config-file Path to the configuration file - one first - STR argument + one (default) first + STR argument two second - --number|-n number - --(enable|disable)-enable enable extra - three third + --number|-n number example: 5 + --(enable|disable)-enable enable extra + three-very-long-command-name third diff --git a/test_resources/docs/three-commands/opt-short.txt b/test_resources/docs/three-commands/opt-short.txt --- a/test_resources/docs/three-commands/opt-short.txt +++ b/test_resources/docs/three-commands/opt-short.txt @@ -1,1 +1,1 @@ -three-commands (-h|--help) | --version | (--config-file FILE_PATH one STR | two --number|-n INT --(enable|disable)-enable | three) +three-commands [COMMAND] diff --git a/test_resources/docs/three-commands/reference.txt b/test_resources/docs/three-commands/reference.txt --- a/test_resources/docs/three-commands/reference.txt +++ b/test_resources/docs/three-commands/reference.txt @@ -1,18 +1,15 @@ -Usage: three-commands (-h|--help) | --version | (--config-file FILE_PATH one STR | two --number|-n INT --(enable|disable)-enable | three) +Usage: three-commands [COMMAND] All settings: Show this help text switch: -h|--help - Output version information: 0.0.0 + Output version information switch: --version - Path to the configuration file - option: --config-file FILE_PATH - env: CONFIG_FILE FILE_PATH - +All commands: first - command: one + command: one (default) argument argument: STR @@ -24,7 +21,8 @@ env: NUMBER INT config: number: # or null -  # 64 bit signed integer +  # 64 bit signed integer + example: 5 enable extra switch: --(enable|disable)-enable @@ -35,30 +33,29 @@ third - command: three + command: three-very-long-command-name Options: - -h|--help Show this help text - --version Output version information: 0.0.0 - --config-file Path to the configuration file - one first - STR argument + -h|--help Show this help text + --version Output version information + one (default) first + STR argument two second - --number|-n number - --(enable|disable)-enable enable extra - three third + --number|-n number example: 5 + --(enable|disable)-enable enable extra + three-very-long-command-name third Environment Variables: - CONFIG_FILE FILE_PATH Path to the configuration file - NUMBER INT number - ENABLE BOOL enable extra + NUMBER INT number example: 5 + ENABLE BOOL enable extra Configuration Values: number + example: 5 number: # or null -  # 64 bit signed integer +  # 64 bit signed integer enable extra enable: # or null diff --git a/test_resources/docs/three-commands/show.txt b/test_resources/docs/three-commands/show.txt --- a/test_resources/docs/three-commands/show.txt +++ b/test_resources/docs/three-commands/show.txt @@ -1,39 +1,10 @@ WithConfig _ - (Check - Nothing - False - _ - (Alt - (Check - Nothing - False - _ - (Setting - Nothing - (Setting - [ DashedLong ('c' :| "onfig-file") ] - [ _ ] - False - Nothing - True - (Just ("CONFIG_FILE" :| [])) - Nothing - Nothing - (Just "FILE_PATH") - (Just "Path to the configuration file")))) - (Check Nothing False _ (Pure _)))) + Nothing + (Pure _) (Commands - (Just - SrcLoc - { srcLocPackage = "main" - , srcLocModule = "OptEnvConf.APISpec" - , srcLocFile = "test/OptEnvConf/APISpec.hs" - , srcLocStartLine = 239 - , srcLocStartCol = 5 - , srcLocEndLine = 239 - , srcLocEndCol = 13 - }) + Nothing + (Just "one") [ Command "one" "first" @@ -72,25 +43,24 @@ True (Just ("NUMBER" :| [])) (Just - [ ( "number" :| [] - , BimapCodec - _ - _ - (EitherCodec - PossiblyJointUnion - NullCodec - (BimapCodec - _ - _ - (NumberCodec - Nothing - (Just - NumberBounds - { numberBoundsLower = -9.223372036854775808e18 - , numberBoundsUpper = 9.223372036854775807e18 - })))) - ) - ]) + (ConfigValSetting + ("number" :| []) + BimapCodec + _ + _ + (EitherCodec + PossiblyJointUnion + NullCodec + (BimapCodec + _ + _ + (IntegerCodec + Nothing + Bounds + { boundsLower = Just (-9223372036854775808) + , boundsUpper = Just 9223372036854775807 + }))) :| + [])) Nothing (Just "INT") (Just "number")))) @@ -161,17 +131,17 @@ False Nothing (Just - [ ( "enable" :| [] - , BimapCodec - _ - _ - (EitherCodec - PossiblyJointUnion NullCodec (BoolCodec Nothing)) - ) - ]) + (ConfigValSetting + ("enable" :| []) + BimapCodec + _ + _ + (EitherCodec + PossiblyJointUnion NullCodec (BoolCodec Nothing)) :| + [])) Nothing Nothing (Just "enable extra"))) (Pure _))))))) - , Command "three" "third" (Pure _) + , Command "three-very-long-command-name" "third" (Pure _) ]) diff --git a/test_resources/docs/verbose/config-docs.txt b/test_resources/docs/verbose/config-docs.txt --- a/test_resources/docs/verbose/config-docs.txt +++ b/test_resources/docs/verbose/config-docs.txt @@ -1,1 +1,1 @@ -AnyDocsAnd [] +AnyDocsOr [] diff --git a/test_resources/docs/verbose/docs.txt b/test_resources/docs/verbose/docs.txt --- a/test_resources/docs/verbose/docs.txt +++ b/test_resources/docs/verbose/docs.txt @@ -1,13 +1,18 @@ -AnyDocsSingle - SetDoc - { setDocTryArgument = False - , setDocTrySwitch = True - , setDocTryOption = False - , setDocDasheds = [ DashedShort 'v' ] - , setDocEnvVars = Nothing - , setDocConfKeys = Nothing - , setDocDefault = Nothing - , setDocMetavar = Nothing - , setDocHelp = - Just "Verbosity level. Use multiple to increase verbosity" - } +AnyDocsOr + [ AnyDocsSingle + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = True + , setDocTryOption = False + , setDocDasheds = [ DashedShort 'v' ] + , setDocEnvVars = Nothing + , setDocConfKeys = Nothing + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Nothing + , setDocHelp = + Just "Verbosity level. Use multiple to increase verbosity" + }) + , AnyDocsSingle Nothing + ] diff --git a/test_resources/docs/verbose/env-docs.txt b/test_resources/docs/verbose/env-docs.txt --- a/test_resources/docs/verbose/env-docs.txt +++ b/test_resources/docs/verbose/env-docs.txt @@ -1,1 +1,1 @@ -AnyDocsAnd [] +AnyDocsOr [] diff --git a/test_resources/docs/verbose/help.txt b/test_resources/docs/verbose/help.txt --- a/test_resources/docs/verbose/help.txt +++ b/test_resources/docs/verbose/help.txt @@ -1,4 +1,4 @@ -Usage: verbose (-h|--help) | --version | -v +Usage: verbose [-v] verbosity example @@ -11,5 +11,4 @@ Verbosity level. Use multiple to increase verbosity switch: -v - diff --git a/test_resources/docs/verbose/man.txt b/test_resources/docs/verbose/man.txt --- a/test_resources/docs/verbose/man.txt +++ b/test_resources/docs/verbose/man.txt @@ -7,7 +7,7 @@ .Sh VERSION 0.0.0 .Sh SYNOPSIS -verbose (-h|--help) | --version | -v +verbose [-v] .Sh SETTINGS Show this help text switch: -h|--help @@ -17,10 +17,9 @@ Verbosity level. Use multiple to increase verbosity switch: -v - .Sh OPTIONS - -h|--help Show this help text - --version Output version information: 0.0.0 - -v Verbosity level. Use multiple to increase verbosity + -h|--help Show this help text + --version Output version information: 0.0.0 + -v Verbosity level. Use multiple to increase verbosity diff --git a/test_resources/docs/verbose/nix-options.nix b/test_resources/docs/verbose/nix-options.nix new file mode 100644 --- /dev/null +++ b/test_resources/docs/verbose/nix-options.nix @@ -0,0 +1,2 @@ +{ lib }: +{ } diff --git a/test_resources/docs/verbose/opt-docs.txt b/test_resources/docs/verbose/opt-docs.txt --- a/test_resources/docs/verbose/opt-docs.txt +++ b/test_resources/docs/verbose/opt-docs.txt @@ -1,11 +1,15 @@ -AnyDocsSingle - OptDoc - { optDocTryArgument = False - , optDocTrySwitch = True - , optDocTryOption = False - , optDocDasheds = [ DashedShort 'v' ] - , optDocDefault = Nothing - , optDocMetavar = Nothing - , optDocHelp = - Just "Verbosity level. Use multiple to increase verbosity" - } +AnyDocsOr + [ AnyDocsSingle + (Just + OptDoc + { optDocTryArgument = False + , optDocTrySwitch = True + , optDocTryOption = False + , optDocDasheds = [ DashedShort 'v' ] + , optDocDefault = Nothing + , optDocExamples = [] + , optDocMetavar = Nothing + , optDocHelp = + Just "Verbosity level. Use multiple to increase verbosity" + }) + ] diff --git a/test_resources/docs/verbose/opt-long.txt b/test_resources/docs/verbose/opt-long.txt --- a/test_resources/docs/verbose/opt-long.txt +++ b/test_resources/docs/verbose/opt-long.txt @@ -1,3 +1,1 @@ - -h|--help Show this help text - --version Output version information: 0.0.0 - -v Verbosity level. Use multiple to increase verbosity + -v Verbosity level. Use multiple to increase verbosity diff --git a/test_resources/docs/verbose/opt-short.txt b/test_resources/docs/verbose/opt-short.txt --- a/test_resources/docs/verbose/opt-short.txt +++ b/test_resources/docs/verbose/opt-short.txt @@ -1,1 +1,1 @@ -verbose (-h|--help) | --version | -v +verbose [-v] diff --git a/test_resources/docs/verbose/reference.txt b/test_resources/docs/verbose/reference.txt --- a/test_resources/docs/verbose/reference.txt +++ b/test_resources/docs/verbose/reference.txt @@ -1,18 +1,17 @@ -Usage: verbose (-h|--help) | --version | -v +Usage: verbose [-v] All settings: Show this help text switch: -h|--help - Output version information: 0.0.0 + Output version information switch: --version Verbosity level. Use multiple to increase verbosity switch: -v - Options: - -h|--help Show this help text - --version Output version information: 0.0.0 - -v Verbosity level. Use multiple to increase verbosity + -h|--help Show this help text + --version Output version information + -v Verbosity level. Use multiple to increase verbosity diff --git a/test_resources/docs/with-default/config-docs.txt b/test_resources/docs/with-default/config-docs.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/with-default/config-docs.txt @@ -0,0 +1,1 @@ +AnyDocsOr [] diff --git a/test_resources/docs/with-default/config.txt b/test_resources/docs/with-default/config.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/with-default/config.txt diff --git a/test_resources/docs/with-default/docs.txt b/test_resources/docs/with-default/docs.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/with-default/docs.txt @@ -0,0 +1,30 @@ +AnyDocsOr + [ AnyDocsSingle + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = True + , setDocTryOption = False + , setDocDasheds = [ DashedShort 'f' , DashedLong ('f' :| "irst") ] + , setDocEnvVars = Nothing + , setDocConfKeys = Nothing + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Nothing + , setDocHelp = Just "first" + }) + , AnyDocsSingle + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = True + , setDocTryOption = False + , setDocDasheds = [ DashedShort 's' , DashedLong ('s' :| "econd") ] + , setDocEnvVars = Nothing + , setDocConfKeys = Nothing + , setDocDefault = Just "Second" + , setDocExamples = [] + , setDocMetavar = Nothing + , setDocHelp = Just "second" + }) + ] diff --git a/test_resources/docs/with-default/env-docs.txt b/test_resources/docs/with-default/env-docs.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/with-default/env-docs.txt @@ -0,0 +1,1 @@ +AnyDocsOr [] diff --git a/test_resources/docs/with-default/env.txt b/test_resources/docs/with-default/env.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/with-default/env.txt diff --git a/test_resources/docs/with-default/help.txt b/test_resources/docs/with-default/help.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/with-default/help.txt @@ -0,0 +1,18 @@ +Usage: with-default [-f|--first | [-s|--second]] + +withDefault example + +Available settings: + Show this help text + switch: -h|--help + + Output version information: 0.0.0 + switch: --version + + first + switch: -f|--first + + second + switch: -s|--second + default: Second + diff --git a/test_resources/docs/with-default/man.txt b/test_resources/docs/with-default/man.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/with-default/man.txt @@ -0,0 +1,30 @@ +.Dd $Mdocdate$ +.Dt with-default 1 +.Os +.Sh NAME +.Nm with-default +.Nd withDefault example +.Sh VERSION +0.0.0 +.Sh SYNOPSIS +with-default [-f|--first | [-s|--second]] +.Sh SETTINGS + Show this help text + switch: -h|--help + + Output version information: 0.0.0 + switch: --version + + first + switch: -f|--first + + second + switch: -s|--second + default: Second + +.Sh OPTIONS + -h|--help Show this help text + --version Output version information: 0.0.0 + -f|--first first + -s|--second second default: Second + diff --git a/test_resources/docs/with-default/nix-options.nix b/test_resources/docs/with-default/nix-options.nix new file mode 100644 --- /dev/null +++ b/test_resources/docs/with-default/nix-options.nix @@ -0,0 +1,2 @@ +{ lib }: +{ } diff --git a/test_resources/docs/with-default/opt-docs.txt b/test_resources/docs/with-default/opt-docs.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/with-default/opt-docs.txt @@ -0,0 +1,26 @@ +AnyDocsOr + [ AnyDocsSingle + (Just + OptDoc + { optDocTryArgument = False + , optDocTrySwitch = True + , optDocTryOption = False + , optDocDasheds = [ DashedShort 'f' , DashedLong ('f' :| "irst") ] + , optDocDefault = Nothing + , optDocExamples = [] + , optDocMetavar = Nothing + , optDocHelp = Just "first" + }) + , AnyDocsSingle + (Just + OptDoc + { optDocTryArgument = False + , optDocTrySwitch = True + , optDocTryOption = False + , optDocDasheds = [ DashedShort 's' , DashedLong ('s' :| "econd") ] + , optDocDefault = Just "Second" + , optDocExamples = [] + , optDocMetavar = Nothing + , optDocHelp = Just "second" + }) + ] diff --git a/test_resources/docs/with-default/opt-long.txt b/test_resources/docs/with-default/opt-long.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/with-default/opt-long.txt @@ -0,0 +1,2 @@ + -f|--first first + -s|--second second default: Second diff --git a/test_resources/docs/with-default/opt-short.txt b/test_resources/docs/with-default/opt-short.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/with-default/opt-short.txt @@ -0,0 +1,1 @@ +with-default [-f|--first | [-s|--second]] diff --git a/test_resources/docs/with-default/reference.txt b/test_resources/docs/with-default/reference.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/with-default/reference.txt @@ -0,0 +1,22 @@ +Usage: with-default [-f|--first | [-s|--second]] + +All settings: + Show this help text + switch: -h|--help + + Output version information + switch: --version + + first + switch: -f|--first + + second + switch: -s|--second + default: Second + +Options: + -h|--help Show this help text + --version Output version information + -f|--first first + -s|--second second default: Second + diff --git a/test_resources/docs/with-default/show.txt b/test_resources/docs/with-default/show.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/with-default/show.txt @@ -0,0 +1,27 @@ +Alt + (Setting + Nothing + (Setting + [ DashedShort 'f' , DashedLong ('f' :| "irst") ] + [] + False + (Just _) + False + Nothing + Nothing + Nothing + Nothing + (Just "first"))) + (Setting + Nothing + (Setting + [ DashedShort 's' , DashedLong ('s' :| "econd") ] + [] + False + (Just _) + False + Nothing + Nothing + (Just _) + Nothing + (Just "second"))) diff --git a/test_resources/docs/with-default/version.txt b/test_resources/docs/with-default/version.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/with-default/version.txt @@ -0,0 +1,1 @@ +with-default 0.0.0 diff --git a/test_resources/docs/yes-no-optional/config-docs.txt b/test_resources/docs/yes-no-optional/config-docs.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/yes-no-optional/config-docs.txt @@ -0,0 +1,10 @@ +AnyDocsOr + [ AnyDocsSingle + EnvDoc + { envDocVars = "EXAMPLE" :| [] + , envDocDefault = Nothing + , envDocExamples = [] + , envDocMetavar = Just "BOOL" + , envDocHelp = Just "Example of a yes/no switch" + } + ] diff --git a/test_resources/docs/yes-no-optional/config.txt b/test_resources/docs/yes-no-optional/config.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/yes-no-optional/config.txt @@ -0,0 +1,4 @@ + Example of a yes/no switch + example: + # or null +  diff --git a/test_resources/docs/yes-no-optional/docs.txt b/test_resources/docs/yes-no-optional/docs.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/yes-no-optional/docs.txt @@ -0,0 +1,55 @@ +AnyDocsAnd + [ AnyDocsSingle Nothing + , AnyDocsOr + [ AnyDocsSingle + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = True + , setDocTryOption = False + , setDocDasheds = [ DashedLong ('[' :| "no-]example") ] + , setDocEnvVars = Nothing + , setDocConfKeys = Nothing + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Nothing + , setDocHelp = Just "Example of a yes/no switch" + }) + , AnyDocsSingle Nothing + , AnyDocsSingle Nothing + , AnyDocsSingle + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = False + , setDocTryOption = False + , setDocDasheds = [] + , setDocEnvVars = Just ("EXAMPLE" :| []) + , setDocConfKeys = Nothing + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Just "BOOL" + , setDocHelp = Just "Example of a yes/no switch" + }) + , AnyDocsSingle + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = False + , setDocTryOption = False + , setDocDasheds = [] + , setDocEnvVars = Nothing + , setDocConfKeys = + Just + (( "example" :| [] + , AnyOfSchema (NullSchema :| [ BoolSchema ]) + ) :| + []) + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Nothing + , setDocHelp = Just "Example of a yes/no switch" + }) + , AnyDocsSingle Nothing + ] + ] diff --git a/test_resources/docs/yes-no-optional/env-docs.txt b/test_resources/docs/yes-no-optional/env-docs.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/yes-no-optional/env-docs.txt @@ -0,0 +1,11 @@ +AnyDocsOr + [ AnyDocsSingle + ConfDoc + { confDocKeys = + ( "example" :| [] , AnyOfSchema (NullSchema :| [ BoolSchema ]) ) :| + [] + , confDocDefault = Nothing + , confDocExamples = [] + , confDocHelp = Just "Example of a yes/no switch" + } + ] diff --git a/test_resources/docs/yes-no-optional/env.txt b/test_resources/docs/yes-no-optional/env.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/yes-no-optional/env.txt @@ -0,0 +1,1 @@ + EXAMPLE BOOL Example of a yes/no switch diff --git a/test_resources/docs/yes-no-optional/help.txt b/test_resources/docs/yes-no-optional/help.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/yes-no-optional/help.txt @@ -0,0 +1,18 @@ +Usage: yes-no-optional [--[no-]example] + +yesNoSwitch' example + +Available settings: + Show this help text + switch: -h|--help + + Output version information: 0.0.0 + switch: --version + + Example of a yes/no switch + switch: --[no-]example + env: EXAMPLE BOOL + config: + example: # or null +  + diff --git a/test_resources/docs/yes-no-optional/man.txt b/test_resources/docs/yes-no-optional/man.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/yes-no-optional/man.txt @@ -0,0 +1,38 @@ +.Dd $Mdocdate$ +.Dt yes-no-optional 1 +.Os +.Sh NAME +.Nm yes-no-optional +.Nd yesNoSwitch' example +.Sh VERSION +0.0.0 +.Sh SYNOPSIS +yes-no-optional [--[no-]example] +.Sh SETTINGS + Show this help text + switch: -h|--help + + Output version information: 0.0.0 + switch: --version + + Example of a yes/no switch + switch: --[no-]example + env: EXAMPLE BOOL + config: + example: # or null + + +.Sh OPTIONS + -h|--help Show this help text + --version Output version information: 0.0.0 + --[no-]example Example of a yes/no switch + +.Sh ENVIRONMENT VARIABLES + EXAMPLE BOOL Example of a yes/no switch + +.Sh CONFIGURATION VALUES + Example of a yes/no switch + example: + # or null + + diff --git a/test_resources/docs/yes-no-optional/nix-options.nix b/test_resources/docs/yes-no-optional/nix-options.nix new file mode 100644 --- /dev/null +++ b/test_resources/docs/yes-no-optional/nix-options.nix @@ -0,0 +1,8 @@ +{ lib }: +{ + example = lib.mkOption { + default = null; + description = "Example of a yes/no switch"; + type = lib.types.nullOr lib.types.bool; + }; +} diff --git a/test_resources/docs/yes-no-optional/opt-docs.txt b/test_resources/docs/yes-no-optional/opt-docs.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/yes-no-optional/opt-docs.txt @@ -0,0 +1,16 @@ +AnyDocsOr + [ AnyDocsSingle + (Just + OptDoc + { optDocTryArgument = False + , optDocTrySwitch = True + , optDocTryOption = False + , optDocDasheds = [ DashedLong ('[' :| "no-]example") ] + , optDocDefault = Nothing + , optDocExamples = [] + , optDocMetavar = Nothing + , optDocHelp = Just "Example of a yes/no switch" + }) + , AnyDocsSingle Nothing + , AnyDocsSingle Nothing + ] diff --git a/test_resources/docs/yes-no-optional/opt-long.txt b/test_resources/docs/yes-no-optional/opt-long.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/yes-no-optional/opt-long.txt @@ -0,0 +1,1 @@ + --[no-]example Example of a yes/no switch diff --git a/test_resources/docs/yes-no-optional/opt-short.txt b/test_resources/docs/yes-no-optional/opt-short.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/yes-no-optional/opt-short.txt @@ -0,0 +1,1 @@ +yes-no-optional [--[no-]example] diff --git a/test_resources/docs/yes-no-optional/reference.txt b/test_resources/docs/yes-no-optional/reference.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/yes-no-optional/reference.txt @@ -0,0 +1,30 @@ +Usage: yes-no-optional [--[no-]example] + +All settings: + Show this help text + switch: -h|--help + + Output version information + switch: --version + + Example of a yes/no switch + switch: --[no-]example + env: EXAMPLE BOOL + config: + example: # or null +  + +Options: + -h|--help Show this help text + --version Output version information + --[no-]example Example of a yes/no switch + +Environment Variables: + EXAMPLE BOOL Example of a yes/no switch + +Configuration Values: + Example of a yes/no switch + example: + # or null +  + diff --git a/test_resources/docs/yes-no-optional/show.txt b/test_resources/docs/yes-no-optional/show.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/yes-no-optional/show.txt @@ -0,0 +1,102 @@ +WithConfig + _ + Nothing + (Pure _) + (Alt + (Alt + (Check + Nothing + True + _ + (Setting + Nothing + (Setting + [ DashedLong ('[' :| "no-]example") ] + [] + False + (Just _) + False + Nothing + Nothing + Nothing + Nothing + (Just "Example of a yes/no switch")))) + (Alt + (Check + Nothing + True + _ + (Setting + Nothing + (Setting + [ DashedLong ('n' :| "o-example") ] + [] + False + (Just _) + False + Nothing + Nothing + Nothing + Nothing + Nothing))) + (Alt + (Check + Nothing + True + _ + (Setting + Nothing + (Setting + [ DashedLong ('e' :| "xample") ] + [] + False + (Just _) + False + Nothing + Nothing + Nothing + Nothing + Nothing))) + (Alt + (Check + Nothing + True + _ + (Setting + Nothing + (Setting + [] + [ _ ] + False + Nothing + False + (Just ("EXAMPLE" :| [])) + Nothing + Nothing + (Just "BOOL") + (Just "Example of a yes/no switch")))) + (Check + Nothing + True + _ + (Setting + Nothing + (Setting + [] + [] + False + Nothing + False + Nothing + (Just + (ConfigValSetting + ("example" :| []) + BimapCodec + _ + _ + (EitherCodec PossiblyJointUnion NullCodec (BoolCodec Nothing)) :| + [])) + Nothing + Nothing + (Just "Example of a yes/no switch")))))))) + (Pure _)) diff --git a/test_resources/docs/yes-no-optional/version.txt b/test_resources/docs/yes-no-optional/version.txt new file mode 100644 --- /dev/null +++ b/test_resources/docs/yes-no-optional/version.txt @@ -0,0 +1,1 @@ +yes-no-optional 0.0.0 diff --git a/test_resources/docs/yes-no/config-docs.txt b/test_resources/docs/yes-no/config-docs.txt --- a/test_resources/docs/yes-no/config-docs.txt +++ b/test_resources/docs/yes-no/config-docs.txt @@ -1,15 +1,9 @@ -AnyDocsAnd +AnyDocsOr [ AnyDocsSingle EnvDoc - { envDocVars = "CONFIG_FILE" :| [] - , envDocDefault = Nothing - , envDocMetavar = Just "FILE_PATH" - , envDocHelp = Just "Path to the configuration file" - } - , AnyDocsSingle - EnvDoc { envDocVars = "EXAMPLE" :| [] , envDocDefault = Nothing + , envDocExamples = [] , envDocMetavar = Just "BOOL" , envDocHelp = Just "Example of a yes/no switch" } diff --git a/test_resources/docs/yes-no/docs.txt b/test_resources/docs/yes-no/docs.txt --- a/test_resources/docs/yes-no/docs.txt +++ b/test_resources/docs/yes-no/docs.txt @@ -1,57 +1,55 @@ AnyDocsAnd - [ AnyDocsSingle - SetDoc - { setDocTryArgument = False - , setDocTrySwitch = False - , setDocTryOption = True - , setDocDasheds = [ DashedLong ('c' :| "onfig-file") ] - , setDocEnvVars = Just ("CONFIG_FILE" :| []) - , setDocConfKeys = Nothing - , setDocDefault = Nothing - , setDocMetavar = Just "FILE_PATH" - , setDocHelp = Just "Path to the configuration file" - } + [ AnyDocsSingle Nothing , AnyDocsOr [ AnyDocsSingle - SetDoc - { setDocTryArgument = False - , setDocTrySwitch = True - , setDocTryOption = False - , setDocDasheds = [ DashedLong ('[' :| "no-]example") ] - , setDocEnvVars = Nothing - , setDocConfKeys = Nothing - , setDocDefault = Nothing - , setDocMetavar = Nothing - , setDocHelp = Just "Example of a yes/no switch" - } + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = True + , setDocTryOption = False + , setDocDasheds = [ DashedLong ('[' :| "no-]example") ] + , setDocEnvVars = Nothing + , setDocConfKeys = Nothing + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Nothing + , setDocHelp = Just "Example of a yes/no switch" + }) + , AnyDocsSingle Nothing + , AnyDocsSingle Nothing , AnyDocsSingle - SetDoc - { setDocTryArgument = False - , setDocTrySwitch = False - , setDocTryOption = False - , setDocDasheds = [] - , setDocEnvVars = Just ("EXAMPLE" :| []) - , setDocConfKeys = Nothing - , setDocDefault = Nothing - , setDocMetavar = Just "BOOL" - , setDocHelp = Just "Example of a yes/no switch" - } + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = False + , setDocTryOption = False + , setDocDasheds = [] + , setDocEnvVars = Just ("EXAMPLE" :| []) + , setDocConfKeys = Nothing + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Just "BOOL" + , setDocHelp = Just "Example of a yes/no switch" + }) , AnyDocsSingle - SetDoc - { setDocTryArgument = False - , setDocTrySwitch = False - , setDocTryOption = False - , setDocDasheds = [] - , setDocEnvVars = Nothing - , setDocConfKeys = - Just - (( "example" :| [] - , AnyOfSchema (NullSchema :| [ BoolSchema ]) - ) :| - []) - , setDocDefault = Nothing - , setDocMetavar = Nothing - , setDocHelp = Just "Example of a yes/no switch" - } + (Just + SetDoc + { setDocTryArgument = False + , setDocTrySwitch = False + , setDocTryOption = False + , setDocDasheds = [] + , setDocEnvVars = Nothing + , setDocConfKeys = + Just + (( "example" :| [] + , AnyOfSchema (NullSchema :| [ BoolSchema ]) + ) :| + []) + , setDocDefault = Nothing + , setDocExamples = [] + , setDocMetavar = Nothing + , setDocHelp = Just "Example of a yes/no switch" + }) + , AnyDocsSingle Nothing ] ] diff --git a/test_resources/docs/yes-no/env-docs.txt b/test_resources/docs/yes-no/env-docs.txt --- a/test_resources/docs/yes-no/env-docs.txt +++ b/test_resources/docs/yes-no/env-docs.txt @@ -1,8 +1,11 @@ -AnyDocsSingle - ConfDoc - { confDocKeys = - ( "example" :| [] , AnyOfSchema (NullSchema :| [ BoolSchema ]) ) :| - [] - , confDocDefault = Nothing - , confDocHelp = Just "Example of a yes/no switch" - } +AnyDocsOr + [ AnyDocsSingle + ConfDoc + { confDocKeys = + ( "example" :| [] , AnyOfSchema (NullSchema :| [ BoolSchema ]) ) :| + [] + , confDocDefault = Nothing + , confDocExamples = [] + , confDocHelp = Just "Example of a yes/no switch" + } + ] diff --git a/test_resources/docs/yes-no/env.txt b/test_resources/docs/yes-no/env.txt --- a/test_resources/docs/yes-no/env.txt +++ b/test_resources/docs/yes-no/env.txt @@ -1,2 +1,1 @@ - CONFIG_FILE FILE_PATH Path to the configuration file - EXAMPLE BOOL Example of a yes/no switch + EXAMPLE BOOL Example of a yes/no switch diff --git a/test_resources/docs/yes-no/help.txt b/test_resources/docs/yes-no/help.txt --- a/test_resources/docs/yes-no/help.txt +++ b/test_resources/docs/yes-no/help.txt @@ -1,4 +1,4 @@ -Usage: yes-no (-h|--help) | --version | (--config-file FILE_PATH --[no-]example) +Usage: yes-no [--[no-]example] yesNoSwitch example @@ -9,15 +9,10 @@ Output version information: 0.0.0 switch: --version - Path to the configuration file - option: --config-file FILE_PATH - env: CONFIG_FILE FILE_PATH - Example of a yes/no switch switch: --[no-]example env: EXAMPLE BOOL config: example: # or null  - diff --git a/test_resources/docs/yes-no/man.txt b/test_resources/docs/yes-no/man.txt --- a/test_resources/docs/yes-no/man.txt +++ b/test_resources/docs/yes-no/man.txt @@ -7,7 +7,7 @@ .Sh VERSION 0.0.0 .Sh SYNOPSIS -yes-no (-h|--help) | --version | (--config-file FILE_PATH --[no-]example) +yes-no [--[no-]example] .Sh SETTINGS Show this help text switch: -h|--help @@ -15,10 +15,6 @@ Output version information: 0.0.0 switch: --version - Path to the configuration file - option: --config-file FILE_PATH - env: CONFIG_FILE FILE_PATH - Example of a yes/no switch switch: --[no-]example env: EXAMPLE BOOL @@ -26,16 +22,13 @@ example: # or null - .Sh OPTIONS - -h|--help Show this help text - --version Output version information: 0.0.0 - --config-file Path to the configuration file - --[no-]example Example of a yes/no switch + -h|--help Show this help text + --version Output version information: 0.0.0 + --[no-]example Example of a yes/no switch .Sh ENVIRONMENT VARIABLES - CONFIG_FILE FILE_PATH Path to the configuration file - EXAMPLE BOOL Example of a yes/no switch + EXAMPLE BOOL Example of a yes/no switch .Sh CONFIGURATION VALUES Example of a yes/no switch diff --git a/test_resources/docs/yes-no/nix-options.nix b/test_resources/docs/yes-no/nix-options.nix new file mode 100644 --- /dev/null +++ b/test_resources/docs/yes-no/nix-options.nix @@ -0,0 +1,8 @@ +{ lib }: +{ + example = lib.mkOption { + default = null; + description = "Example of a yes/no switch"; + type = lib.types.nullOr lib.types.bool; + }; +} diff --git a/test_resources/docs/yes-no/opt-docs.txt b/test_resources/docs/yes-no/opt-docs.txt --- a/test_resources/docs/yes-no/opt-docs.txt +++ b/test_resources/docs/yes-no/opt-docs.txt @@ -1,22 +1,16 @@ -AnyDocsAnd +AnyDocsOr [ AnyDocsSingle - OptDoc - { optDocTryArgument = False - , optDocTrySwitch = False - , optDocTryOption = True - , optDocDasheds = [ DashedLong ('c' :| "onfig-file") ] - , optDocDefault = Nothing - , optDocMetavar = Just "FILE_PATH" - , optDocHelp = Just "Path to the configuration file" - } - , AnyDocsSingle - OptDoc - { optDocTryArgument = False - , optDocTrySwitch = True - , optDocTryOption = False - , optDocDasheds = [ DashedLong ('[' :| "no-]example") ] - , optDocDefault = Nothing - , optDocMetavar = Nothing - , optDocHelp = Just "Example of a yes/no switch" - } + (Just + OptDoc + { optDocTryArgument = False + , optDocTrySwitch = True + , optDocTryOption = False + , optDocDasheds = [ DashedLong ('[' :| "no-]example") ] + , optDocDefault = Nothing + , optDocExamples = [] + , optDocMetavar = Nothing + , optDocHelp = Just "Example of a yes/no switch" + }) + , AnyDocsSingle Nothing + , AnyDocsSingle Nothing ] diff --git a/test_resources/docs/yes-no/opt-long.txt b/test_resources/docs/yes-no/opt-long.txt --- a/test_resources/docs/yes-no/opt-long.txt +++ b/test_resources/docs/yes-no/opt-long.txt @@ -1,4 +1,1 @@ - -h|--help Show this help text - --version Output version information: 0.0.0 - --config-file Path to the configuration file - --[no-]example Example of a yes/no switch + --[no-]example Example of a yes/no switch diff --git a/test_resources/docs/yes-no/opt-short.txt b/test_resources/docs/yes-no/opt-short.txt --- a/test_resources/docs/yes-no/opt-short.txt +++ b/test_resources/docs/yes-no/opt-short.txt @@ -1,1 +1,1 @@ -yes-no (-h|--help) | --version | (--config-file FILE_PATH --[no-]example) +yes-no [--[no-]example] diff --git a/test_resources/docs/yes-no/reference.txt b/test_resources/docs/yes-no/reference.txt --- a/test_resources/docs/yes-no/reference.txt +++ b/test_resources/docs/yes-no/reference.txt @@ -1,16 +1,12 @@ -Usage: yes-no (-h|--help) | --version | (--config-file FILE_PATH --[no-]example) +Usage: yes-no [--[no-]example] All settings: Show this help text switch: -h|--help - Output version information: 0.0.0 + Output version information switch: --version - Path to the configuration file - option: --config-file FILE_PATH - env: CONFIG_FILE FILE_PATH - Example of a yes/no switch switch: --[no-]example env: EXAMPLE BOOL @@ -18,16 +14,13 @@ example: # or null  - Options: - -h|--help Show this help text - --version Output version information: 0.0.0 - --config-file Path to the configuration file - --[no-]example Example of a yes/no switch + -h|--help Show this help text + --version Output version information + --[no-]example Example of a yes/no switch Environment Variables: - CONFIG_FILE FILE_PATH Path to the configuration file - EXAMPLE BOOL Example of a yes/no switch + EXAMPLE BOOL Example of a yes/no switch Configuration Values: Example of a yes/no switch diff --git a/test_resources/docs/yes-no/show.txt b/test_resources/docs/yes-no/show.txt --- a/test_resources/docs/yes-no/show.txt +++ b/test_resources/docs/yes-no/show.txt @@ -1,28 +1,7 @@ WithConfig _ - (Check - Nothing - False - _ - (Alt - (Check - Nothing - False - _ - (Setting - Nothing - (Setting - [ DashedLong ('c' :| "onfig-file") ] - [ _ ] - False - Nothing - True - (Just ("CONFIG_FILE" :| [])) - Nothing - Nothing - (Just "FILE_PATH") - (Just "Path to the configuration file")))) - (Check Nothing False _ (Pure _)))) + Nothing + (Pure _) (Alt (Check Nothing @@ -110,13 +89,13 @@ False Nothing (Just - [ ( "example" :| [] - , BimapCodec - _ - _ - (EitherCodec PossiblyJointUnion NullCodec (BoolCodec Nothing)) - ) - ]) + (ConfigValSetting + ("example" :| []) + BimapCodec + _ + _ + (EitherCodec PossiblyJointUnion NullCodec (BoolCodec Nothing)) :| + [])) Nothing Nothing (Just "Example of a yes/no switch")))) diff --git a/test_resources/error/all-or-nothing-relevant.txt b/test_resources/error/all-or-nothing-relevant.txt --- a/test_resources/error/all-or-nothing-relevant.txt +++ b/test_resources/error/all-or-nothing-relevant.txt @@ -1,3 +1,5 @@ -Missing option: --bar This one will not exist +Missing option: --bar This one will not exist You are seeing this error because at least one, but not all, of the settings in an allOrNothing (or subSettings) parser have been defined. +The following settings have been parsed: +test/OptEnvConf/ErrorSpec.hs:153:21 in main:OptEnvConf.ErrorSpec Hit the 'empty' case of the Parser type, this should not happen. diff --git a/test_resources/error/all-or-nothing.txt b/test_resources/error/all-or-nothing.txt --- a/test_resources/error/all-or-nothing.txt +++ b/test_resources/error/all-or-nothing.txt @@ -1,2 +1,4 @@ -Missing option: --bar This one will not exist +Missing option: --bar This one will not exist You are seeing this error because at least one, but not all, of the settings in an allOrNothing (or subSettings) parser have been defined. +The following settings have been parsed: +test/OptEnvConf/ErrorSpec.hs:141:19 in main:OptEnvConf.ErrorSpec diff --git a/test_resources/error/leftover-argument.txt b/test_resources/error/leftover-argument.txt new file mode 100644 --- /dev/null +++ b/test_resources/error/leftover-argument.txt @@ -0,0 +1,1 @@ +Unrecognised args: foo bar diff --git a/test_resources/error/leftover-option.txt b/test_resources/error/leftover-option.txt new file mode 100644 --- /dev/null +++ b/test_resources/error/leftover-option.txt @@ -0,0 +1,1 @@ +Unrecognised args: --key val diff --git a/test_resources/error/leftover-switch.txt b/test_resources/error/leftover-switch.txt new file mode 100644 --- /dev/null +++ b/test_resources/error/leftover-switch.txt @@ -0,0 +1,1 @@ +Unrecognised args: --switch diff --git a/test_resources/error/missing-argument.txt b/test_resources/error/missing-argument.txt --- a/test_resources/error/missing-argument.txt +++ b/test_resources/error/missing-argument.txt @@ -1,1 +1,1 @@ -Missing argument: ARGUMENT example argument +Missing argument: ARGUMENT example argument diff --git a/test_resources/error/missing-option.txt b/test_resources/error/missing-option.txt --- a/test_resources/error/missing-option.txt +++ b/test_resources/error/missing-option.txt @@ -1,1 +1,1 @@ -Missing option: --foo example option +Missing option: --foo example option diff --git a/test_resources/error/missing-options.txt b/test_resources/error/missing-options.txt --- a/test_resources/error/missing-options.txt +++ b/test_resources/error/missing-options.txt @@ -1,2 +1,2 @@ -Missing option: --foo example option 1 -Missing option: --bar example option 2 +Missing option: --foo example option 1 +Missing option: --bar example option 2 diff --git a/test_resources/error/read-int-argument.txt b/test_resources/error/read-int-argument.txt --- a/test_resources/error/read-int-argument.txt +++ b/test_resources/error/read-int-argument.txt @@ -1,3 +1,3 @@ Failed to read argument: -INT integer option +INT integer option Un-Read-able value: "five" diff --git a/test_resources/error/read-int-option.txt b/test_resources/error/read-int-option.txt --- a/test_resources/error/read-int-option.txt +++ b/test_resources/error/read-int-option.txt @@ -1,3 +1,3 @@ Failed to read option: ---num integer option +--num integer option Un-Read-able value: "five" diff --git a/test_resources/error/read-int-options.txt b/test_resources/error/read-int-options.txt --- a/test_resources/error/read-int-options.txt +++ b/test_resources/error/read-int-options.txt @@ -1,6 +1,6 @@ Failed to read option: ---foo integer option 1 +--foo integer option 1 Un-Read-able value: "n" Failed to read option: ---bar integer option 2 +--bar integer option 2 Un-Read-able value: "m" diff --git a/test_resources/error/required-command.txt b/test_resources/error/required-command.txt --- a/test_resources/error/required-command.txt +++ b/test_resources/error/required-command.txt @@ -1,2 +1,3 @@ Missing command, available commands: -one two +one: first +two: second diff --git a/test_resources/error/some-none.txt b/test_resources/error/some-none.txt --- a/test_resources/error/some-none.txt +++ b/test_resources/error/some-none.txt @@ -1,1 +1,1 @@ -Missing argument: METAVAR undocumented +Missing argument: METAVAR undocumented diff --git a/test_resources/error/typo-option.txt b/test_resources/error/typo-option.txt new file mode 100644 --- /dev/null +++ b/test_resources/error/typo-option.txt @@ -0,0 +1,1 @@ +Unrecognised args: --baz arg diff --git a/test_resources/error/typo-switch.txt b/test_resources/error/typo-switch.txt new file mode 100644 --- /dev/null +++ b/test_resources/error/typo-switch.txt @@ -0,0 +1,1 @@ +Unrecognised args: --baz diff --git a/test_resources/error/unfolding-tombstone-option.txt b/test_resources/error/unfolding-tombstone-option.txt --- a/test_resources/error/unfolding-tombstone-option.txt +++ b/test_resources/error/unfolding-tombstone-option.txt @@ -1,1 +1,1 @@ -Missing option: -b undocumented +Missing option: -b undocumented diff --git a/test_resources/error/unfolding-tombstone-switch.txt b/test_resources/error/unfolding-tombstone-switch.txt --- a/test_resources/error/unfolding-tombstone-switch.txt +++ b/test_resources/error/unfolding-tombstone-switch.txt @@ -1,1 +1,1 @@ -Missing option: -f undocumented +Missing option: -f undocumented diff --git a/test_resources/error/unrecognised-arg.txt b/test_resources/error/unrecognised-arg.txt new file mode 100644 --- /dev/null +++ b/test_resources/error/unrecognised-arg.txt @@ -0,0 +1,1 @@ +Unrecognised args: arg diff --git a/test_resources/error/unrecognised-command.txt b/test_resources/error/unrecognised-command.txt --- a/test_resources/error/unrecognised-command.txt +++ b/test_resources/error/unrecognised-command.txt @@ -1,3 +1,4 @@ Unrecognised command: three available commands: -one two +one: first +two: second diff --git a/test_resources/error/unrecognised-option.txt b/test_resources/error/unrecognised-option.txt new file mode 100644 --- /dev/null +++ b/test_resources/error/unrecognised-option.txt @@ -0,0 +1,1 @@ +Unrecognised args: --foo bar diff --git a/test_resources/error/unrecognised-switch.txt b/test_resources/error/unrecognised-switch.txt new file mode 100644 --- /dev/null +++ b/test_resources/error/unrecognised-switch.txt @@ -0,0 +1,1 @@ +Unrecognised args: --foo diff --git a/test_resources/help/create.txt b/test_resources/help/create.txt new file mode 100644 --- /dev/null +++ b/test_resources/help/create.txt @@ -0,0 +1,11 @@ +Usage: example create STR + +create command explanation + +Available settings: + Show this help text + switch: -h|--help + + The item to create + argument: STR + diff --git a/test_resources/help/read.txt b/test_resources/help/read.txt new file mode 100644 --- /dev/null +++ b/test_resources/help/read.txt @@ -0,0 +1,8 @@ +Usage: example read + +read command explanation + +Available settings: + Show this help text + switch: -h|--help + diff --git a/test_resources/help/sub-bar.txt b/test_resources/help/sub-bar.txt new file mode 100644 --- /dev/null +++ b/test_resources/help/sub-bar.txt @@ -0,0 +1,8 @@ +Usage: example sub bar + +bar explanation + +Available settings: + Show this help text + switch: -h|--help + diff --git a/test_resources/help/sub-foo.txt b/test_resources/help/sub-foo.txt new file mode 100644 --- /dev/null +++ b/test_resources/help/sub-foo.txt @@ -0,0 +1,8 @@ +Usage: example sub foo + +foo explanation + +Available settings: + Show this help text + switch: -h|--help + diff --git a/test_resources/help/sub.txt b/test_resources/help/sub.txt new file mode 100644 --- /dev/null +++ b/test_resources/help/sub.txt @@ -0,0 +1,12 @@ +Usage: example sub COMMAND + +command with subcommand + +Available settings: + Show this help text + switch: -h|--help + +Available commands: + foo foo explanation + bar bar explanation + diff --git a/test_resources/help/toplevel-pure-with-invalid-port.txt b/test_resources/help/toplevel-pure-with-invalid-port.txt new file mode 100644 --- /dev/null +++ b/test_resources/help/toplevel-pure-with-invalid-port.txt @@ -0,0 +1,57 @@ +Usage: example [--config-file FILE_PATH] [--port PORT] [--log-level LOG_LEVEL] [--payment-public-key PUBLIC_KEY --payment-secret-key FILE_PATH [--payment-currency CURRENCY]] COMMAND + +example program description + +Available settings: + Show this help text + switch: -h|--help + + Output version information: 0.0.0 + switch: --version + + Path to the configuration file + option: --config-file FILE_PATH + env: CONFIG_FILE FILE_PATH + + port to serve requests on + option: --port PORT + env: PORT PORT + config: + port: # or null +  # 16 bit unsigned integer + default: 8080 + + minimal severity of log messages + option: --log-level LOG_LEVEL + env: LOG_LEVEL LOG_LEVEL + config: + log-level: # or null +  + default: "DEBUG" + + Public key + option: --payment-public-key PUBLIC_KEY + env: PAYMENT_PUBLIC_KEY PUBLIC_KEY + config: + payment.public-key: # or null +  + + Secret key + option: --payment-secret-key FILE_PATH + env: PAYMENT_SECRET_KEY FILE_PATH + config: + payment.secret-key: # or null +  + + Currency + option: --payment-currency CURRENCY + env: PAYMENT_CURRENCY CURRENCY + config: + payment.currency: # or null +  + +Available commands: + read read command explanation + create create command explanation + sub command with subcommand + diff --git a/test_resources/help/toplevel-pure.txt b/test_resources/help/toplevel-pure.txt new file mode 100644 --- /dev/null +++ b/test_resources/help/toplevel-pure.txt @@ -0,0 +1,57 @@ +Usage: example [--config-file FILE_PATH] [--port PORT] [--log-level LOG_LEVEL] [--payment-public-key PUBLIC_KEY --payment-secret-key FILE_PATH [--payment-currency CURRENCY]] COMMAND + +example program description + +Available settings: + Show this help text + switch: -h|--help + + Output version information: 0.0.0 + switch: --version + + Path to the configuration file + option: --config-file FILE_PATH + env: CONFIG_FILE FILE_PATH + + port to serve requests on + option: --port PORT + env: PORT PORT + config: + port: # or null +  # 16 bit unsigned integer + default: 8080 + + minimal severity of log messages + option: --log-level LOG_LEVEL + env: LOG_LEVEL LOG_LEVEL + config: + log-level: # or null +  + default: "DEBUG" + + Public key + option: --payment-public-key PUBLIC_KEY + env: PAYMENT_PUBLIC_KEY PUBLIC_KEY + config: + payment.public-key: # or null +  + + Secret key + option: --payment-secret-key FILE_PATH + env: PAYMENT_SECRET_KEY FILE_PATH + config: + payment.secret-key: # or null +  + + Currency + option: --payment-currency CURRENCY + env: PAYMENT_CURRENCY CURRENCY + config: + payment.currency: # or null +  + +Available commands: + read read command explanation + create create command explanation + sub command with subcommand + diff --git a/test_resources/help/wrong-command.txt b/test_resources/help/wrong-command.txt new file mode 100644 --- /dev/null +++ b/test_resources/help/wrong-command.txt @@ -0,0 +1,57 @@ +Usage: example [--config-file FILE_PATH] [--port PORT] [--log-level LOG_LEVEL] [--payment-public-key PUBLIC_KEY --payment-secret-key FILE_PATH [--payment-currency CURRENCY]] COMMAND + +example program description + +Available settings: + Show this help text + switch: -h|--help + + Output version information: 0.0.0 + switch: --version + + Path to the configuration file + option: --config-file FILE_PATH + env: CONFIG_FILE FILE_PATH + + port to serve requests on + option: --port PORT + env: PORT PORT + config: + port: # or null +  # 16 bit unsigned integer + default: 8080 + + minimal severity of log messages + option: --log-level LOG_LEVEL + env: LOG_LEVEL LOG_LEVEL + config: + log-level: # or null +  + default: "DEBUG" + + Public key + option: --payment-public-key PUBLIC_KEY + env: PAYMENT_PUBLIC_KEY PUBLIC_KEY + config: + payment.public-key: # or null +  + + Secret key + option: --payment-secret-key FILE_PATH + env: PAYMENT_SECRET_KEY FILE_PATH + config: + payment.secret-key: # or null +  + + Currency + option: --payment-currency CURRENCY + env: PAYMENT_CURRENCY CURRENCY + config: + payment.currency: # or null +  + +Available commands: + read read command explanation + create create command explanation + sub command with subcommand + diff --git a/test_resources/lint/config-without-load.txt b/test_resources/lint/config-without-load.txt --- a/test_resources/lint/config-without-load.txt +++ b/test_resources/lint/config-without-load.txt @@ -1,5 +1,6 @@ Setting parser is invalid: Invalid Setting: - conf was called with no way to load configuration. - Defined at: test/OptEnvConf/LintSpec.hs:120:7 in main:OptEnvConf.LintSpec + conf or name was called with no way to load configuration. + You can load configuration with withConfig, or explicitly not load any configuration with withoutConfig. + Defined at: test/OptEnvConf/LintSpec.hs:124:7 in main:OptEnvConf.LintSpec diff --git a/test_resources/lint/dash-in-long.txt b/test_resources/lint/dash-in-long.txt --- a/test_resources/lint/dash-in-long.txt +++ b/test_resources/lint/dash-in-long.txt @@ -4,4 +4,4 @@ long may not start with a '-'. Found long "--switch". Try long "switch" instead. - Defined at: test/OptEnvConf/LintSpec.hs:40:7 in main:OptEnvConf.LintSpec + Defined at: test/OptEnvConf/LintSpec.hs:33:7 in main:OptEnvConf.LintSpec diff --git a/test_resources/lint/dash-in-short.txt b/test_resources/lint/dash-in-short.txt --- a/test_resources/lint/dash-in-short.txt +++ b/test_resources/lint/dash-in-short.txt @@ -3,4 +3,4 @@ Invalid Setting: short may not contain a '-'. Found short '-'. - Defined at: test/OptEnvConf/LintSpec.hs:32:7 in main:OptEnvConf.LintSpec + Defined at: test/OptEnvConf/LintSpec.hs:25:7 in main:OptEnvConf.LintSpec diff --git a/test_resources/lint/many-conf.txt b/test_resources/lint/many-conf.txt new file mode 100644 --- /dev/null +++ b/test_resources/lint/many-conf.txt @@ -0,0 +1,5 @@ +Setting parser is invalid: + + Invalid Setting: + many or some was called with a parser that may succeed without consuming anything. + This is not allowed because the parser would run infinitely. diff --git a/test_resources/lint/many-env.txt b/test_resources/lint/many-env.txt new file mode 100644 --- /dev/null +++ b/test_resources/lint/many-env.txt @@ -0,0 +1,5 @@ +Setting parser is invalid: + + Invalid Setting: + many or some was called with a parser that may succeed without consuming anything. + This is not allowed because the parser would run infinitely. diff --git a/test_resources/lint/no-commands.txt b/test_resources/lint/no-commands.txt --- a/test_resources/lint/no-commands.txt +++ b/test_resources/lint/no-commands.txt @@ -2,4 +2,4 @@ Invalid Setting: commands was called with an empty list. - Defined at: test/OptEnvConf/LintSpec.hs:117:6 in main:OptEnvConf.LintSpec + Defined at: test/OptEnvConf/LintSpec.hs:121:6 in main:OptEnvConf.LintSpec diff --git a/test_resources/lint/no-dashed-for-option.txt b/test_resources/lint/no-dashed-for-option.txt --- a/test_resources/lint/no-dashed-for-option.txt +++ b/test_resources/lint/no-dashed-for-option.txt @@ -2,4 +2,4 @@ Invalid Setting: option has no long or short. - Defined at: test/OptEnvConf/LintSpec.hs:74:7 in main:OptEnvConf.LintSpec + Defined at: test/OptEnvConf/LintSpec.hs:67:7 in main:OptEnvConf.LintSpec diff --git a/test_resources/lint/no-dashed-for-switch.txt b/test_resources/lint/no-dashed-for-switch.txt --- a/test_resources/lint/no-dashed-for-switch.txt +++ b/test_resources/lint/no-dashed-for-switch.txt @@ -2,4 +2,4 @@ Invalid Setting: switch has no long or short. - Defined at: test/OptEnvConf/LintSpec.hs:94:7 in main:OptEnvConf.LintSpec + Defined at: test/OptEnvConf/LintSpec.hs:98:7 in main:OptEnvConf.LintSpec diff --git a/test_resources/lint/no-metavar-for-argument.txt b/test_resources/lint/no-metavar-for-argument.txt --- a/test_resources/lint/no-metavar-for-argument.txt +++ b/test_resources/lint/no-metavar-for-argument.txt @@ -2,4 +2,4 @@ Invalid Setting: argument has no metavar. - Defined at: test/OptEnvConf/LintSpec.hs:56:7 in main:OptEnvConf.LintSpec + Defined at: test/OptEnvConf/LintSpec.hs:49:7 in main:OptEnvConf.LintSpec diff --git a/test_resources/lint/no-metavar-for-env.txt b/test_resources/lint/no-metavar-for-env.txt --- a/test_resources/lint/no-metavar-for-env.txt +++ b/test_resources/lint/no-metavar-for-env.txt @@ -1,5 +1,5 @@ Setting parser is invalid: Invalid Setting: - env has no metavar. - Defined at: test/OptEnvConf/LintSpec.hs:108:7 in main:OptEnvConf.LintSpec + env or name has no metavar. + Defined at: test/OptEnvConf/LintSpec.hs:112:7 in main:OptEnvConf.LintSpec diff --git a/test_resources/lint/no-metavar-for-option.txt b/test_resources/lint/no-metavar-for-option.txt --- a/test_resources/lint/no-metavar-for-option.txt +++ b/test_resources/lint/no-metavar-for-option.txt @@ -1,5 +1,5 @@ Setting parser is invalid: Invalid Setting: - option has no metavar. - Defined at: test/OptEnvConf/LintSpec.hs:84:7 in main:OptEnvConf.LintSpec + option or name has no metavar. + Defined at: test/OptEnvConf/LintSpec.hs:88:7 in main:OptEnvConf.LintSpec diff --git a/test_resources/lint/no-option-or-switch-for-dashed.txt b/test_resources/lint/no-option-or-switch-for-dashed.txt new file mode 100644 --- /dev/null +++ b/test_resources/lint/no-option-or-switch-for-dashed.txt @@ -0,0 +1,5 @@ +Setting parser is invalid: + + Invalid Setting: + long or short has no option or switch. + Defined at: test/OptEnvConf/LintSpec.hs:77:7 in main:OptEnvConf.LintSpec diff --git a/test_resources/lint/no-reader-for-argument.txt b/test_resources/lint/no-reader-for-argument.txt --- a/test_resources/lint/no-reader-for-argument.txt +++ b/test_resources/lint/no-reader-for-argument.txt @@ -2,4 +2,4 @@ Invalid Setting: argument has no reader. - Defined at: test/OptEnvConf/LintSpec.hs:48:7 in main:OptEnvConf.LintSpec + Defined at: test/OptEnvConf/LintSpec.hs:41:7 in main:OptEnvConf.LintSpec diff --git a/test_resources/lint/no-reader-for-env.txt b/test_resources/lint/no-reader-for-env.txt --- a/test_resources/lint/no-reader-for-env.txt +++ b/test_resources/lint/no-reader-for-env.txt @@ -1,9 +1,9 @@ Setting parser is invalid: Invalid Setting: - env has no reader. - Defined at: test/OptEnvConf/LintSpec.hs:101:7 in main:OptEnvConf.LintSpec + env or name has no reader. + Defined at: test/OptEnvConf/LintSpec.hs:105:7 in main:OptEnvConf.LintSpec Invalid Setting: - env has no metavar. - Defined at: test/OptEnvConf/LintSpec.hs:101:7 in main:OptEnvConf.LintSpec + env or name has no metavar. + Defined at: test/OptEnvConf/LintSpec.hs:105:7 in main:OptEnvConf.LintSpec diff --git a/test_resources/lint/no-reader-for-option.txt b/test_resources/lint/no-reader-for-option.txt --- a/test_resources/lint/no-reader-for-option.txt +++ b/test_resources/lint/no-reader-for-option.txt @@ -1,5 +1,5 @@ Setting parser is invalid: Invalid Setting: - option has no reader. - Defined at: test/OptEnvConf/LintSpec.hs:65:7 in main:OptEnvConf.LintSpec + option or name has no reader. + Defined at: test/OptEnvConf/LintSpec.hs:58:7 in main:OptEnvConf.LintSpec diff --git a/test_resources/lint/some-conf.txt b/test_resources/lint/some-conf.txt new file mode 100644 --- /dev/null +++ b/test_resources/lint/some-conf.txt @@ -0,0 +1,5 @@ +Setting parser is invalid: + + Invalid Setting: + many or some was called with a parser that may succeed without consuming anything. + This is not allowed because the parser would run infinitely. diff --git a/test_resources/lint/some-env.txt b/test_resources/lint/some-env.txt new file mode 100644 --- /dev/null +++ b/test_resources/lint/some-env.txt @@ -0,0 +1,5 @@ +Setting parser is invalid: + + Invalid Setting: + many or some was called with a parser that may succeed without consuming anything. + This is not allowed because the parser would run infinitely. diff --git a/test_resources/lint/unknown-default-command.txt b/test_resources/lint/unknown-default-command.txt new file mode 100644 --- /dev/null +++ b/test_resources/lint/unknown-default-command.txt @@ -0,0 +1,5 @@ +Setting parser is invalid: + + Invalid Setting: + defaultCommand was called with an unknown command: b + Defined at: test/OptEnvConf/LintSpec.hs:185:7 in main:OptEnvConf.LintSpec diff --git a/test_resources/lint/unreadable-example.txt b/test_resources/lint/unreadable-example.txt --- a/test_resources/lint/unreadable-example.txt +++ b/test_resources/lint/unreadable-example.txt @@ -3,4 +3,4 @@ Invalid Setting: example was called with an example that none of the readers succeed in reading. Example: NaN - Defined at: test/OptEnvConf/LintSpec.hs:128:7 in main:OptEnvConf.LintSpec + Defined at: test/OptEnvConf/LintSpec.hs:132:7 in main:OptEnvConf.LintSpec