diff --git a/CHANGELOG.md b/CHANGELOG.md index 4ba1bc0..132835a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -16,6 +16,13 @@ and this project adheres to the ### Removed +## [0.2.3.1] - 2023-01-21 + +### Changed + +- Update the year in `versionString` +- Update README.md + ## [0.2.3.0] - 2023-01-21 ### Added @@ -127,7 +134,8 @@ build docs using a pre-commit hook. - Initial release. -[unreleased]: https://github.com/fpringle/hoyo/compare/v0.2.3.0...HEAD +[unreleased]: https://github.com/fpringle/hoyo/compare/v0.2.3.1...HEAD +[0.2.3.1]: https://github.com/fpringle/hoyo/compare/v0.2.3.0...v0.2.3.1 [0.2.3.0]: https://github.com/fpringle/hoyo/compare/v0.2.2.1...v0.2.3.0 [0.2.2.1]: https://github.com/fpringle/hoyo/compare/v0.2.2.0...v0.2.2.1 [0.2.2.0]: https://github.com/fpringle/hoyo/compare/v0.2.1.0...v0.2.2.0 diff --git a/README.md b/README.md index b0c0e7e..5706830 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ You can download binary directly [from GitHub releases](https://github.com/fprin After downloading binary, make it executable and copy it under convenient location, for example: -```shell +``` chmod +x hoyo-cli mv hoyo-cli ~/.local/bin/hoyo-cli ``` @@ -23,22 +23,24 @@ Download [this bash script](scripts/hoyo.sh). Add the following line to your `.bashrc`: -```bash +``` source path/to/hoyo.sh ``` # Usage -```man -hoyo [--version] COMMAND [-c|--config FILE] [-b|--bookmarks FILE] - [--fail] [--nofail] [--time] [--notime] [--enable-clear] - [--disable-clear] [--enable-reset] [--disable-reset] +``` +Set directory bookmarks for quick "cd"-like behaviour - Set directory bookmarks for quick "cd"-like behaviour +Usage: hoyo [COMMAND] [-c|--config ] [-b|--bookmarks ] [--fail] + [--nofail] [--time] [--notime] [--enable-clear] [--disable-clear] + [--enable-reset] [--disable-reset] + + For more help on a particular sub-command, run `hoyo --help`. Available options: - -c,--config FILE Override the default config file - -b,--bookmarks FILE Override the default bookmarks file + -c,--config Override the default config file + -b,--bookmarks Override the default bookmarks file --fail Fail on error --nofail Disable fail on error --time Display bookmark creation times @@ -57,13 +59,14 @@ Available commands: delete Delete a bookmark refresh Re-calculate bookmark indices config View/manage hoyo config + check Verify validity of config and bookmarks ``` ## Examples ### List the current bookmarks -```bash +``` $ hoyo list 1. /home/Documents doc 2. /home/Music/Albums @@ -71,7 +74,7 @@ $ hoyo list ### `cd` to a bookmark -```bash +``` $ hoyo move doc $ pwd /home/Documents @@ -82,7 +85,7 @@ $ pwd ### Add a new bookmark -```bash +``` $ hoyo add /home h $ hoyo list 1. /home/Documents doc @@ -95,7 +98,7 @@ $ pwd ### Delete a bookmark -```bash +``` $ hoyo delete 2 $ hoyo list 1. /home/Documents doc @@ -104,7 +107,7 @@ $ hoyo list ### Reset bookmark indices -```bash +``` $ hoyo refresh $ hoyo list 1. /home/Documents doc @@ -113,7 +116,7 @@ $ hoyo list ### View config -```bash +``` $ hoyo config print fail_on_error = false enable_clearing = true @@ -124,7 +127,7 @@ enable_reset = true ### Modify config -```bash +``` $ hoyo config set display_creation_time true $ hoyo list 1. 12/26/22 16:55:13 /home/Documents doc @@ -133,7 +136,7 @@ $ hoyo list ### Reset config -```bash +``` $ hoyo config reset $ hoyo config print fail_on_error = false @@ -145,8 +148,16 @@ enable_reset = false ### Clear all bookmarks -```bash +``` $ hoyo clear --enable-clear $ hoyo list [ no output ] ``` + +### Validate your config file + +``` +$ hoyo check +Config is good +Bookmarks file is good +``` diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 4ba1bc0..132835a 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -16,6 +16,13 @@ and this project adheres to the ### Removed +## [0.2.3.1] - 2023-01-21 + +### Changed + +- Update the year in `versionString` +- Update README.md + ## [0.2.3.0] - 2023-01-21 ### Added @@ -127,7 +134,8 @@ build docs using a pre-commit hook. - Initial release. -[unreleased]: https://github.com/fpringle/hoyo/compare/v0.2.3.0...HEAD +[unreleased]: https://github.com/fpringle/hoyo/compare/v0.2.3.1...HEAD +[0.2.3.1]: https://github.com/fpringle/hoyo/compare/v0.2.3.0...v0.2.3.1 [0.2.3.0]: https://github.com/fpringle/hoyo/compare/v0.2.2.1...v0.2.3.0 [0.2.2.1]: https://github.com/fpringle/hoyo/compare/v0.2.2.0...v0.2.2.1 [0.2.2.0]: https://github.com/fpringle/hoyo/compare/v0.2.1.0...v0.2.2.0 diff --git a/docs/HoYo-Bookmark.html b/docs/HoYo-Bookmark.html index b675918..c1186e8 100644 --- a/docs/HoYo-Bookmark.html +++ b/docs/HoYo-Bookmark.html @@ -1,4 +1,4 @@ -HoYo.Bookmark
hoyo-0.2.3.0: Bookmark directories for cd
Copyright(c) Frederick Pringle 2023
LicenseBSD-3
Maintainerfreddyjepringle@gmail.com
Safe HaskellNone
LanguageHaskell2010

