Safe Haskell	Safe-Inferred
Language	Haskell2010

Unison.CommandLine.InputPattern

Contents

Currently Unused

Synopsis

data InputPattern = InputPattern {
- patternName :: String
- aliases :: [String]
- visibility :: Visibility
- args :: [(ArgumentDescription, IsOptional, ArgumentType)]
- help :: Pretty ColorText
- parse :: Arguments -> Either (Pretty ColorText) Input
}
type Argument = Either String StructuredArgument
data ArgumentType = ArgumentType {
- typeName :: String
- suggestions :: forall m v a. MonadIO m => String -> Codebase m v a -> AuthenticatedHttpClient -> ProjectPath -> m [Completion]
- fzfResolver :: Maybe FZFResolver
}
type ArgumentDescription = Text
type Arguments = [Argument]
argType :: InputPattern -> Int -> Maybe ArgumentType
data FZFResolver = FZFResolver {
- getOptions :: OptionFetcher
}
data IsOptional
- = Required
- | Optional
- | ZeroPlus
- | OnePlus
data Visibility
- = Hidden
- | Visible
minArgs :: InputPattern -> Int
maxArgs :: InputPattern -> Maybe Int
unionSuggestions :: forall m v a. MonadIO m => [String -> Codebase m v a -> AuthenticatedHttpClient -> ProjectPath -> m [Completion]] -> String -> Codebase m v a -> AuthenticatedHttpClient -> ProjectPath -> m [Completion]
suggestionFallbacks :: forall m v a. MonadIO m => [String -> Codebase m v a -> AuthenticatedHttpClient -> ProjectPath -> m [Completion]] -> String -> Codebase m v a -> AuthenticatedHttpClient -> ProjectPath -> m [Completion]

Documentation

data InputPattern Source #

Constructors

InputPattern

Fields

patternName :: String
aliases :: [String]
visibility :: Visibility
args :: [(ArgumentDescription, IsOptional, ArgumentType)]
help :: Pretty ColorText
parse :: Arguments -> Either (Pretty ColorText) Input
Parse the arguments and return either an error message or a command Input.
NB: This function should return Left only on failure. For commands (like $sel:help:InputPattern) that simply produce formatted output, use `pure . Input.CreateMessage`. The failure output should be fully formatted (using wrap, etc.), but shouldn’t include any general error components like a warninng flag or the full help message, and shouldn’t plan for the context it is being output to (e.g., don’t indentN the entire message).

type Argument = Either String StructuredArgument Source #

An argument to a command is either a string provided by the user which needs to be parsed or a numbered argument that doesn’t need to be parsed, as we’ve preserved its representation (although the numbered argument could still be of the wrong type, which should result in an error).

data ArgumentType Source #

Constructors

ArgumentType
Fields typeName :: String suggestions :: forall m v a. MonadIO m => String -> Codebase m v a -> AuthenticatedHttpClient -> ProjectPath -> m [Completion] Generate completion suggestions for this argument type fzfResolver :: Maybe FZFResolver If an argument is marked as required, but not provided, the fuzzy finder will be triggered if available.

Instances

Instances details

Show ArgumentType Source #
Instance details Defined in Unison.CommandLine.InputPattern Methods showsPrec :: Int -> ArgumentType -> ShowS # show :: ArgumentType -> String # showList :: [ArgumentType] -> ShowS #

type ArgumentDescription = Text Source #

Argument description It should fit grammatically into sentences like "I was expecting an argument for the argDesc" e.g. "namespace to merge", "definition to delete", "remote target to push to" etc.

type Arguments = [Argument] Source #

argType :: InputPattern -> Int -> Maybe ArgumentType Source #

data FZFResolver Source #

Constructors

FZFResolver
Fields getOptions :: OptionFetcher

Instances

Instances details

Show FZFResolver Source #
Instance details Defined in Unison.CommandLine.FZFResolvers Methods showsPrec :: Int -> FZFResolver -> ShowS # show :: FZFResolver -> String # showList :: [FZFResolver] -> ShowS #

data IsOptional Source #

Constructors

Required
Optional
ZeroPlus
OnePlus

Instances

Instances details

Show IsOptional Source #
Instance details Defined in Unison.CommandLine.InputPattern Methods showsPrec :: Int -> IsOptional -> ShowS # show :: IsOptional -> String # showList :: [IsOptional] -> ShowS #
Eq IsOptional Source #
Instance details Defined in Unison.CommandLine.InputPattern Methods (==) :: IsOptional -> IsOptional -> Bool # (/=) :: IsOptional -> IsOptional -> Bool #

data Visibility Source #

Constructors

Hidden
Visible

Instances

Instances details

Show Visibility Source #
Instance details Defined in Unison.CommandLine.InputPattern Methods showsPrec :: Int -> Visibility -> ShowS # show :: Visibility -> String # showList :: [Visibility] -> ShowS #
Eq Visibility Source #
Instance details Defined in Unison.CommandLine.InputPattern Methods (==) :: Visibility -> Visibility -> Bool # (/=) :: Visibility -> Visibility -> Bool #
Ord Visibility Source #
Instance details Defined in Unison.CommandLine.InputPattern Methods compare :: Visibility -> Visibility -> Ordering # (<) :: Visibility -> Visibility -> Bool # (<=) :: Visibility -> Visibility -> Bool # (>) :: Visibility -> Visibility -> Bool # (>=) :: Visibility -> Visibility -> Bool # max :: Visibility -> Visibility -> Visibility # min :: Visibility -> Visibility -> Visibility #

Currently Unused

minArgs :: InputPattern -> Int Source #

maxArgs :: InputPattern -> Maybe Int Source #

unionSuggestions :: forall m v a. MonadIO m => [String -> Codebase m v a -> AuthenticatedHttpClient -> ProjectPath -> m [Completion]] -> String -> Codebase m v a -> AuthenticatedHttpClient -> ProjectPath -> m [Completion] Source #

Union suggestions from all possible completions

suggestionFallbacks :: forall m v a. MonadIO m => [String -> Codebase m v a -> AuthenticatedHttpClient -> ProjectPath -> m [Completion]] -> String -> Codebase m v a -> AuthenticatedHttpClient -> ProjectPath -> m [Completion] Source #

Try the first completer, if it returns no suggestions, try the second, etc.