| Copyright | (c) Frederick Pringle 2023 |
|---|---|
| License | BSD-3-Clause |
| Maintainer | freddyjepringle@gmail.com |
| Safe Haskell | None |
| Language | Haskell2010 |
Hoyo.Bookmark
Description
The Bookmark type provides a representation of bookmarks saved and used
+
| Copyright | (c) Frederick Pringle 2023 |
|---|---|
| License | BSD-3-Clause |
| Maintainer | freddyjepringle@gmail.com |
| Safe Haskell | None |
| Language | Haskell2010 |
Hoyo.Bookmark
Description
The Bookmark type provides a representation of bookmarks saved and used
by the hoyo program. This module exports some utility datatypes and functions
used for working with bookmarks.
Synopsis
- data Bookmark = Bookmark {}
- newtype Bookmarks = Bookmarks {
- unBookmarks :: [Bookmark]
- data BookmarkSearchTerm
- formatBookmark :: Bool -> Int -> Int -> Bookmark -> Text
- formatBookmarks :: Bool -> [Bookmark] -> [Text]
- data DefaultBookmark = DefaultBookmark {}
- getBookmarks :: HoyoMonad Bookmarks
- searchBookmarks :: BookmarkSearchTerm -> Bookmarks -> ([Bookmark], [Bookmark])
- filterBookmarks :: Maybe Text -> Maybe Text -> Bookmark -> Bool
- filterBookmarkByName :: Maybe Text -> Bookmark -> Bool
- filterBookmarkByDirInfix :: Maybe Text -> Bookmark -> Bool
- bookmarksFromDefault :: MonadIO m => [DefaultBookmark] -> m Bookmarks
- bookmarkCodec :: TomlCodec Bookmark
- bookmarksCodec :: TomlCodec Bookmarks
- defaultBookmarkCodec :: TomlCodec DefaultBookmark
- decodeBookmarks :: Text -> Either Text Bookmarks
- decodeBookmarksFile :: MonadIO m => FilePath -> m (Either Text Bookmarks)
- encodeBookmarks :: Bookmarks -> Text
- encodeBookmarksFile :: MonadIO m => FilePath -> Bookmarks -> m ()
The Bookmark type
Bookmark a directory for easy cd. A bookmark remembers the directory,
the index, the creation time, and optionally a user-specified nickname
diff --git a/docs/Hoyo-CLI-Complete.html b/docs/Hoyo-CLI-Complete.html
index acb6e3f..ac9785f 100644
--- a/docs/Hoyo-CLI-Complete.html
+++ b/docs/Hoyo-CLI-Complete.html
@@ -1 +1 @@
-
| Copyright | (c) Frederick Pringle 2023 |
|---|---|
| License | BSD-3-Clause |
| Maintainer | freddyjepringle@gmail.com |
| Safe Haskell | None |
| Language | Haskell2010 |
Hoyo.CLI.Complete
Description
Bash competion functions used by the CLI.
Documentation
bookmarkCompleter :: Completer Source #
Fetch existing data file and use it to complete bookmark names.
configKeyCompleter :: Completer Source #
Complete configuration keys.
configValueCompleter :: Completer Source #
Complete configuration values.
TODO: could be more sophisticated, considering the current key
| Copyright | (c) Frederick Pringle 2023 |
|---|---|
| License | BSD-3-Clause |
| Maintainer | freddyjepringle@gmail.com |
| Safe Haskell | None |
| Language | Haskell2010 |
Hoyo.CLI.Complete
Description
Bash competion functions used by the CLI.
Documentation
bookmarkCompleter :: Completer Source #
Fetch existing data file and use it to complete bookmark names.
configKeyCompleter :: Completer Source #
Complete configuration keys.
configValueCompleter :: Completer Source #
Complete configuration values.
TODO: could be more sophisticated, considering the current key
| Copyright | (c) Frederick Pringle 2023 |
|---|---|
| License | BSD-3-Clause |
| Maintainer | freddyjepringle@gmail.com |
| Safe Haskell | None |
| Language | Haskell2010 |
Hoyo.CLI.Parse
Description
Parse CLI arguments.
Synopsis
- options :: ParserInfo Options
- parseOptions :: Parser Options
- parseCommand :: Parser Command
- globalOptions :: Parser GlobalOptions
- overrideOptions :: Parser OverrideOptions
- addCommand :: Parser Command
- moveCommand :: Parser Command
- listCommand :: Parser Command
- clearCommand :: Parser Command
- deleteCommand :: Parser Command
- checkCommand :: Parser Command
- defaultCommand :: Parser Command
- configCommand :: Parser Command
- configPrintCommand :: Parser ConfigCommand
- configResetCommand :: Parser ConfigCommand
- configSetCommand :: Parser ConfigCommand
- configAddDefaultCommand :: Parser ConfigCommand
- splitArgs :: Text -> [String]
Parsing CLI arguments and options
options :: ParserInfo Options Source #
A ParserInfo object containing the necessary information for parsing
+
| Copyright | (c) Frederick Pringle 2023 |
|---|---|
| License | BSD-3-Clause |
| Maintainer | freddyjepringle@gmail.com |
| Safe Haskell | None |
| Language | Haskell2010 |
Hoyo.CLI.Parse
Description
Parse CLI arguments.
Synopsis
- options :: ParserInfo Options
- parseOptions :: Parser Options
- parseCommand :: Parser Command
- globalOptions :: Parser GlobalOptions
- overrideOptions :: Parser OverrideOptions
- addCommand :: Parser Command
- moveCommand :: Parser Command
- listCommand :: Parser Command
- clearCommand :: Parser Command
- deleteCommand :: Parser Command
- checkCommand :: Parser Command
- defaultCommand :: Parser Command
- configCommand :: Parser Command
- configPrintCommand :: Parser ConfigCommand
- configResetCommand :: Parser ConfigCommand
- configSetCommand :: Parser ConfigCommand
- configAddDefaultCommand :: Parser ConfigCommand
- splitArgs :: Text -> [String]
Parsing CLI arguments and options
options :: ParserInfo Options Source #
A ParserInfo object containing the necessary information for parsing
CLI commands and arguments, and displaying useful help text.
parseOptions :: Parser Options Source #
Parse an Options argument, which includes the command
to run and any global options.
parseCommand :: Parser Command Source #
Parse a command and the arguments/options for that command from the command-line arguments.
globalOptions :: Parser GlobalOptions Source #
Parse global options: options that can be set on the command line diff --git a/docs/Hoyo-Command.html b/docs/Hoyo-Command.html index 3c241aa..fcb5bcb 100644 --- a/docs/Hoyo-Command.html +++ b/docs/Hoyo-Command.html @@ -1,4 +1,4 @@ -
| Copyright | (c) Frederick Pringle 2023 |
|---|---|
| License | BSD-3-Clause |
| Maintainer | freddyjepringle@gmail.com |
| Safe Haskell | None |
| Language | Haskell2010 |
Hoyo.Command
Description
This module defines data-types and runner functions for the hoyo +
| Copyright | (c) Frederick Pringle 2023 |
|---|---|
| License | BSD-3-Clause |
| Maintainer | freddyjepringle@gmail.com |
| Safe Haskell | None |
| Language | Haskell2010 |
Hoyo.Command
Description
This module defines data-types and runner functions for the hoyo command-line program.
Synopsis
- runCommand :: Command -> HoyoMonad ()
- modifyBookmarks :: ([Bookmark] -> [Bookmark]) -> HoyoMonad ()
- modifyBookmarksM :: ([Bookmark] -> HoyoMonad [Bookmark]) -> HoyoMonad ()
- runAdd :: AddOptions -> HoyoMonad ()
- runMove :: MoveOptions -> HoyoMonad ()
- runList :: ListOptions -> HoyoMonad ()
- runClear :: ClearOptions -> HoyoMonad ()
- runDelete :: DeleteOptions -> HoyoMonad ()
- runRefresh :: RefreshOptions -> HoyoMonad ()
- runConfig :: ConfigCommand -> HoyoMonad ()
- runCheck :: CheckOptions -> FilePath -> FilePath -> IO ()
- runDefaultCommand :: HoyoMonad ()
- data Options = Options {}
- data Command
- data AddOptions = AddOptions {
- addDirectory :: FilePath
- addName :: Maybe Text
- newtype MoveOptions = MoveOptions {}
- data ListOptions = ListOptions {}
- data ClearOptions = ClearOptions
- newtype DeleteOptions = DeleteOptions {}
- data RefreshOptions = RefreshOptions
- newtype ConfigPrintOptions = ConfigPrintOptions {}
- data ConfigResetOptions = ConfigResetOptions
- data ConfigSetOptions = ConfigSetOptions {}
- data ConfigAddDefaultOptions = ConfigAddDefaultOptions {}
- data ConfigCommand
- data CheckOptions = CheckOptions {}
- data GlobalOptions = GlobalOptions {}
- defaultGlobalOptions :: GlobalOptions
- data OverrideOptions = OverrideOptions {}
- defaultOverrideOptions :: OverrideOptions
- overrideConfig :: OverrideOptions -> Config -> Config
- overrideEnv :: OverrideOptions -> Env -> Env
- verifyOverrides :: OverrideOptions -> Maybe Text
- combOverride :: Bool -> Bool -> MaybeOverride
- data MaybeOverride
Running CLI commands
modifyBookmarks :: ([Bookmark] -> [Bookmark]) -> HoyoMonad () Source #
Helper function whenever we need to modify the saved bookmarks.
modifyBookmarks f retrieves the current bookmarks, applies f,
and saves them back to file.
modifyBookmarksM :: ([Bookmark] -> HoyoMonad [Bookmark]) -> HoyoMonad () Source #
Helper function twhenever we need to modify the saved bookmarks, and need access to the hoyo environment.
modifyBookmarks f retrieves the current bookmarks, applies f
diff --git a/docs/Hoyo-Config.html b/docs/Hoyo-Config.html
index 61d7f5b..ba3f277 100644
--- a/docs/Hoyo-Config.html
+++ b/docs/Hoyo-Config.html
@@ -1,2 +1,2 @@
-
| Copyright | (c) Frederick Pringle 2023 |
|---|---|
| License | BSD-3-Clause |
| Maintainer | freddyjepringle@gmail.com |
| Safe Haskell | None |
| Language | Haskell2010 |
Hoyo.Config
Description
Configuration for the hoyo program. This is stored on-disk as a TOML file, +
| Copyright | (c) Frederick Pringle 2023 |
|---|---|
| License | BSD-3-Clause |
| Maintainer | freddyjepringle@gmail.com |
| Safe Haskell | None |
| Language | Haskell2010 |
Hoyo.Config
Description
Configuration for the hoyo program. This is stored on-disk as a TOML file, usually at ~.confighoyo/config.toml
Synopsis
- data Config = Config {
- _failOnError :: !(ConfigValue 'TBool)
- _displayCreationTime :: !(ConfigValue 'TBool)
- _enableClearing :: !(ConfigValue 'TBool)
- _enableReset :: !(ConfigValue 'TBool)
- _backupBeforeClear :: !(ConfigValue 'TBool)
- _defaultBookmarks :: !(ConfigValue ('TList 'TDefaultBookmark))
- _defaultCommand :: !(ConfigValue ('TMaybe 'TCommand))
- defaultConfig :: Config
- decodeConfig :: Text -> Either Text Config
- decodeConfigFile :: MonadIO m => FilePath -> m (Either Text Config)
- encodeConfig :: Config -> Text
- encodeConfigFile :: MonadIO m => FilePath -> Config -> m ()
- setConfig :: MonadError Text m => Text -> Text -> Config -> m Config
- getKeyVals :: Config -> [(Text, AnyConfigValue)]
Documentation
A representation of hoyo settings.
Constructors
| Config | |
Fields
| |
defaultConfig :: Config Source #
The default config for hoyo.
decodeConfigFile :: MonadIO m => FilePath -> m (Either Text Config) Source #
Decode a Config from a file.
setConfig :: MonadError Text m => Text -> Text -> Config -> m Config Source #
Try to set a key-value pair in the config.
getKeyVals :: Config -> [(Text, AnyConfigValue)] Source #
Get TOML key-value pairs from a Config.
| Copyright | (c) Frederick Pringle 2023 |
|---|---|
| License | BSD-3-Clause |
| Maintainer | freddyjepringle@gmail.com |
| Safe Haskell | None |
| Language | Haskell2010 |
Hoyo.Env
Contents
Description
The read-only hoyo environment.
Synopsis
- data Env = Env {
- _bookmarks :: !Bookmarks
- _bookmarksPath :: !FilePath
- _config :: !Config
- _configPath :: !FilePath
- initEnv :: MonadIO m => FilePath -> FilePath -> m ()
- getEnv :: MonadIO m => FilePath -> FilePath -> m (Either Text Env)
- writeEnv :: MonadIO m => Env -> m ()
- readEnv :: MonadIO m => FilePath -> FilePath -> m (Either Text Env)
- defaultBookmarksPath :: IO FilePath
- defaultConfigPath :: IO FilePath
Hoyo config
The main hoyo read-only environment. Contains the current saved bookmarks, +
| Copyright | (c) Frederick Pringle 2023 |
|---|---|
| License | BSD-3-Clause |
| Maintainer | freddyjepringle@gmail.com |
| Safe Haskell | None |
| Language | Haskell2010 |
Hoyo.Env
Contents
Description
The read-only hoyo environment.
Synopsis
- data Env = Env {
- _bookmarks :: !Bookmarks
- _bookmarksPath :: !FilePath
- _config :: !Config
- _configPath :: !FilePath
- initEnv :: MonadIO m => FilePath -> FilePath -> m ()
- getEnv :: MonadIO m => FilePath -> FilePath -> m (Either Text Env)
- writeEnv :: MonadIO m => Env -> m ()
- readEnv :: MonadIO m => FilePath -> FilePath -> m (Either Text Env)
- defaultBookmarksPath :: IO FilePath
- defaultConfigPath :: IO FilePath
Hoyo config
The main hoyo read-only environment. Contains the current saved bookmarks, the current hoyo configuration, and the file locations for each.
Constructors
| Env | |
Fields
| |
initEnv :: MonadIO m => FilePath -> FilePath -> m () Source #
Given a filepath for the bookmarks file and a filepath for the config file, initialize the respective TOMLs at those locations.
getEnv :: MonadIO m => FilePath -> FilePath -> m (Either Text Env) Source #
Retrieve an Env from given bookmark- and config- file locations.
readEnv :: MonadIO m => FilePath -> FilePath -> m (Either Text Env) Source #
Read an Env from a file.
Default file paths
defaultBookmarksPath :: IO FilePath Source #
The default path for hoyo bookmarks. Usually $HOME/.local/share/hoyo/config.toml
defaultConfigPath :: IO FilePath Source #
The default path for the hoyo config. Usually $HOME/.config/hoyo/config.toml
| Copyright | (c) Frederick Pringle 2023 |
|---|---|
| License | BSD-3-Clause |
| Maintainer | freddyjepringle@gmail.com |
| Safe Haskell | None |
| Language | Haskell2010 |
Hoyo.Internal.Bookmark
Description
Internals used by the Hoyo.Bookmark module.
Synopsis
- bookmarkCodec :: TomlCodec Bookmark
- defaultBookmarkCodec :: TomlCodec DefaultBookmark
- bookmarksCodec :: TomlCodec Bookmarks
- decodeBookmarks :: Text -> Either Text Bookmarks
- decodeBookmarksFile :: MonadIO m => FilePath -> m (Either Text Bookmarks)
- encodeBookmarks :: Bookmarks -> Text
- encodeBookmarksFile :: MonadIO m => FilePath -> Bookmarks -> m ()
- searchBookmarks :: BookmarkSearchTerm -> Bookmarks -> ([Bookmark], [Bookmark])
- filterBookmarkByName :: Maybe Text -> Bookmark -> Bool
- filterBookmarkByDirInfix :: Maybe Text -> Bookmark -> Bool
- filterBookmarks :: Maybe Text -> Maybe Text -> Bookmark -> Bool
- bookmarksFromDefault :: MonadIO m => [DefaultBookmark] -> m Bookmarks
- getBookmarks :: HoyoMonad Bookmarks
Documentation
decodeBookmarksFile :: MonadIO m => FilePath -> m (Either Text Bookmarks) Source #
Decode a Bookmark from a file.
encodeBookmarksFile :: MonadIO m => FilePath -> Bookmarks -> m () Source #
Encode a Bookmark to a file.
searchBookmarks :: BookmarkSearchTerm -> Bookmarks -> ([Bookmark], [Bookmark]) Source #
searchBookmarks searchTerm bookmarks partitions bookmarks into a list of
+
| Copyright | (c) Frederick Pringle 2023 |
|---|---|
| License | BSD-3-Clause |
| Maintainer | freddyjepringle@gmail.com |
| Safe Haskell | None |
| Language | Haskell2010 |
Hoyo.Internal.Bookmark
Description
Internals used by the Hoyo.Bookmark module.
Synopsis
- bookmarkCodec :: TomlCodec Bookmark
- defaultBookmarkCodec :: TomlCodec DefaultBookmark
- bookmarksCodec :: TomlCodec Bookmarks
- decodeBookmarks :: Text -> Either Text Bookmarks
- decodeBookmarksFile :: MonadIO m => FilePath -> m (Either Text Bookmarks)
- encodeBookmarks :: Bookmarks -> Text
- encodeBookmarksFile :: MonadIO m => FilePath -> Bookmarks -> m ()
- searchBookmarks :: BookmarkSearchTerm -> Bookmarks -> ([Bookmark], [Bookmark])
- filterBookmarkByName :: Maybe Text -> Bookmark -> Bool
- filterBookmarkByDirInfix :: Maybe Text -> Bookmark -> Bool
- filterBookmarks :: Maybe Text -> Maybe Text -> Bookmark -> Bool
- bookmarksFromDefault :: MonadIO m => [DefaultBookmark] -> m Bookmarks
- getBookmarks :: HoyoMonad Bookmarks
Documentation
decodeBookmarksFile :: MonadIO m => FilePath -> m (Either Text Bookmarks) Source #
Decode a Bookmark from a file.
encodeBookmarksFile :: MonadIO m => FilePath -> Bookmarks -> m () Source #
Encode a Bookmark to a file.
searchBookmarks :: BookmarkSearchTerm -> Bookmarks -> ([Bookmark], [Bookmark]) Source #
searchBookmarks searchTerm bookmarks partitions bookmarks into a list of
Bookmarks that match the search term and a list of those that do not.
filterBookmarkByName :: Maybe Text -> Bookmark -> Bool Source #
A predicate used by filterBookmarks - match on the bookmark name.
Note that matching is case-sensitive.
filterBookmarkByDirInfix :: Maybe Text -> Bookmark -> Bool Source #
A predicate used by filterBookmarks - match on the bookmark directory.
filterBookmarks :: Maybe Text -> Maybe Text -> Bookmark -> Bool Source #
Given a bookmark name and a bookmark directory, test if a bookmark matches those filters.
bookmarksFromDefault :: MonadIO m => [DefaultBookmark] -> m Bookmarks Source #
Convert a list of DefaultBookmarks to a Bookmarks, assiging indices and/
diff --git a/docs/Hoyo-Internal-Command.html b/docs/Hoyo-Internal-Command.html
index 32bd73f..8f14d6c 100644
--- a/docs/Hoyo-Internal-Command.html
+++ b/docs/Hoyo-Internal-Command.html
@@ -1,4 +1,4 @@
-
| Copyright | (c) Frederick Pringle 2023 |
|---|---|
| License | BSD-3-Clause |
| Maintainer | freddyjepringle@gmail.com |
| Safe Haskell | None |
| Language | Haskell2010 |
Hoyo.Internal.Command
Description
Internals used by the Hoyo.Command module.
Synopsis
- combOverride :: Bool -> Bool -> MaybeOverride
- overrideFunc :: MaybeOverride -> Bool -> Bool
- overrideConfig :: OverrideOptions -> Config -> Config
- overrideEnv :: OverrideOptions -> Env -> Env
- verifyOverrides :: OverrideOptions -> Maybe Text
- defaultOverrideOptions :: OverrideOptions
- defaultGlobalOptions :: GlobalOptions
- modifyBookmarks :: ([Bookmark] -> [Bookmark]) -> HoyoMonad ()
- modifyBookmarksM :: ([Bookmark] -> HoyoMonad [Bookmark]) -> HoyoMonad ()
- normaliseAndVerifyDirectory :: FilePath -> HoyoMonad FilePath
- verifyName :: Text -> HoyoMonad ()
- testNameUnique :: [Bookmark] -> Text -> HoyoMonad Bool
- runAdd :: AddOptions -> HoyoMonad ()
- runMove :: MoveOptions -> HoyoMonad ()
- runList :: ListOptions -> HoyoMonad ()
- clearDisabledErrMsg :: Text
- resetDisabledErrMsg :: Text
- runClear :: ClearOptions -> HoyoMonad ()
- runDelete :: DeleteOptions -> HoyoMonad ()
- runRefresh :: RefreshOptions -> HoyoMonad ()
- runConfigPrint :: ConfigPrintOptions -> HoyoMonad ()
- runConfigReset :: ConfigResetOptions -> HoyoMonad ()
- runConfigSet :: ConfigSetOptions -> HoyoMonad ()
- runAddDefault :: ConfigAddDefaultOptions -> HoyoMonad ()
- runConfig :: ConfigCommand -> HoyoMonad ()
- runCheckConfig :: FilePath -> IO ()
- runCheckBookmarks :: FilePath -> IO ()
- runCheck :: CheckOptions -> FilePath -> FilePath -> IO ()
- runDefaultCommand :: HoyoMonad ()
- runHelp :: HelpOptions -> HoyoMonad ()
- runCommand :: Command -> HoyoMonad ()
Documentation
combOverride :: Bool -> Bool -> MaybeOverride Source #
Combine a config flag with a command-line flag, checking for conflicts.
overrideFunc :: MaybeOverride -> Bool -> Bool Source #
Convert a MaybeOverride to a function on Bool.
overrideConfig :: OverrideOptions -> Config -> Config Source #
Apply the override options to a Config.
overrideEnv :: OverrideOptions -> Env -> Env Source #
Apply the override options to an Env.
verifyOverrides :: OverrideOptions -> Maybe Text Source #
Check that there are no conflicting overrides.
defaultOverrideOptions :: OverrideOptions Source #
The default behaviour is to override nothing.
defaultGlobalOptions :: GlobalOptions Source #
Default global options. In general this should do nothing.
modifyBookmarks :: ([Bookmark] -> [Bookmark]) -> HoyoMonad () Source #
Helper function whenever we need to modify the saved bookmarks.
modifyBookmarks f retrieves the current bookmarks, applies f,
+
| Copyright | (c) Frederick Pringle 2023 |
|---|---|
| License | BSD-3-Clause |
| Maintainer | freddyjepringle@gmail.com |
| Safe Haskell | None |
| Language | Haskell2010 |
Hoyo.Internal.Command
Description
Internals used by the Hoyo.Command module.
Synopsis
- combOverride :: Bool -> Bool -> MaybeOverride
- overrideFunc :: MaybeOverride -> Bool -> Bool
- overrideConfig :: OverrideOptions -> Config -> Config
- overrideEnv :: OverrideOptions -> Env -> Env
- verifyOverrides :: OverrideOptions -> Maybe Text
- defaultOverrideOptions :: OverrideOptions
- defaultGlobalOptions :: GlobalOptions
- modifyBookmarks :: ([Bookmark] -> [Bookmark]) -> HoyoMonad ()
- modifyBookmarksM :: ([Bookmark] -> HoyoMonad [Bookmark]) -> HoyoMonad ()
- normaliseAndVerifyDirectory :: FilePath -> HoyoMonad FilePath
- verifyName :: Text -> HoyoMonad ()
- testNameUnique :: [Bookmark] -> Text -> HoyoMonad Bool
- runAdd :: AddOptions -> HoyoMonad ()
- runMove :: MoveOptions -> HoyoMonad ()
- runList :: ListOptions -> HoyoMonad ()
- clearDisabledErrMsg :: Text
- resetDisabledErrMsg :: Text
- runClear :: ClearOptions -> HoyoMonad ()
- runDelete :: DeleteOptions -> HoyoMonad ()
- runRefresh :: RefreshOptions -> HoyoMonad ()
- runConfigPrint :: ConfigPrintOptions -> HoyoMonad ()
- runConfigReset :: ConfigResetOptions -> HoyoMonad ()
- runConfigSet :: ConfigSetOptions -> HoyoMonad ()
- runAddDefault :: ConfigAddDefaultOptions -> HoyoMonad ()
- runConfig :: ConfigCommand -> HoyoMonad ()
- runCheckConfig :: FilePath -> IO ()
- runCheckBookmarks :: FilePath -> IO ()
- runCheck :: CheckOptions -> FilePath -> FilePath -> IO ()
- runDefaultCommand :: HoyoMonad ()
- runHelp :: HelpOptions -> HoyoMonad ()
- runCommand :: Command -> HoyoMonad ()
Documentation
combOverride :: Bool -> Bool -> MaybeOverride Source #
Combine a config flag with a command-line flag, checking for conflicts.
overrideFunc :: MaybeOverride -> Bool -> Bool Source #
Convert a MaybeOverride to a function on Bool.
overrideConfig :: OverrideOptions -> Config -> Config Source #
Apply the override options to a Config.
overrideEnv :: OverrideOptions -> Env -> Env Source #
Apply the override options to an Env.
verifyOverrides :: OverrideOptions -> Maybe Text Source #
Check that there are no conflicting overrides.
defaultOverrideOptions :: OverrideOptions Source #
The default behaviour is to override nothing.
defaultGlobalOptions :: GlobalOptions Source #
Default global options. In general this should do nothing.
modifyBookmarks :: ([Bookmark] -> [Bookmark]) -> HoyoMonad () Source #
Helper function whenever we need to modify the saved bookmarks.
modifyBookmarks f retrieves the current bookmarks, applies f,
and saves them back to file.
modifyBookmarksM :: ([Bookmark] -> HoyoMonad [Bookmark]) -> HoyoMonad () Source #
Helper function twhenever we need to modify the saved bookmarks, and need access to the hoyo environment.
modifyBookmarks f retrieves the current bookmarks, applies f
in the hoyo environment, and saves them back to file.
normaliseAndVerifyDirectory :: FilePath -> HoyoMonad FilePath Source #
Normalise a filepath and make sure it's a valid directory.
verifyName :: Text -> HoyoMonad () Source #
Take a name and make sure it's valid.
testNameUnique :: [Bookmark] -> Text -> HoyoMonad Bool Source #
Given the existing bookmarks and a potential bookmark name, diff --git a/docs/Hoyo-Internal-Config.html b/docs/Hoyo-Internal-Config.html index 11b29d6..4c00f0f 100644 --- a/docs/Hoyo-Internal-Config.html +++ b/docs/Hoyo-Internal-Config.html @@ -1,3 +1,3 @@ -
| Copyright | (c) Frederick Pringle 2023 |
|---|---|
| License | BSD-3-Clause |
| Maintainer | freddyjepringle@gmail.com |
| Safe Haskell | None |
| Language | Haskell2010 |
Hoyo.Internal.Config
Description
Internals used by the Hoyo.Config module.
Synopsis
- configCodec :: TomlCodec Config
- commandCodec :: Key -> TomlCodec Command
- defaultConfig :: Config
- decodeConfig :: Text -> Either Text Config
- decodeConfigFile :: MonadIO m => FilePath -> m (Either Text Config)
- encodeConfig :: Config -> Text
- encodeConfigFile :: MonadIO m => FilePath -> Config -> m ()
- getKeyVals :: Config -> [(Text, AnyConfigValue)]
- setConfig :: MonadError Text m => Text -> Text -> Config -> m Config
Documentation
configCodec :: TomlCodec Config Source #
A TOML codec describing how to convert a Config to and from its
+
| Copyright | (c) Frederick Pringle 2023 |
|---|---|
| License | BSD-3-Clause |
| Maintainer | freddyjepringle@gmail.com |
| Safe Haskell | None |
| Language | Haskell2010 |
Hoyo.Internal.Config
Description
Internals used by the Hoyo.Config module.
Synopsis
- configCodec :: TomlCodec Config
- commandCodec :: Key -> TomlCodec Command
- defaultConfig :: Config
- decodeConfig :: Text -> Either Text Config
- decodeConfigFile :: MonadIO m => FilePath -> m (Either Text Config)
- encodeConfig :: Config -> Text
- encodeConfigFile :: MonadIO m => FilePath -> Config -> m ()
- getKeyVals :: Config -> [(Text, AnyConfigValue)]
- setConfig :: MonadError Text m => Text -> Text -> Config -> m Config
Documentation
configCodec :: TomlCodec Config Source #
A TOML codec describing how to convert a Config to and from its
TOML representation.
commandCodec :: Key -> TomlCodec Command Source #
Toml codec using optparse-applicative to parse a default command. Incurs a cyclic dependency which is resolved using Parse.hs-boot.
defaultConfig :: Config Source #
The default config for hoyo.
decodeConfigFile :: MonadIO m => FilePath -> m (Either Text Config) Source #
Decode a Config from a file.
getKeyVals :: Config -> [(Text, AnyConfigValue)] Source #
Get TOML key-value pairs from a Config.
| Copyright | (c) Frederick Pringle 2023 |
|---|---|
| License | BSD-3-Clause |
| Maintainer | freddyjepringle@gmail.com |
| Safe Haskell | None |
| Language | Haskell2010 |
Hoyo.Internal.Env
Description
Internals used by the Hoyo.Internal module.
Synopsis
- writeEnv :: MonadIO m => Env -> m ()
- readEnv :: MonadIO m => FilePath -> FilePath -> m (Either Text Env)
- initPath :: MonadIO m => FilePath -> m ()
- initEnv :: MonadIO m => FilePath -> FilePath -> m ()
- initBookmarksIfNotExists :: (MonadIO m, MonadError Text m) => Config -> FilePath -> m Bookmarks
- initConfigIfNotExists :: (MonadIO m, MonadError Text m) => FilePath -> m Config
- initEnvIfNotExists :: (MonadIO m, MonadError Text m) => FilePath -> FilePath -> m Env
- getEnv :: MonadIO m => FilePath -> FilePath -> m (Either Text Env)
- defaultConfigPath :: IO FilePath
- defaultBookmarksPath :: IO FilePath
Documentation
readEnv :: MonadIO m => FilePath -> FilePath -> m (Either Text Env) Source #
Read an Env from a file.
initPath :: MonadIO m => FilePath -> m () Source #
Given a file path, make sure that its directory exists.
initEnv :: MonadIO m => FilePath -> FilePath -> m () Source #
Given a filepath for the bookmarks file and a filepath for the config file, +
| Copyright | (c) Frederick Pringle 2023 |
|---|---|
| License | BSD-3-Clause |
| Maintainer | freddyjepringle@gmail.com |
| Safe Haskell | None |
| Language | Haskell2010 |
Hoyo.Internal.Env
Description
Internals used by the Hoyo.Internal module.
Synopsis
- writeEnv :: MonadIO m => Env -> m ()
- readEnv :: MonadIO m => FilePath -> FilePath -> m (Either Text Env)
- initPath :: MonadIO m => FilePath -> m ()
- initEnv :: MonadIO m => FilePath -> FilePath -> m ()
- initBookmarksIfNotExists :: (MonadIO m, MonadError Text m) => Config -> FilePath -> m Bookmarks
- initConfigIfNotExists :: (MonadIO m, MonadError Text m) => FilePath -> m Config
- initEnvIfNotExists :: (MonadIO m, MonadError Text m) => FilePath -> FilePath -> m Env
- getEnv :: MonadIO m => FilePath -> FilePath -> m (Either Text Env)
- defaultConfigPath :: IO FilePath
- defaultBookmarksPath :: IO FilePath
Documentation
readEnv :: MonadIO m => FilePath -> FilePath -> m (Either Text Env) Source #
Read an Env from a file.
initPath :: MonadIO m => FilePath -> m () Source #
Given a file path, make sure that its directory exists.
initEnv :: MonadIO m => FilePath -> FilePath -> m () Source #
Given a filepath for the bookmarks file and a filepath for the config file, initialize the respective TOMLs at those locations.
initBookmarksIfNotExists :: (MonadIO m, MonadError Text m) => Config -> FilePath -> m Bookmarks Source #
If the bookmarks path doesn't exist, try to create it.
Returns the newly created Bookmarks object, or the result of parsing
the file if it already existed.
initConfigIfNotExists :: (MonadIO m, MonadError Text m) => FilePath -> m Config Source #
If the config path doesn't exist, try to create it.
Returns the newly created Config object, or the result of parsing
the file if it already existed.
initEnvIfNotExists :: (MonadIO m, MonadError Text m) => FilePath -> FilePath -> m Env Source #
If the environment files have not been created yet, do so.
Return the Env object.
getEnv :: MonadIO m => FilePath -> FilePath -> m (Either Text Env) Source #
Retrieve an Env from given bookmark- and config- file locations.
defaultConfigPath :: IO FilePath Source #
The default path for the hoyo config. Usually $HOME/.config/hoyo/config.toml
defaultBookmarksPath :: IO FilePath Source #
The default path for hoyo bookmarks. Usually $HOME/.local/share/hoyo/config.toml
| Copyright | (c) Frederick Pringle 2023 |
|---|---|
| License | BSD-3-Clause |
| Maintainer | freddyjepringle@gmail.com |
| Safe Haskell | None |
| Language | Haskell2010 |
Hoyo.Internal.Parse
Description
Parse CLI arguments.
Synopsis
- globalOptions :: Parser GlobalOptions
- overrideOptions :: Parser OverrideOptions
- parseOverride :: Mod FlagFields Bool -> Mod FlagFields Bool -> Parser MaybeOverride
- parseOverrideFailOnError :: Parser MaybeOverride
- parseOverrideDisplayCreationTime :: Parser MaybeOverride
- parseOverrideEnableClearing :: Parser MaybeOverride
- parseOverrideEnableReset :: Parser MaybeOverride
- parseOverrideBackupBeforeClear :: Parser MaybeOverride
- addCommand :: Parser Command
- bookmarkSearchTerm :: ReadM BookmarkSearchTerm
- moveCommand :: Parser Command
- listCommand :: Parser Command
- clearCommand :: Parser Command
- deleteCommand :: Parser Command
- refreshCommand :: Parser Command
- configCommand :: Parser Command
- configPrintCommand :: Parser ConfigCommand
- configResetCommand :: Parser ConfigCommand
- configSetCommand :: Parser ConfigCommand
- configAddDefaultCommand :: Parser ConfigCommand
- noArgs :: CheckOptions -> CheckOptions
- checkCommand :: Parser Command
- helpCommand :: Parser Command
- defaultCommand :: Parser Command
- parseCommand :: Parser Command
- parseOptions :: Parser Options
- versionInfo :: String
- versionOption :: Parser (a -> a)
- hoyoFooter :: Chunk Doc
- options :: ParserInfo Options
- showHelp :: Maybe String -> IO ()
- splitArgs :: Text -> [String]
Documentation
globalOptions :: Parser GlobalOptions Source #
Parse global options: options that can be set on the command line +
| Copyright | (c) Frederick Pringle 2023 |
|---|---|
| License | BSD-3-Clause |
| Maintainer | freddyjepringle@gmail.com |
| Safe Haskell | None |
| Language | Haskell2010 |
Hoyo.Internal.Parse
Description
Parse CLI arguments.
Synopsis
- globalOptions :: Parser GlobalOptions
- overrideOptions :: Parser OverrideOptions
- parseOverride :: Mod FlagFields Bool -> Mod FlagFields Bool -> Parser MaybeOverride
- parseOverrideFailOnError :: Parser MaybeOverride
- parseOverrideDisplayCreationTime :: Parser MaybeOverride
- parseOverrideEnableClearing :: Parser MaybeOverride
- parseOverrideEnableReset :: Parser MaybeOverride
- parseOverrideBackupBeforeClear :: Parser MaybeOverride
- addCommand :: Parser Command
- bookmarkSearchTerm :: ReadM BookmarkSearchTerm
- moveCommand :: Parser Command
- listCommand :: Parser Command
- clearCommand :: Parser Command
- deleteCommand :: Parser Command
- refreshCommand :: Parser Command
- configCommand :: Parser Command
- configPrintCommand :: Parser ConfigCommand
- configResetCommand :: Parser ConfigCommand
- configSetCommand :: Parser ConfigCommand
- configAddDefaultCommand :: Parser ConfigCommand
- noArgs :: CheckOptions -> CheckOptions
- checkCommand :: Parser Command
- helpCommand :: Parser Command
- defaultCommand :: Parser Command
- parseCommand :: Parser Command
- parseOptions :: Parser Options
- versionInfo :: String
- versionOption :: Parser (a -> a)
- hoyoFooter :: Chunk Doc
- options :: ParserInfo Options
- showHelp :: Maybe String -> IO ()
- splitArgs :: Text -> [String]
Documentation
globalOptions :: Parser GlobalOptions Source #
Parse global options: options that can be set on the command line no matter what sub-command is being run.
For a complete list of the global options, see GlobalOptions or
run hoyo --help.
overrideOptions :: Parser OverrideOptions Source #
Parse override options: options that override config settings. This can be useful when you want to temporarily enable functionality diff --git a/docs/Hoyo-Internal-Types.html b/docs/Hoyo-Internal-Types.html index 9860c00..c28d574 100644 --- a/docs/Hoyo-Internal-Types.html +++ b/docs/Hoyo-Internal-Types.html @@ -1,4 +1,4 @@ -
| Copyright | (c) Frederick Pringle 2023 |
|---|---|
| License | BSD-3-Clause |
| Maintainer | freddyjepringle@gmail.com |
| Safe Haskell | None |
| Language | Haskell2010 |
Hoyo.Internal.Types
Description
Types used by all the main Hoyo.* modules.
Synopsis
- data Env = Env {
- _bookmarks :: !Bookmarks
- _bookmarksPath :: !FilePath
- _config :: !Config
- _configPath :: !FilePath
- data Bookmark = Bookmark {}
- data DefaultBookmark = DefaultBookmark {}
- newtype Bookmarks = Bookmarks {
- unBookmarks :: [Bookmark]
- data BookmarkSearchTerm
- data ConfigValueType
- data ConfigValue (t :: ConfigValueType) where
- BoolV :: Bool -> ConfigValue 'TBool
- DefaultBookmarkV :: DefaultBookmark -> ConfigValue 'TDefaultBookmark
- CommandV :: Command -> ConfigValue 'TCommand
- ListOfV :: forall (a :: ConfigValueType). [ConfigValue a] -> ConfigValue ('TList a)
- MaybeV :: forall (a :: ConfigValueType). Maybe (ConfigValue a) -> ConfigValue ('TMaybe a)
- data AnyConfigValue = forall (t :: ConfigValueType). AnyConfigValue (ConfigValue t)
- data Config = Config {
- _failOnError :: !(ConfigValue 'TBool)
- _displayCreationTime :: !(ConfigValue 'TBool)
- _enableClearing :: !(ConfigValue 'TBool)
- _enableReset :: !(ConfigValue 'TBool)
- _backupBeforeClear :: !(ConfigValue 'TBool)
- _defaultBookmarks :: !(ConfigValue ('TList 'TDefaultBookmark))
- _defaultCommand :: !(ConfigValue ('TMaybe 'TCommand))
- newtype HoyoMonad a = HoyoMonad {}
- data AddOptions = AddOptions {
- addDirectory :: FilePath
- addName :: Maybe Text
- newtype MoveOptions = MoveOptions {}
- data ListOptions = ListOptions {}
- data ClearOptions = ClearOptions
- newtype DeleteOptions = DeleteOptions {}
- data RefreshOptions = RefreshOptions
- newtype ConfigPrintOptions = ConfigPrintOptions {}
- data ConfigResetOptions = ConfigResetOptions
- data ConfigSetOptions = ConfigSetOptions {}
- data ConfigAddDefaultOptions = ConfigAddDefaultOptions {}
- data ConfigCommand
- data CheckOptions = CheckOptions {}
- data Command
- data MaybeOverride
- data OverrideOptions = OverrideOptions {}
- data GlobalOptions = GlobalOptions {}
- data Options = Options {}
Documentation
The main hoyo read-only environment. Contains the current saved bookmarks, +
| Copyright | (c) Frederick Pringle 2023 |
|---|---|
| License | BSD-3-Clause |
| Maintainer | freddyjepringle@gmail.com |
| Safe Haskell | None |
| Language | Haskell2010 |
Hoyo.Internal.Types
Description
Types used by all the main Hoyo.* modules.
Synopsis
- data Env = Env {
- _bookmarks :: !Bookmarks
- _bookmarksPath :: !FilePath
- _config :: !Config
- _configPath :: !FilePath
- data Bookmark = Bookmark {}
- data DefaultBookmark = DefaultBookmark {}
- newtype Bookmarks = Bookmarks {
- unBookmarks :: [Bookmark]
- data BookmarkSearchTerm
- data ConfigValueType
- data ConfigValue (t :: ConfigValueType) where
- BoolV :: Bool -> ConfigValue 'TBool
- DefaultBookmarkV :: DefaultBookmark -> ConfigValue 'TDefaultBookmark
- CommandV :: Command -> ConfigValue 'TCommand
- ListOfV :: forall (a :: ConfigValueType). [ConfigValue a] -> ConfigValue ('TList a)
- MaybeV :: forall (a :: ConfigValueType). Maybe (ConfigValue a) -> ConfigValue ('TMaybe a)
- data AnyConfigValue = forall (t :: ConfigValueType). AnyConfigValue (ConfigValue t)
- data Config = Config {
- _failOnError :: !(ConfigValue 'TBool)
- _displayCreationTime :: !(ConfigValue 'TBool)
- _enableClearing :: !(ConfigValue 'TBool)
- _enableReset :: !(ConfigValue 'TBool)
- _backupBeforeClear :: !(ConfigValue 'TBool)
- _defaultBookmarks :: !(ConfigValue ('TList 'TDefaultBookmark))
- _defaultCommand :: !(ConfigValue ('TMaybe 'TCommand))
- newtype HoyoMonad a = HoyoMonad {}
- data AddOptions = AddOptions {
- addDirectory :: FilePath
- addName :: Maybe Text
- newtype MoveOptions = MoveOptions {}
- data ListOptions = ListOptions {}
- data ClearOptions = ClearOptions
- newtype DeleteOptions = DeleteOptions {}
- data RefreshOptions = RefreshOptions
- newtype ConfigPrintOptions = ConfigPrintOptions {}
- data ConfigResetOptions = ConfigResetOptions
- data ConfigSetOptions = ConfigSetOptions {}
- data ConfigAddDefaultOptions = ConfigAddDefaultOptions {}
- data ConfigCommand
- data CheckOptions = CheckOptions {}
- data Command
- data MaybeOverride
- data OverrideOptions = OverrideOptions {}
- data GlobalOptions = GlobalOptions {}
- data Options = Options {}
Documentation
The main hoyo read-only environment. Contains the current saved bookmarks, the current hoyo configuration, and the file locations for each.
Constructors
| Env | |
Fields
| |
Bookmark a directory for easy cd. A bookmark remembers the directory,
the index, the creation time, and optionally a user-specified nickname
for the bookmark.
Constructors
| Bookmark | |
Fields
| |
data DefaultBookmark Source #
Default bookmarks to save at init. A default bookmark remembers the directory diff --git a/docs/Hoyo-Internal-Utils.html b/docs/Hoyo-Internal-Utils.html index 0e8d442..1cb7a8a 100644 --- a/docs/Hoyo-Internal-Utils.html +++ b/docs/Hoyo-Internal-Utils.html @@ -1,4 +1,4 @@ -
| Copyright | (c) Frederick Pringle 2023 |
|---|---|
| License | BSD-3-Clause |
| Maintainer | freddyjepringle@gmail.com |
| Safe Haskell | None |
| Language | Haskell2010 |
Hoyo.Internal.Utils
Description
Utility functions used by all the main Hoyo.* modules.
Synopsis
- cfgBool :: Lens' (ConfigValue 'TBool) Bool
- cfgDefaultBookmark :: Lens' (ConfigValue 'TDefaultBookmark) DefaultBookmark
- cfgCommand :: Lens' (ConfigValue 'TCommand) Command
- cfgList :: Lens' (ConfigValue ('TList t)) [ConfigValue t]
- cfgMaybe :: Lens' (ConfigValue ('TMaybe t)) (Maybe (ConfigValue t))
- failOnError :: Lens' Config Bool
- displayCreationTime :: Lens' Config Bool
- enableClearing :: Lens' Config Bool
- enableReset :: Lens' Config Bool
- backupBeforeClear :: Lens' Config Bool
- defaultBookmarks :: Lens' Config [DefaultBookmark]
- defaultCommand :: Lens' Config (Maybe Command)
- asks' :: MonadReader a m => SimpleGetter a b -> m b
- assert :: Text -> HoyoMonad Bool -> HoyoMonad ()
- assertVerbose :: Text -> HoyoMonad Bool -> HoyoMonad Bool
- maximumDefault :: Ord a => a -> [a] -> a
- backupFile :: (MonadIO m, MonadError Text m) => FilePath -> String -> m ()
- readBool :: MonadError Text m => Text -> m Bool
- readInt :: MonadError Text m => Text -> m Int
- printStdout :: MonadIO m => Text -> m ()
- printStderr :: MonadIO m => Text -> m ()
- pageLines :: MonadIO m => [Text] -> m ()
- formatArgs :: [Text] -> Text
- formatCommand :: Command -> [Text]
- formatBookmark :: Bool -> Int -> Int -> Bookmark -> Text
- formatBookmarks :: Bool -> [Bookmark] -> [Text]
- formatConfigValue :: AnyConfigValue -> Text
- formatOptions :: Options -> [Text]
- tshow :: Show a => a -> Text
- anyCfgValToJson :: AnyConfigValue -> JSValue
- bookmarksToJSON :: Bool -> [Bookmark] -> JSValue
Lenses for ConfigValue
cfgDefaultBookmark :: Lens' (ConfigValue 'TDefaultBookmark) DefaultBookmark Source #
A lens into a default bookmark config value.
cfgCommand :: Lens' (ConfigValue 'TCommand) Command Source #
A lens into a command config value.
cfgList :: Lens' (ConfigValue ('TList t)) [ConfigValue t] Source #
A lens into a list config value.
cfgMaybe :: Lens' (ConfigValue ('TMaybe t)) (Maybe (ConfigValue t)) Source #
A lens into an optional config value.
Lenses for Config
Utility functions
asks' :: MonadReader a m => SimpleGetter a b -> m b Source #
A version of the lens "use" function for MonadReader.
assertVerbose :: Text -> HoyoMonad Bool -> HoyoMonad Bool Source #
Throw an error if a check fails AND the "fail_on_error" flag is set.
maximumDefault :: Ord a => a -> [a] -> a Source #
Take the maximum of a list, with a default value if the list is empty.
Backups
backupFile :: (MonadIO m, MonadError Text m) => FilePath -> String -> m () Source #
Try to back-up a file. Used when the "backup_before_clear" option is set.
Parsing functions
Printing functions
printStdout :: MonadIO m => Text -> m () Source #
Print to stdout.
printStderr :: MonadIO m => Text -> m () Source #
Print to stderr.
pageLines :: MonadIO m => [Text] -> m () Source #
Page lines if larger than one page and if the output device is a terminal. +
| Copyright | (c) Frederick Pringle 2023 |
|---|---|
| License | BSD-3-Clause |
| Maintainer | freddyjepringle@gmail.com |
| Safe Haskell | None |
| Language | Haskell2010 |
Hoyo.Internal.Utils
Description
Utility functions used by all the main Hoyo.* modules.
Synopsis
- cfgBool :: Lens' (ConfigValue 'TBool) Bool
- cfgDefaultBookmark :: Lens' (ConfigValue 'TDefaultBookmark) DefaultBookmark
- cfgCommand :: Lens' (ConfigValue 'TCommand) Command
- cfgList :: Lens' (ConfigValue ('TList t)) [ConfigValue t]
- cfgMaybe :: Lens' (ConfigValue ('TMaybe t)) (Maybe (ConfigValue t))
- failOnError :: Lens' Config Bool
- displayCreationTime :: Lens' Config Bool
- enableClearing :: Lens' Config Bool
- enableReset :: Lens' Config Bool
- backupBeforeClear :: Lens' Config Bool
- defaultBookmarks :: Lens' Config [DefaultBookmark]
- defaultCommand :: Lens' Config (Maybe Command)
- asks' :: MonadReader a m => SimpleGetter a b -> m b
- assert :: Text -> HoyoMonad Bool -> HoyoMonad ()
- assertVerbose :: Text -> HoyoMonad Bool -> HoyoMonad Bool
- maximumDefault :: Ord a => a -> [a] -> a
- backupFile :: (MonadIO m, MonadError Text m) => FilePath -> String -> m ()
- readBool :: MonadError Text m => Text -> m Bool
- readInt :: MonadError Text m => Text -> m Int
- printStdout :: MonadIO m => Text -> m ()
- printStderr :: MonadIO m => Text -> m ()
- pageLines :: MonadIO m => [Text] -> m ()
- formatArgs :: [Text] -> Text
- formatCommand :: Command -> [Text]
- formatBookmark :: Bool -> Int -> Int -> Bookmark -> Text
- formatBookmarks :: Bool -> [Bookmark] -> [Text]
- formatConfigValue :: AnyConfigValue -> Text
- formatOptions :: Options -> [Text]
- tshow :: Show a => a -> Text
- anyCfgValToJson :: AnyConfigValue -> JSValue
- bookmarksToJSON :: Bool -> [Bookmark] -> JSValue
Lenses for ConfigValue
cfgDefaultBookmark :: Lens' (ConfigValue 'TDefaultBookmark) DefaultBookmark Source #
A lens into a default bookmark config value.
cfgCommand :: Lens' (ConfigValue 'TCommand) Command Source #
A lens into a command config value.
cfgList :: Lens' (ConfigValue ('TList t)) [ConfigValue t] Source #
A lens into a list config value.
cfgMaybe :: Lens' (ConfigValue ('TMaybe t)) (Maybe (ConfigValue t)) Source #
A lens into an optional config value.
Lenses for Config
Utility functions
asks' :: MonadReader a m => SimpleGetter a b -> m b Source #
A version of the lens "use" function for MonadReader.
assertVerbose :: Text -> HoyoMonad Bool -> HoyoMonad Bool Source #
Throw an error if a check fails AND the "fail_on_error" flag is set.
maximumDefault :: Ord a => a -> [a] -> a Source #
Take the maximum of a list, with a default value if the list is empty.
Backups
backupFile :: (MonadIO m, MonadError Text m) => FilePath -> String -> m () Source #
Try to back-up a file. Used when the "backup_before_clear" option is set.
Parsing functions
Printing functions
printStdout :: MonadIO m => Text -> m () Source #
Print to stdout.
printStderr :: MonadIO m => Text -> m () Source #
Print to stderr.
pageLines :: MonadIO m => [Text] -> m () Source #
Page lines if larger than one page and if the output device is a terminal. Otherwise, print.
Formatting functions
formatArgs :: [Text] -> Text Source #
Format a list of arguments into a single Text, enclosing multi-word arguments in quotes.
formatCommand :: Command -> [Text] Source #
Format a Command in the same way it would be parsed from the command line.
formatBookmark :: Bool -> Int -> Int -> Bookmark -> Text Source #
Format a Bookmark. Used for the "list" command and error reporting
during other commands.
formatBookmark displayTime numberWidth bm returns a pretty representation
of bm, optionally showing the creation time, and padding the index and
diff --git a/docs/Hoyo-Internal-Version.html b/docs/Hoyo-Internal-Version.html
index 9ae40ab..d0c1191 100644
--- a/docs/Hoyo-Internal-Version.html
+++ b/docs/Hoyo-Internal-Version.html
@@ -1 +1 @@
-
| Copyright | (c) Frederick Pringle 2023 |
|---|---|
| License | BSD-3-Clause |
| Maintainer | freddyjepringle@gmail.com |
| Safe Haskell | None |
| Language | Haskell2010 |
Hoyo.Internal.Version
Description
This module just exports a string containing the current Hoyo version.
Synopsis
Documentation
versionString :: String Source #
The current hoyo version.
| Copyright | (c) Frederick Pringle 2023 |
|---|---|
| License | BSD-3-Clause |
| Maintainer | freddyjepringle@gmail.com |
| Safe Haskell | None |
| Language | Haskell2010 |
Hoyo.Internal.Version
Description
This module just exports a string containing the current Hoyo version.
Synopsis
Documentation
versionString :: String Source #
The current hoyo version.
| Copyright | (c) Frederick Pringle 2023 |
|---|---|
| License | BSD-3-Clause |
| Maintainer | freddyjepringle@gmail.com |
| Safe Haskell | None |
| Language | Haskell2010 |
Hoyo
Description
hoyo is a command-line utility that lets the user save directories +
| Copyright | (c) Frederick Pringle 2023 |
|---|---|
| License | BSD-3-Clause |
| Maintainer | freddyjepringle@gmail.com |
| Safe Haskell | None |
| Language | Haskell2010 |
Hoyo
Description
hoyo is a command-line utility that lets the user save directories
as bookmarks (similar to in the browser) and easily cd to them.
Synopsis
- data Bookmark = Bookmark {}
- newtype Bookmarks = Bookmarks {
- unBookmarks :: [Bookmark]
- searchBookmarks :: BookmarkSearchTerm -> Bookmarks -> ([Bookmark], [Bookmark])
- filterBookmarks :: Maybe Text -> Maybe Text -> Bookmark -> Bool
- module Hoyo.Bookmark
- data Config = Config {
- _failOnError :: !(ConfigValue 'TBool)
- _displayCreationTime :: !(ConfigValue 'TBool)
- _enableClearing :: !(ConfigValue 'TBool)
- _enableReset :: !(ConfigValue 'TBool)
- _backupBeforeClear :: !(ConfigValue 'TBool)
- _defaultBookmarks :: !(ConfigValue ('TList 'TDefaultBookmark))
- _defaultCommand :: !(ConfigValue ('TMaybe 'TCommand))
- defaultConfig :: Config
- setConfig :: MonadError Text m => Text -> Text -> Config -> m Config
- module Hoyo.Config
- module Hoyo.Env
- data Command
- runCommand :: Command -> HoyoMonad ()
- module Hoyo.Command
- runHoyo :: HoyoMonad a -> Env -> IO (Either Text a)
- withFiles :: GlobalOptions -> FilePath -> FilePath -> HoyoMonad a -> IO (Either Text a)
- getEnvAndRunHoyo :: GlobalOptions -> HoyoMonad a -> FilePath -> FilePath -> IO a
- getEnvAndRunCommand :: Options -> FilePath -> FilePath -> IO ()
- data HoyoMonad a
- modifyBookmarks :: ([Bookmark] -> [Bookmark]) -> HoyoMonad ()
- modifyBookmarksM :: ([Bookmark] -> HoyoMonad [Bookmark]) -> HoyoMonad ()
- printStderr :: MonadIO m => Text -> m ()
- printStdout :: MonadIO m => Text -> m ()
- readInt :: MonadError Text m => Text -> m Int
- readBool :: MonadError Text m => Text -> m Bool
- backupFile :: (MonadIO m, MonadError Text m) => FilePath -> String -> m ()
- assert :: Text -> HoyoMonad Bool -> HoyoMonad ()
- assertVerbose :: Text -> HoyoMonad Bool -> HoyoMonad Bool
- versionString :: String
Bookmarks
Bookmark a directory for easy cd. A bookmark remembers the directory,
the index, the creation time, and optionally a user-specified nickname
for the bookmark.
Constructors
| Bookmark | |
Fields
| |
Wrapper for [.Bookmark]
Constructors
| Bookmarks | |
Fields
| |
searchBookmarks :: BookmarkSearchTerm -> Bookmarks -> ([Bookmark], [Bookmark]) Source #
searchBookmarks searchTerm bookmarks partitions bookmarks into a list of
diff --git a/docs/doc-index-95.html b/docs/doc-index-95.html
index 8dbfdd0..c37e9e4 100644
--- a/docs/doc-index-95.html
+++ b/docs/doc-index-95.html
@@ -1 +1 @@
-
Index - _
Index - _
Index - A
| Add | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| addCommand | Hoyo.Internal.Parse, Hoyo.CLI.Parse |
| AddDefaultBookmark | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| addDefaultDir | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| addDefaultName | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| addDirectory | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| addName | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| AddOptions | |
| 1 (Type/Class) | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| 2 (Data Constructor) | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| anyCfgValToJson | Hoyo.Internal.Utils |
| AnyConfigValue | |
| 1 (Type/Class) | Hoyo.Internal.Types |
| 2 (Data Constructor) | Hoyo.Internal.Types |
| asks' | Hoyo.Internal.Utils |
| assert | Hoyo.Internal.Utils, Hoyo |
| assertVerbose | Hoyo.Internal.Utils, Hoyo |
Index - A
| Add | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| addCommand | Hoyo.Internal.Parse, Hoyo.CLI.Parse |
| AddDefaultBookmark | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| addDefaultDir | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| addDefaultName | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| addDirectory | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| addName | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| AddOptions | |
| 1 (Type/Class) | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| 2 (Data Constructor) | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| anyCfgValToJson | Hoyo.Internal.Utils |
| AnyConfigValue | |
| 1 (Type/Class) | Hoyo.Internal.Types |
| 2 (Data Constructor) | Hoyo.Internal.Types |
| asks' | Hoyo.Internal.Utils |
| assert | Hoyo.Internal.Utils, Hoyo |
| assertVerbose | Hoyo.Internal.Utils, Hoyo |
Index
Index
Index - B
| backupBeforeClear | Hoyo.Internal.Utils |
| backupFile | Hoyo.Internal.Utils, Hoyo |
| Bookmark | |
| 1 (Type/Class) | Hoyo.Internal.Types, Hoyo.Bookmark, Hoyo |
| 2 (Data Constructor) | Hoyo.Internal.Types, Hoyo.Bookmark, Hoyo |
| bookmarkCodec | Hoyo.Internal.Bookmark, Hoyo.Bookmark, Hoyo |
| bookmarkCompleter | Hoyo.CLI.Complete |
| bookmarkCreationTime | Hoyo.Internal.Types |
| bookmarkDirectory | Hoyo.Internal.Types |
| bookmarkIndex | Hoyo.Internal.Types |
| bookmarkName | Hoyo.Internal.Types |
| Bookmarks | |
| 1 (Type/Class) | Hoyo.Internal.Types, Hoyo.Bookmark, Hoyo |
| 2 (Data Constructor) | Hoyo.Internal.Types, Hoyo.Bookmark, Hoyo |
| bookmarks | Hoyo.Internal.Types |
| bookmarksCodec | Hoyo.Internal.Bookmark, Hoyo.Bookmark, Hoyo |
| BookmarkSearchTerm | Hoyo.Internal.Types, Hoyo.Bookmark, Hoyo |
| bookmarkSearchTerm | Hoyo.Internal.Parse |
| bookmarksFromDefault | Hoyo.Internal.Bookmark, Hoyo.Bookmark, Hoyo |
| bookmarksPath | Hoyo.Internal.Types |
| bookmarksToJSON | Hoyo.Internal.Utils |
| BoolV | Hoyo.Internal.Types |
Index - B
| backupBeforeClear | Hoyo.Internal.Utils |
| backupFile | Hoyo.Internal.Utils, Hoyo |
| Bookmark | |
| 1 (Type/Class) | Hoyo.Internal.Types, Hoyo.Bookmark, Hoyo |
| 2 (Data Constructor) | Hoyo.Internal.Types, Hoyo.Bookmark, Hoyo |
| bookmarkCodec | Hoyo.Internal.Bookmark, Hoyo.Bookmark, Hoyo |
| bookmarkCompleter | Hoyo.CLI.Complete |
| bookmarkCreationTime | Hoyo.Internal.Types |
| bookmarkDirectory | Hoyo.Internal.Types |
| bookmarkIndex | Hoyo.Internal.Types |
| bookmarkName | Hoyo.Internal.Types |
| Bookmarks | |
| 1 (Type/Class) | Hoyo.Internal.Types, Hoyo.Bookmark, Hoyo |
| 2 (Data Constructor) | Hoyo.Internal.Types, Hoyo.Bookmark, Hoyo |
| bookmarks | Hoyo.Internal.Types |
| bookmarksCodec | Hoyo.Internal.Bookmark, Hoyo.Bookmark, Hoyo |
| BookmarkSearchTerm | Hoyo.Internal.Types, Hoyo.Bookmark, Hoyo |
| bookmarkSearchTerm | Hoyo.Internal.Parse |
| bookmarksFromDefault | Hoyo.Internal.Bookmark, Hoyo.Bookmark, Hoyo |
| bookmarksPath | Hoyo.Internal.Types |
| bookmarksToJSON | Hoyo.Internal.Utils |
| BoolV | Hoyo.Internal.Types |
Index - C
Index - C
Index - D
Index - D
Index - E
| enableClearing | Hoyo.Internal.Utils |
| enableReset | Hoyo.Internal.Utils |
| encodeBookmarks | Hoyo.Internal.Bookmark, Hoyo.Bookmark, Hoyo |
| encodeBookmarksFile | Hoyo.Internal.Bookmark, Hoyo.Bookmark, Hoyo |
| encodeConfig | Hoyo.Internal.Config, Hoyo.Config, Hoyo |
| encodeConfigFile | Hoyo.Internal.Config, Hoyo.Config, Hoyo |
| Env | |
| 1 (Type/Class) | Hoyo.Internal.Types, Hoyo.Env, Hoyo |
| 2 (Data Constructor) | Hoyo.Internal.Types, Hoyo.Env, Hoyo |
Index - E
| enableClearing | Hoyo.Internal.Utils |
| enableReset | Hoyo.Internal.Utils |
| encodeBookmarks | Hoyo.Internal.Bookmark, Hoyo.Bookmark, Hoyo |
| encodeBookmarksFile | Hoyo.Internal.Bookmark, Hoyo.Bookmark, Hoyo |
| encodeConfig | Hoyo.Internal.Config, Hoyo.Config, Hoyo |
| encodeConfigFile | Hoyo.Internal.Config, Hoyo.Config, Hoyo |
| Env | |
| 1 (Type/Class) | Hoyo.Internal.Types, Hoyo.Env, Hoyo |
| 2 (Data Constructor) | Hoyo.Internal.Types, Hoyo.Env, Hoyo |
Index - F
| failOnError | Hoyo.Internal.Utils |
| filterBookmarkByDirInfix | Hoyo.Internal.Bookmark, Hoyo.Bookmark, Hoyo |
| filterBookmarkByName | Hoyo.Internal.Bookmark, Hoyo.Bookmark, Hoyo |
| filterBookmarks | Hoyo.Internal.Bookmark, Hoyo.Bookmark, Hoyo |
| formatArgs | Hoyo.Internal.Utils |
| formatBookmark | Hoyo.Internal.Utils, Hoyo.Bookmark, Hoyo |
| formatBookmarks | Hoyo.Internal.Utils, Hoyo.Bookmark, Hoyo |
| formatCommand | Hoyo.Internal.Utils |
| formatConfigValue | Hoyo.Internal.Utils |
| formatOptions | Hoyo.Internal.Utils |
Index - F
| failOnError | Hoyo.Internal.Utils |
| filterBookmarkByDirInfix | Hoyo.Internal.Bookmark, Hoyo.Bookmark, Hoyo |
| filterBookmarkByName | Hoyo.Internal.Bookmark, Hoyo.Bookmark, Hoyo |
| filterBookmarks | Hoyo.Internal.Bookmark, Hoyo.Bookmark, Hoyo |
| formatArgs | Hoyo.Internal.Utils |
| formatBookmark | Hoyo.Internal.Utils, Hoyo.Bookmark, Hoyo |
| formatBookmarks | Hoyo.Internal.Utils, Hoyo.Bookmark, Hoyo |
| formatCommand | Hoyo.Internal.Utils |
| formatConfigValue | Hoyo.Internal.Utils |
| formatOptions | Hoyo.Internal.Utils |
Index - G
| getBookmarks | Hoyo.Internal.Bookmark, Hoyo.Bookmark, Hoyo |
| getEnv | Hoyo.Internal.Env, Hoyo.Env, Hoyo |
| getEnvAndRunCommand | Hoyo |
| getEnvAndRunHoyo | Hoyo |
| getKeyVals | Hoyo.Internal.Config, Hoyo.Config, Hoyo |
| globalConfigPath | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| GlobalOptions | |
| 1 (Type/Class) | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| 2 (Data Constructor) | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| globalOptions | Hoyo.Internal.Parse, Hoyo.CLI.Parse |
Index - G
| getBookmarks | Hoyo.Internal.Bookmark, Hoyo.Bookmark, Hoyo |
| getEnv | Hoyo.Internal.Env, Hoyo.Env, Hoyo |
| getEnvAndRunCommand | Hoyo |
| getEnvAndRunHoyo | Hoyo |
| getKeyVals | Hoyo.Internal.Config, Hoyo.Config, Hoyo |
| globalConfigPath | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| GlobalOptions | |
| 1 (Type/Class) | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| 2 (Data Constructor) | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| globalOptions | Hoyo.Internal.Parse, Hoyo.CLI.Parse |
Index - H
| Help | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| helpCommand | Hoyo.Internal.Parse |
| HelpOptions | |
| 1 (Type/Class) | Hoyo.Internal.Types |
| 2 (Data Constructor) | Hoyo.Internal.Types |
| helpSubcommand | Hoyo.Internal.Types |
| hoyoFooter | Hoyo.Internal.Parse |
| HoyoMonad | |
| 1 (Type/Class) | Hoyo.Internal.Types, Hoyo |
| 2 (Data Constructor) | Hoyo.Internal.Types |
Index - H
| Help | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| helpCommand | Hoyo.Internal.Parse |
| HelpOptions | |
| 1 (Type/Class) | Hoyo.Internal.Types |
| 2 (Data Constructor) | Hoyo.Internal.Types |
| helpSubcommand | Hoyo.Internal.Types |
| hoyoFooter | Hoyo.Internal.Parse |
| HoyoMonad | |
| 1 (Type/Class) | Hoyo.Internal.Types, Hoyo |
| 2 (Data Constructor) | Hoyo.Internal.Types |
Index - I
| initBookmarksIfNotExists | Hoyo.Internal.Env |
| initConfigIfNotExists | Hoyo.Internal.Env |
| initEnv | Hoyo.Internal.Env, Hoyo.Env, Hoyo |
| initEnvIfNotExists | Hoyo.Internal.Env |
| initPath | Hoyo.Internal.Env |
Index - I
| initBookmarksIfNotExists | Hoyo.Internal.Env |
| initConfigIfNotExists | Hoyo.Internal.Env |
| initEnv | Hoyo.Internal.Env, Hoyo.Env, Hoyo |
| initEnvIfNotExists | Hoyo.Internal.Env |
| initPath | Hoyo.Internal.Env |
Index - L
| List | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| listCommand | Hoyo.Internal.Parse, Hoyo.CLI.Parse |
| listFilterDirectoryInfix | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| listFilterName | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| listJSONOutput | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| ListOfV | Hoyo.Internal.Types |
| ListOptions | |
| 1 (Type/Class) | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| 2 (Data Constructor) | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
Index - L
| List | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| listCommand | Hoyo.Internal.Parse, Hoyo.CLI.Parse |
| listFilterDirectoryInfix | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| listFilterName | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| listJSONOutput | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| ListOfV | Hoyo.Internal.Types |
| ListOptions | |
| 1 (Type/Class) | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| 2 (Data Constructor) | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
Index - M
| maximumDefault | Hoyo.Internal.Utils |
| MaybeOverride | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| MaybeV | Hoyo.Internal.Types |
| modifyBookmarks | Hoyo.Internal.Command, Hoyo.Command, Hoyo |
| modifyBookmarksM | Hoyo.Internal.Command, Hoyo.Command, Hoyo |
| Move | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| moveCommand | Hoyo.Internal.Parse, Hoyo.CLI.Parse |
| MoveOptions | |
| 1 (Type/Class) | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| 2 (Data Constructor) | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| moveSearch | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
Index - M
| maximumDefault | Hoyo.Internal.Utils |
| MaybeOverride | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| MaybeV | Hoyo.Internal.Types |
| modifyBookmarks | Hoyo.Internal.Command, Hoyo.Command, Hoyo |
| modifyBookmarksM | Hoyo.Internal.Command, Hoyo.Command, Hoyo |
| Move | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| moveCommand | Hoyo.Internal.Parse, Hoyo.CLI.Parse |
| MoveOptions | |
| 1 (Type/Class) | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| 2 (Data Constructor) | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| moveSearch | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
Index - N
| noArgs | Hoyo.Internal.Parse |
| NoOverride | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| normaliseAndVerifyDirectory | Hoyo.Internal.Command |
Index - N
| noArgs | Hoyo.Internal.Parse |
| NoOverride | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| normaliseAndVerifyDirectory | Hoyo.Internal.Command |
Index - O
Index - O
Index - P
| pageLines | Hoyo.Internal.Utils |
| parseCommand | Hoyo.Internal.Parse, Hoyo.CLI.Parse |
| parseOptions | Hoyo.Internal.Parse, Hoyo.CLI.Parse |
| parseOverride | Hoyo.Internal.Parse |
| parseOverrideBackupBeforeClear | Hoyo.Internal.Parse |
| parseOverrideDisplayCreationTime | Hoyo.Internal.Parse |
| parseOverrideEnableClearing | Hoyo.Internal.Parse |
| parseOverrideEnableReset | Hoyo.Internal.Parse |
| parseOverrideFailOnError | Hoyo.Internal.Parse |
| Hoyo.Internal.Types, Hoyo.Command, Hoyo | |
| printStderr | Hoyo.Internal.Utils, Hoyo |
| printStdout | Hoyo.Internal.Utils, Hoyo |
Index - P
| pageLines | Hoyo.Internal.Utils |
| parseCommand | Hoyo.Internal.Parse, Hoyo.CLI.Parse |
| parseOptions | Hoyo.Internal.Parse, Hoyo.CLI.Parse |
| parseOverride | Hoyo.Internal.Parse |
| parseOverrideBackupBeforeClear | Hoyo.Internal.Parse |
| parseOverrideDisplayCreationTime | Hoyo.Internal.Parse |
| parseOverrideEnableClearing | Hoyo.Internal.Parse |
| parseOverrideEnableReset | Hoyo.Internal.Parse |
| parseOverrideFailOnError | Hoyo.Internal.Parse |
| Hoyo.Internal.Types, Hoyo.Command, Hoyo | |
| printStderr | Hoyo.Internal.Utils, Hoyo |
| printStdout | Hoyo.Internal.Utils, Hoyo |
Index - R
Index - R
Index - S
| searchBookmarks | Hoyo.Internal.Bookmark, Hoyo.Bookmark, Hoyo |
| SearchIndex | Hoyo.Internal.Types, Hoyo.Bookmark, Hoyo |
| SearchName | Hoyo.Internal.Types, Hoyo.Bookmark, Hoyo |
| Set | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| setConfig | Hoyo.Internal.Config, Hoyo.Config, Hoyo |
| setKey | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| setValue | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| showHelp | Hoyo.Internal.Parse |
| splitArgs | Hoyo.Internal.Parse, Hoyo.CLI.Parse |
Index - S
| searchBookmarks | Hoyo.Internal.Bookmark, Hoyo.Bookmark, Hoyo |
| SearchIndex | Hoyo.Internal.Types, Hoyo.Bookmark, Hoyo |
| SearchName | Hoyo.Internal.Types, Hoyo.Bookmark, Hoyo |
| Set | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| setConfig | Hoyo.Internal.Config, Hoyo.Config, Hoyo |
| setKey | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| setValue | Hoyo.Internal.Types, Hoyo.Command, Hoyo |
| showHelp | Hoyo.Internal.Parse |
| splitArgs | Hoyo.Internal.Parse, Hoyo.CLI.Parse |
Index - T
| TBool | Hoyo.Internal.Types |
| TCommand | Hoyo.Internal.Types |
| TDefaultBookmark | Hoyo.Internal.Types |
| testNameUnique | Hoyo.Internal.Command |
| TList | Hoyo.Internal.Types |
| TMaybe | Hoyo.Internal.Types |
| tshow | Hoyo.Internal.Utils |
Index - T
| TBool | Hoyo.Internal.Types |
| TCommand | Hoyo.Internal.Types |
| TDefaultBookmark | Hoyo.Internal.Types |
| testNameUnique | Hoyo.Internal.Command |
| TList | Hoyo.Internal.Types |
| TMaybe | Hoyo.Internal.Types |
| tshow | Hoyo.Internal.Utils |
Index - U
| unBookmarks | Hoyo.Internal.Types, Hoyo.Bookmark, Hoyo |
| unHoyo | Hoyo.Internal.Types |
Index - U
| unBookmarks | Hoyo.Internal.Types, Hoyo.Bookmark, Hoyo |
| unHoyo | Hoyo.Internal.Types |
Index - V
| verifyName | Hoyo.Internal.Command |
| verifyOverrides | Hoyo.Internal.Command, Hoyo.Command, Hoyo |
| versionInfo | Hoyo.Internal.Parse |
| versionOption | Hoyo.Internal.Parse |
| versionString | Hoyo.Internal.Version, Hoyo |
Index - V
| verifyName | Hoyo.Internal.Command |
| verifyOverrides | Hoyo.Internal.Command, Hoyo.Command, Hoyo |
| versionInfo | Hoyo.Internal.Parse |
| versionOption | Hoyo.Internal.Parse |
| versionString | Hoyo.Internal.Version, Hoyo |
hoyo-0.5.1.0: Bookmark directories for cd
hoyo is a command-line utility enabling easy bookmarking +
hoyo-0.5.1.1: Bookmark directories for cd
hoyo is a command-line utility enabling easy bookmarking of directory for quick cd-like behaviour.
See the github readme for more information.