HoYo.Bookmark

Description

The Bookmark type provides a representation of bookmarks saved and used +HoYo.Bookmark

hoyo-0.2.3.1: Bookmark directories for cd
Copyright(c) Frederick Pringle 2023
LicenseBSD-3
Maintainerfreddyjepringle@gmail.com
Safe HaskellNone
LanguageHaskell2010

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.

The Bookmark type

data Bookmark #

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-Command.html b/docs/HoYo-Command.html index 0ea0ab6..1692bb1 100644 --- a/docs/HoYo-Command.html +++ b/docs/HoYo-Command.html @@ -1,4 +1,4 @@ -HoYo.Command

hoyo-0.2.3.0: Bookmark directories for cd
Copyright(c) Frederick Pringle 2023
LicenseBSD-3
Maintainerfreddyjepringle@gmail.com
Safe HaskellNone
LanguageHaskell2010

HoYo.Command

Description

This module defines data-types and runner functions for the hoyo +HoYo.Command

hoyo-0.2.3.1: Bookmark directories for cd
Copyright(c) Frederick Pringle 2023
LicenseBSD-3
Maintainerfreddyjepringle@gmail.com
Safe HaskellNone
LanguageHaskell2010

HoYo.Command

Description

This module defines data-types and runner functions for the hoyo command-line program.

Synopsis

Running CLI commands

runCommand :: Command -> HoYoMonad () #

Run a Command in the hoyo environment.

modifyBookmarks :: ([Bookmark] -> [Bookmark]) -> HoYoMonad () #

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 () #

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 3553f6a..612f1a4 100644 --- a/docs/HoYo-Config.html +++ b/docs/HoYo-Config.html @@ -1,2 +1,2 @@ -HoYo.Config

hoyo-0.2.3.0: Bookmark directories for cd
Copyright(c) Frederick Pringle 2023
LicenseBSD-3
Maintainerfreddyjepringle@gmail.com
Safe HaskellNone
LanguageHaskell2010

HoYo.Config

Description

Configuration for the hoyo program. This is stored on-disk as a TOML file, +HoYo.Config

hoyo-0.2.3.1: Bookmark directories for cd
Copyright(c) Frederick Pringle 2023
LicenseBSD-3
Maintainerfreddyjepringle@gmail.com
Safe HaskellNone
LanguageHaskell2010

HoYo.Config

Description

Configuration for the hoyo program. This is stored on-disk as a TOML file, usually at ~.confighoyo/config.toml

Documentation

data Config #

A representation of hoyo settings.

Constructors

Config 

Fields

defaultConfig :: Config #

The default config for hoyo.

decodeConfig :: Text -> Either Text Config #

Decode a Config from a Text.

decodeConfigFile :: MonadIO m => TFilePath -> m (Either Text Config) #

Decode a Config from a file.

encodeConfig :: Config -> Text #

Encode a Config to a Text.

encodeConfigFile :: MonadIO m => TFilePath -> Config -> m () #

Encode a Config to a file.

setConfig :: MonadError Text m => Text -> Text -> Config -> m Config #

Try to set a key-value pair in the config.

getKeyVals :: Config -> [(Key, AnyValue)] #

Get TOML key-value pairs from a Config.

\ No newline at end of file diff --git a/docs/HoYo-Env.html b/docs/HoYo-Env.html index 7799bab..d20c9ea 100644 --- a/docs/HoYo-Env.html +++ b/docs/HoYo-Env.html @@ -1,3 +1,3 @@ -HoYo.Env
hoyo-0.2.3.0: Bookmark directories for cd
Copyright(c) Frederick Pringle 2023
LicenseBSD-3
Maintainerfreddyjepringle@gmail.com
Safe HaskellNone
LanguageHaskell2010

HoYo.Env

Description

The read-only hoyo environment.

HoYo config

data Env #

The main hoyo read-only environment. Contains the current saved bookmarks, +HoYo.Env

hoyo-0.2.3.1: Bookmark directories for cd
Copyright(c) Frederick Pringle 2023
LicenseBSD-3
Maintainerfreddyjepringle@gmail.com
Safe HaskellNone
LanguageHaskell2010

HoYo.Env

Description

The read-only hoyo environment.

HoYo config

data Env #

The main hoyo read-only environment. Contains the current saved bookmarks, the current hoyo configuration, and the file locations for each.

Constructors

Env 

Fields

Instances

Instances details
MonadReader Env HoYoMonad # 
Instance details

Defined in HoYo.Types

Methods

ask :: HoYoMonad Env #

local :: (Env -> Env) -> HoYoMonad a -> HoYoMonad a #

reader :: (Env -> a) -> HoYoMonad a #

initEnv :: MonadIO m => TFilePath -> TFilePath -> m () #

Given a filepath for the bookmarks file and a filepath for the config file, initialize the respective TOMLs at those locations.

getEnv :: MonadIO m => TFilePath -> TFilePath -> m (Either Text Env) #

Retrieve an Env from given bookmark- and config- file locations.

writeEnv :: MonadIO m => Env -> m () #

Write an Env to file.

readEnv :: MonadIO m => TFilePath -> TFilePath -> m (Either Text Env) #

Read an Env from a file.

Default file paths

defaultBookmarksPath :: IO TFilePath #

The default path for hoyo bookmarks. Usually $HOME.localsharehoyoconfig.toml

defaultConfigPath :: IO TFilePath #

The default path for the hoyo config. Usually $HOME.confighoyo/config.toml

\ No newline at end of file diff --git a/docs/HoYo.html b/docs/HoYo.html index ddddf5f..aac2087 100644 --- a/docs/HoYo.html +++ b/docs/HoYo.html @@ -1,4 +1,4 @@ -HoYo
hoyo-0.2.3.0: Bookmark directories for cd
Copyright(c) Frederick Pringle 2023
LicenseBSD-3
Maintainerfreddyjepringle@gmail.com
Safe HaskellNone
LanguageHaskell2010

HoYo

Description

hoyo is a command-line utility that lets the user save directories +HoYo

hoyo-0.2.3.1: Bookmark directories for cd
Copyright(c) Frederick Pringle 2023
LicenseBSD-3
Maintainerfreddyjepringle@gmail.com
Safe HaskellNone
LanguageHaskell2010

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

Bookmarks

data Bookmark #

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

Instances

Instances details
Show Bookmark # 
Instance details

Defined in HoYo.Types

Methods

showsPrec :: Int -> Bookmark -> ShowS #

show :: Bookmark -> String #

showList :: [Bookmark] -> ShowS #

newtype Bookmarks #

Wrapper for [Bookmark].

Constructors

Bookmarks 

Fields

Instances

Instances details
Show Bookmarks # 
Instance details

Defined in HoYo.Types

Methods

showsPrec :: Int -> Bookmarks -> ShowS #

show :: Bookmarks -> String #

showList :: [Bookmarks] -> ShowS #

searchBookmarks :: BookmarkSearchTerm -> Bookmarks -> ([Bookmark], [Bookmark]) #

searchBookmarks searchTerm bookmarks partitions bookmarks into a list of diff --git a/docs/README.md b/docs/README.md index b0c0e7e..5706830 100644 --- a/docs/README.md +++ b/docs/README.md @@ -12,7 +12,7 @@ You can download binary directly [from GitHub releases](https://github.com/fprin After downloading binary, make it executable and copy it under convenient location, for example: -```shell +``` chmod +x hoyo-cli mv hoyo-cli ~/.local/bin/hoyo-cli ``` @@ -23,22 +23,24 @@ Download [this bash script](scripts/hoyo.sh). Add the following line to your `.bashrc`: -```bash +``` source path/to/hoyo.sh ``` # Usage -```man -hoyo [--version] COMMAND [-c|--config FILE] [-b|--bookmarks FILE] - [--fail] [--nofail] [--time] [--notime] [--enable-clear] - [--disable-clear] [--enable-reset] [--disable-reset] +``` +Set directory bookmarks for quick "cd"-like behaviour - Set directory bookmarks for quick "cd"-like behaviour +Usage: hoyo [COMMAND] [-c|--config ] [-b|--bookmarks ] [--fail] + [--nofail] [--time] [--notime] [--enable-clear] [--disable-clear] + [--enable-reset] [--disable-reset] + + For more help on a particular sub-command, run `hoyo --help`. Available options: - -c,--config FILE Override the default config file - -b,--bookmarks FILE Override the default bookmarks file + -c,--config Override the default config file + -b,--bookmarks Override the default bookmarks file --fail Fail on error --nofail Disable fail on error --time Display bookmark creation times @@ -57,13 +59,14 @@ Available commands: delete Delete a bookmark refresh Re-calculate bookmark indices config View/manage hoyo config + check Verify validity of config and bookmarks ``` ## Examples ### List the current bookmarks -```bash +``` $ hoyo list 1. /home/Documents doc 2. /home/Music/Albums @@ -71,7 +74,7 @@ $ hoyo list ### `cd` to a bookmark -```bash +``` $ hoyo move doc $ pwd /home/Documents @@ -82,7 +85,7 @@ $ pwd ### Add a new bookmark -```bash +``` $ hoyo add /home h $ hoyo list 1. /home/Documents doc @@ -95,7 +98,7 @@ $ pwd ### Delete a bookmark -```bash +``` $ hoyo delete 2 $ hoyo list 1. /home/Documents doc @@ -104,7 +107,7 @@ $ hoyo list ### Reset bookmark indices -```bash +``` $ hoyo refresh $ hoyo list 1. /home/Documents doc @@ -113,7 +116,7 @@ $ hoyo list ### View config -```bash +``` $ hoyo config print fail_on_error = false enable_clearing = true @@ -124,7 +127,7 @@ enable_reset = true ### Modify config -```bash +``` $ hoyo config set display_creation_time true $ hoyo list 1. 12/26/22 16:55:13 /home/Documents doc @@ -133,7 +136,7 @@ $ hoyo list ### Reset config -```bash +``` $ hoyo config reset $ hoyo config print fail_on_error = false @@ -145,8 +148,16 @@ enable_reset = false ### Clear all bookmarks -```bash +``` $ hoyo clear --enable-clear $ hoyo list [ no output ] ``` + +### Validate your config file + +``` +$ hoyo check +Config is good +Bookmarks file is good +``` diff --git a/docs/doc-index.html b/docs/doc-index.html index 2570dfd..3d1030f 100644 --- a/docs/doc-index.html +++ b/docs/doc-index.html @@ -1 +1 @@ -hoyo-0.2.3.0: Bookmark directories for cd (Index)

hoyo-0.2.3.0: Bookmark directories for cd

Index

AddHoYo.Command, HoYo
AddDefaultBookmarkHoYo.Command, HoYo
addDefaultDirHoYo.Command, HoYo
addDefaultNameHoYo.Command, HoYo
addDirectoryHoYo.Command, HoYo
addNameHoYo.Command, HoYo
AddOptions 
1 (Type/Class)HoYo.Command, HoYo
2 (Data Constructor)HoYo.Command, HoYo
assertHoYo
assertVerboseHoYo
backupFileHoYo
Bookmark 
1 (Type/Class)HoYo.Bookmark, HoYo
2 (Data Constructor)HoYo.Bookmark, HoYo
bookmarkCodecHoYo.Bookmark, HoYo
Bookmarks 
1 (Type/Class)HoYo.Bookmark, HoYo
2 (Data Constructor)HoYo.Bookmark, HoYo
bookmarksCodecHoYo.Bookmark, HoYo
BookmarkSearchTermHoYo.Bookmark, HoYo
bookmarksFromDefaultHoYo.Bookmark, HoYo
CheckHoYo.Command, HoYo
checkBookmarksHoYo.Command, HoYo
checkConfigHoYo.Command, HoYo
CheckOptions 
1 (Type/Class)HoYo.Command, HoYo
2 (Data Constructor)HoYo.Command, HoYo
ClearHoYo.Command, HoYo
ClearOptions 
1 (Type/Class)HoYo.Command, HoYo
2 (Data Constructor)HoYo.Command, HoYo
combOverrideHoYo.Command, HoYo
CommandHoYo.Command, HoYo
Config 
1 (Type/Class)HoYo.Config, HoYo
2 (Data Constructor)HoYo.Config, HoYo
ConfigAddDefaultOptions 
1 (Type/Class)HoYo.Command, HoYo
2 (Data Constructor)HoYo.Command, HoYo
ConfigCmdHoYo.Command, HoYo
ConfigCommandHoYo.Command, HoYo
ConfigPrintOptions 
1 (Type/Class)HoYo.Command, HoYo
2 (Data Constructor)HoYo.Command, HoYo
ConfigResetOptions 
1 (Type/Class)HoYo.Command, HoYo
2 (Data Constructor)HoYo.Command, HoYo
ConfigSetOptions 
1 (Type/Class)HoYo.Command, HoYo
2 (Data Constructor)HoYo.Command, HoYo
ConflictHoYo.Command, HoYo
dataPathHoYo.Command, HoYo
decodeBookmarksHoYo.Bookmark, HoYo
decodeBookmarksFileHoYo.Bookmark, HoYo
decodeConfigHoYo.Config, HoYo
decodeConfigFileHoYo.Config, HoYo
DefaultBookmark 
1 (Type/Class)HoYo.Bookmark, HoYo
2 (Data Constructor)HoYo.Bookmark, HoYo
defaultBookmarkCodecHoYo.Bookmark, HoYo
defaultBookmarksPathHoYo.Env, HoYo
DefaultCommandHoYo.Command, HoYo
defaultConfigHoYo.Config, HoYo
defaultConfigPathHoYo.Env, HoYo
defaultGlobalOptionsHoYo.Command, HoYo
defaultOverrideOptionsHoYo.Command, HoYo
DeleteHoYo.Command, HoYo
DeleteOptions 
1 (Type/Class)HoYo.Command, HoYo
2 (Data Constructor)HoYo.Command, HoYo
deleteSearchHoYo.Command, HoYo
DoneHoYo
encodeBookmarksHoYo.Bookmark, HoYo
encodeBookmarksFileHoYo.Bookmark, HoYo
encodeConfigHoYo.Config, HoYo
encodeConfigFileHoYo.Config, HoYo
Env 
1 (Type/Class)HoYo.Env, HoYo
2 (Data Constructor)HoYo.Env, HoYo
ExecResultHoYo
filterBookmarkByDirInfixHoYo.Bookmark, HoYo
filterBookmarkByNameHoYo.Bookmark, HoYo
filterBookmarksHoYo.Bookmark, HoYo
formatBookmarkHoYo.Bookmark, HoYo
formatBookmarksHoYo.Bookmark, HoYo
getBookmarksHoYo.Bookmark, HoYo
getEnvHoYo.Env, HoYo
getEnvAndRunCommandHoYo
getEnvAndRunHoYoHoYo
getKeyValsHoYo.Config, HoYo
globalConfigPathHoYo.Command, HoYo
GlobalOptions 
1 (Type/Class)HoYo.Command, HoYo
2 (Data Constructor)HoYo.Command, HoYo
HoYoMonadHoYo
initEnvHoYo.Env, HoYo
ListHoYo.Command, HoYo
listFilterDirectoryInfixHoYo.Command, HoYo
listFilterNameHoYo.Command, HoYo
ListOptions 
1 (Type/Class)HoYo.Command, HoYo
2 (Data Constructor)HoYo.Command, HoYo
MaybeOverrideHoYo.Command, HoYo
modifyBookmarksHoYo.Command, HoYo
modifyBookmarksMHoYo.Command, HoYo
MoveHoYo.Command, HoYo
MoveOptions 
1 (Type/Class)HoYo.Command, HoYo
2 (Data Constructor)HoYo.Command, HoYo
moveSearchHoYo.Command, HoYo
NoOverrideHoYo.Command, HoYo
optCommandHoYo.Command, HoYo
optGlobalsHoYo.Command, HoYo
Options 
1 (Type/Class)HoYo.Command, HoYo
2 (Data Constructor)HoYo.Command, HoYo
overrideConfigHoYo.Command, HoYo
overrideDisplayCreationTimeHoYo.Command, HoYo
overrideEnableClearingHoYo.Command, HoYo
overrideEnableResetHoYo.Command, HoYo
overrideEnvHoYo.Command, HoYo
overrideFailOnErrorHoYo.Command, HoYo
OverrideFalseHoYo.Command, HoYo
OverrideOptions 
1 (Type/Class)HoYo.Command, HoYo
2 (Data Constructor)HoYo.Command, HoYo
overridesHoYo.Command, HoYo
OverrideTrueHoYo.Command, HoYo
PrintHoYo.Command, HoYo
printStderrHoYo
printStdoutHoYo
readBoolHoYo
readEnvHoYo.Env, HoYo
readIntHoYo
RefreshHoYo.Command, HoYo
RefreshOptions 
1 (Type/Class)HoYo.Command, HoYo
2 (Data Constructor)HoYo.Command, HoYo
ReRunHoYo
ResetHoYo.Command, HoYo
runAddHoYo.Command, HoYo
runCheckHoYo.Command, HoYo
runClearHoYo.Command, HoYo
runCommandHoYo.Command, HoYo
runConfigHoYo.Command, HoYo
runDefaultCommandHoYo.Command, HoYo
runDeleteHoYo.Command, HoYo
runHoYoHoYo
runListHoYo.Command, HoYo
runMoveHoYo.Command, HoYo
runRefreshHoYo.Command, HoYo
searchBookmarksHoYo.Bookmark, HoYo
SearchIndexHoYo.Bookmark, HoYo
SearchNameHoYo.Bookmark, HoYo
SetHoYo.Command, HoYo
setConfigHoYo.Config, HoYo
setKeyHoYo.Command, HoYo
setValueHoYo.Command, HoYo
ShowHelpHoYo
TFilePathHoYo
unBookmarksHoYo.Bookmark, HoYo
verifyOverridesHoYo.Command, HoYo
versionStringHoYo
withFilesHoYo
writeEnvHoYo.Env, HoYo
_backupBeforeClearHoYo.Config, HoYo
_bookmarkCreationTimeHoYo.Bookmark, HoYo
_bookmarkDirectoryHoYo.Bookmark, HoYo
_bookmarkIndexHoYo.Bookmark, HoYo
_bookmarkNameHoYo.Bookmark, HoYo
_bookmarksHoYo.Env, HoYo
_bookmarksPathHoYo.Env, HoYo
_configHoYo.Env, HoYo
_configPathHoYo.Env, HoYo
_defaultBookmarkDirectoryHoYo.Bookmark, HoYo
_defaultBookmarkNameHoYo.Bookmark, HoYo
_defaultBookmarksHoYo.Config, HoYo
_defaultCommandHoYo.Config, HoYo
_displayCreationTimeHoYo.Config, HoYo
_enableClearingHoYo.Config, HoYo
_enableResetHoYo.Config, HoYo
_failOnErrorHoYo.Config, HoYo
\ No newline at end of file +hoyo-0.2.3.1: Bookmark directories for cd (Index)
hoyo-0.2.3.1: Bookmark directories for cd

Index

AddHoYo.Command, HoYo
AddDefaultBookmarkHoYo.Command, HoYo
addDefaultDirHoYo.Command, HoYo
addDefaultNameHoYo.Command, HoYo
addDirectoryHoYo.Command, HoYo
addNameHoYo.Command, HoYo
AddOptions 
1 (Type/Class)HoYo.Command, HoYo
2 (Data Constructor)HoYo.Command, HoYo
assertHoYo
assertVerboseHoYo
backupFileHoYo
Bookmark 
1 (Type/Class)HoYo.Bookmark, HoYo
2 (Data Constructor)HoYo.Bookmark, HoYo
bookmarkCodecHoYo.Bookmark, HoYo
Bookmarks 
1 (Type/Class)HoYo.Bookmark, HoYo
2 (Data Constructor)HoYo.Bookmark, HoYo
bookmarksCodecHoYo.Bookmark, HoYo
BookmarkSearchTermHoYo.Bookmark, HoYo
bookmarksFromDefaultHoYo.Bookmark, HoYo
CheckHoYo.Command, HoYo
checkBookmarksHoYo.Command, HoYo
checkConfigHoYo.Command, HoYo
CheckOptions 
1 (Type/Class)HoYo.Command, HoYo
2 (Data Constructor)HoYo.Command, HoYo
ClearHoYo.Command, HoYo
ClearOptions 
1 (Type/Class)HoYo.Command, HoYo
2 (Data Constructor)HoYo.Command, HoYo
combOverrideHoYo.Command, HoYo
CommandHoYo.Command, HoYo
Config 
1 (Type/Class)HoYo.Config, HoYo
2 (Data Constructor)HoYo.Config, HoYo
ConfigAddDefaultOptions 
1 (Type/Class)HoYo.Command, HoYo
2 (Data Constructor)HoYo.Command, HoYo
ConfigCmdHoYo.Command, HoYo
ConfigCommandHoYo.Command, HoYo
ConfigPrintOptions 
1 (Type/Class)HoYo.Command, HoYo
2 (Data Constructor)HoYo.Command, HoYo
ConfigResetOptions 
1 (Type/Class)HoYo.Command, HoYo
2 (Data Constructor)HoYo.Command, HoYo
ConfigSetOptions 
1 (Type/Class)HoYo.Command, HoYo
2 (Data Constructor)HoYo.Command, HoYo
ConflictHoYo.Command, HoYo
dataPathHoYo.Command, HoYo
decodeBookmarksHoYo.Bookmark, HoYo
decodeBookmarksFileHoYo.Bookmark, HoYo
decodeConfigHoYo.Config, HoYo
decodeConfigFileHoYo.Config, HoYo
DefaultBookmark 
1 (Type/Class)HoYo.Bookmark, HoYo
2 (Data Constructor)HoYo.Bookmark, HoYo
defaultBookmarkCodecHoYo.Bookmark, HoYo
defaultBookmarksPathHoYo.Env, HoYo
DefaultCommandHoYo.Command, HoYo
defaultConfigHoYo.Config, HoYo
defaultConfigPathHoYo.Env, HoYo
defaultGlobalOptionsHoYo.Command, HoYo
defaultOverrideOptionsHoYo.Command, HoYo
DeleteHoYo.Command, HoYo
DeleteOptions 
1 (Type/Class)HoYo.Command, HoYo
2 (Data Constructor)HoYo.Command, HoYo
deleteSearchHoYo.Command, HoYo
DoneHoYo
encodeBookmarksHoYo.Bookmark, HoYo
encodeBookmarksFileHoYo.Bookmark, HoYo
encodeConfigHoYo.Config, HoYo
encodeConfigFileHoYo.Config, HoYo
Env 
1 (Type/Class)HoYo.Env, HoYo
2 (Data Constructor)HoYo.Env, HoYo
ExecResultHoYo
filterBookmarkByDirInfixHoYo.Bookmark, HoYo
filterBookmarkByNameHoYo.Bookmark, HoYo
filterBookmarksHoYo.Bookmark, HoYo
formatBookmarkHoYo.Bookmark, HoYo
formatBookmarksHoYo.Bookmark, HoYo
getBookmarksHoYo.Bookmark, HoYo
getEnvHoYo.Env, HoYo
getEnvAndRunCommandHoYo
getEnvAndRunHoYoHoYo
getKeyValsHoYo.Config, HoYo
globalConfigPathHoYo.Command, HoYo
GlobalOptions 
1 (Type/Class)HoYo.Command, HoYo
2 (Data Constructor)HoYo.Command, HoYo
HoYoMonadHoYo
initEnvHoYo.Env, HoYo
ListHoYo.Command, HoYo
listFilterDirectoryInfixHoYo.Command, HoYo
listFilterNameHoYo.Command, HoYo
ListOptions 
1 (Type/Class)HoYo.Command, HoYo
2 (Data Constructor)HoYo.Command, HoYo
MaybeOverrideHoYo.Command, HoYo
modifyBookmarksHoYo.Command, HoYo
modifyBookmarksMHoYo.Command, HoYo
MoveHoYo.Command, HoYo
MoveOptions 
1 (Type/Class)HoYo.Command, HoYo
2 (Data Constructor)HoYo.Command, HoYo
moveSearchHoYo.Command, HoYo
NoOverrideHoYo.Command, HoYo
optCommandHoYo.Command, HoYo
optGlobalsHoYo.Command, HoYo
Options 
1 (Type/Class)HoYo.Command, HoYo
2 (Data Constructor)HoYo.Command, HoYo
overrideConfigHoYo.Command, HoYo
overrideDisplayCreationTimeHoYo.Command, HoYo
overrideEnableClearingHoYo.Command, HoYo
overrideEnableResetHoYo.Command, HoYo
overrideEnvHoYo.Command, HoYo
overrideFailOnErrorHoYo.Command, HoYo
OverrideFalseHoYo.Command, HoYo
OverrideOptions 
1 (Type/Class)HoYo.Command, HoYo
2 (Data Constructor)HoYo.Command, HoYo
overridesHoYo.Command, HoYo
OverrideTrueHoYo.Command, HoYo
PrintHoYo.Command, HoYo
printStderrHoYo
printStdoutHoYo
readBoolHoYo
readEnvHoYo.Env, HoYo
readIntHoYo
RefreshHoYo.Command, HoYo
RefreshOptions 
1 (Type/Class)HoYo.Command, HoYo
2 (Data Constructor)HoYo.Command, HoYo
ReRunHoYo
ResetHoYo.Command, HoYo
runAddHoYo.Command, HoYo
runCheckHoYo.Command, HoYo
runClearHoYo.Command, HoYo
runCommandHoYo.Command, HoYo
runConfigHoYo.Command, HoYo
runDefaultCommandHoYo.Command, HoYo
runDeleteHoYo.Command, HoYo
runHoYoHoYo
runListHoYo.Command, HoYo
runMoveHoYo.Command, HoYo
runRefreshHoYo.Command, HoYo
searchBookmarksHoYo.Bookmark, HoYo
SearchIndexHoYo.Bookmark, HoYo
SearchNameHoYo.Bookmark, HoYo
SetHoYo.Command, HoYo
setConfigHoYo.Config, HoYo
setKeyHoYo.Command, HoYo
setValueHoYo.Command, HoYo
ShowHelpHoYo
TFilePathHoYo
unBookmarksHoYo.Bookmark, HoYo
verifyOverridesHoYo.Command, HoYo
versionStringHoYo
withFilesHoYo
writeEnvHoYo.Env, HoYo
_backupBeforeClearHoYo.Config, HoYo
_bookmarkCreationTimeHoYo.Bookmark, HoYo
_bookmarkDirectoryHoYo.Bookmark, HoYo
_bookmarkIndexHoYo.Bookmark, HoYo
_bookmarkNameHoYo.Bookmark, HoYo
_bookmarksHoYo.Env, HoYo
_bookmarksPathHoYo.Env, HoYo
_configHoYo.Env, HoYo
_configPathHoYo.Env, HoYo
_defaultBookmarkDirectoryHoYo.Bookmark, HoYo
_defaultBookmarkNameHoYo.Bookmark, HoYo
_defaultBookmarksHoYo.Config, HoYo
_defaultCommandHoYo.Config, HoYo
_displayCreationTimeHoYo.Config, HoYo
_enableClearingHoYo.Config, HoYo
_enableResetHoYo.Config, HoYo
_failOnErrorHoYo.Config, HoYo
\ No newline at end of file diff --git a/docs/hoyo.haddock b/docs/hoyo.haddock index 68bb4d4..e918949 100644 Binary files a/docs/hoyo.haddock and b/docs/hoyo.haddock differ diff --git a/docs/index.html b/docs/index.html index 4c5f8d5..19101b7 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,3 +1,3 @@ -hoyo-0.2.3.0: Bookmark directories for cd
hoyo-0.2.3.0: Bookmark directories for cd

hoyo-0.2.3.0: Bookmark directories for cd

hoyo is a command-line utility enabling easy bookmarking +hoyo-0.2.3.1: Bookmark directories for cd

hoyo-0.2.3.1: Bookmark directories for cd

hoyo-0.2.3.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.

\ No newline at end of file diff --git a/exe/Parse.hs b/exe/Parse.hs index 98fd202..bd21f44 100644 --- a/exe/Parse.hs +++ b/exe/Parse.hs @@ -191,10 +191,14 @@ versionInfo :: String versionInfo = "hoyo " <> versionString - <> "\n\nCopyright (c) 2022, Frederick Pringle\n\nAll rights reserved." + <> "\n\nCopyright (c) 2023, Frederick Pringle\n\nAll rights reserved." versionOption :: Parser (a -> a) -versionOption = infoOption versionInfo (long "version" <> hidden) +versionOption = infoOption versionInfo ( + long "version" + <> hidden + <> help "Display version information and exit" + ) options :: ParserInfo Options options = info (parseOptions <**> helper) ( diff --git a/hoyo.cabal b/hoyo.cabal index 0f0e2fc..df2f2b1 100644 --- a/hoyo.cabal +++ b/hoyo.cabal @@ -1,6 +1,6 @@ cabal-version: 3.0 name: hoyo -version: 0.2.3.0 +version: 0.2.3.1 license: BSD-3-Clause license-file: LICENSE maintainer: freddyjepringle@gmail.com @@ -25,7 +25,7 @@ source-repository head source-repository this type: git location: git://github.com/fpringle/hoyo.git - tag: v0.2.3.0 + tag: v0.2.3.1 library exposed-modules: