Merge pull request #29 from fpringle/release-v0.2.2.0

Prepare release v0.2.2.0
fpringle · Jan 19, 2023 · 67a75a6 · 67a75a6
2 parents 30dd472 + 538a334
commit 67a75a6
Show file tree

Hide file tree

Showing 11 changed files with 31 additions and 15 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,14 +10,21 @@ and this project adheres to the
 
 ### Added
 
-- Show instance for the various command and option types. Mostly for debugging.
-
 ### Fixed
 
 ### Changed
 
 ### Removed
 
+## [0.2.2.0] - 2023-01-19
+
+### Added
+
+- Show instances for the various command and option types. Mostly for debugging.
+- Make `hoyo move` the default command. In other words, if there is an existing bookmark
+    with the nickname `docs`, then running `hoyo docs` is the equivalent to running
+    `hoyo move docs`. Likewise if the bookmark index is used.
+
 ## [0.2.1.0] - 2022-12-31
 
 ### Added
@@ -98,7 +105,8 @@ build docs using a pre-commit hook.
 
 - Initial release.
 
-[unreleased]: https://github.com/fpringle/hoyo/compare/v0.2.1.0...HEAD
+[unreleased]: https://github.com/fpringle/hoyo/compare/v0.2.2.0...HEAD
+[0.2.2.0]: https://github.com/fpringle/hoyo/compare/v0.2.1.0...v0.2.2.0
 [0.2.1.0]: https://github.com/fpringle/hoyo/compare/v0.2.0.0...v0.2.1.0
 [0.2.0.0]: https://github.com/fpringle/hoyo/compare/v0.1.1.0...v0.2.0.0
 [0.1.1.0]: https://github.com/fpringle/hoyo/compare/v0.1.0.2...v0.1.1.0

diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -10,14 +10,21 @@ and this project adheres to the
 
 ### Added
 
-- Show instance for the various command and option types. Mostly for debugging.
-
 ### Fixed
 
 ### Changed
 
 ### Removed
 
+## [0.2.2.0] - 2023-01-19
+
+### Added
+
+- Show instances for the various command and option types. Mostly for debugging.
+- Make `hoyo move` the default command. In other words, if there is an existing bookmark
+    with the nickname `docs`, then running `hoyo docs` is the equivalent to running
+    `hoyo move docs`. Likewise if the bookmark index is used.
+
 ## [0.2.1.0] - 2022-12-31
 
 ### Added
@@ -98,7 +105,8 @@ build docs using a pre-commit hook.
 
 - Initial release.
 
-[unreleased]: https://github.com/fpringle/hoyo/compare/v0.2.1.0...HEAD
+[unreleased]: https://github.com/fpringle/hoyo/compare/v0.2.2.0...HEAD
+[0.2.2.0]: https://github.com/fpringle/hoyo/compare/v0.2.1.0...v0.2.2.0
 [0.2.1.0]: https://github.com/fpringle/hoyo/compare/v0.2.0.0...v0.2.1.0
 [0.2.0.0]: https://github.com/fpringle/hoyo/compare/v0.1.1.0...v0.2.0.0
 [0.1.1.0]: https://github.com/fpringle/hoyo/compare/v0.1.0.2...v0.1.1.0

diff --git a/docs/HoYo-Bookmark.html b/docs/HoYo-Bookmark.html
@@ -1,4 +1,4 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /><title>HoYo.Bookmark</title><link href="linuwial.css" rel="stylesheet" type="text/css" title="Linuwial" /><link rel="stylesheet" type="text/css" href="quick-jump.css" /><link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css?family=PT+Sans:400,400i,700" /><script src="haddock-bundle.min.js" async="async" type="text/javascript"></script><script type="text/x-mathjax-config">MathJax.Hub.Config({ tex2jax: { processClass: "mathjax", ignoreClass: ".*" } });</script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script></head><body><div id="package-header"><span class="caption">hoyo-0.2.1.0: Bookmark directories for cd</span><ul class="links" id="page-menu"><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>None</td></tr><tr><th>Language</th><td>Haskell2010</td></tr></table><p class="caption">HoYo.Bookmark</p></div><div id="table-of-contents"><div id="contents-list"><p class="caption" onclick="window.scrollTo(0,0)">Contents</p><ul><li><a href="#g:1">The Bookmark type</a></li><li><a href="#g:2">Working with bookmarks</a><ul><li><a href="#g:3">Parsing/encoding bookmarks from/to TOML</a></li></ul></li></ul></div></div><div id="description"><p class="caption">Description</p><div class="doc"><p>The <code><a href="HoYo-Bookmark.html#t:Bookmark" title="HoYo.Bookmark">Bookmark</a></code> type provides a representation of bookmarks saved and used
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /><title>HoYo.Bookmark</title><link href="linuwial.css" rel="stylesheet" type="text/css" title="Linuwial" /><link rel="stylesheet" type="text/css" href="quick-jump.css" /><link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css?family=PT+Sans:400,400i,700" /><script src="haddock-bundle.min.js" async="async" type="text/javascript"></script><script type="text/x-mathjax-config">MathJax.Hub.Config({ tex2jax: { processClass: "mathjax", ignoreClass: ".*" } });</script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script></head><body><div id="package-header"><span class="caption">hoyo-0.2.2.0: Bookmark directories for cd</span><ul class="links" id="page-menu"><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul></div><div id="content"><div id="module-header"><table class="info"><tr><th>Safe Haskell</th><td>None</td></tr><tr><th>Language</th><td>Haskell2010</td></tr></table><p class="caption">HoYo.Bookmark</p></div><div id="table-of-contents"><div id="contents-list"><p class="caption" onclick="window.scrollTo(0,0)">Contents</p><ul><li><a href="#g:1">The Bookmark type</a></li><li><a href="#g:2">Working with bookmarks</a><ul><li><a href="#g:3">Parsing/encoding bookmarks from/to TOML</a></li></ul></li></ul></div></div><div id="description"><p class="caption">Description</p><div class="doc"><p>The <code><a href="HoYo-Bookmark.html#t:Bookmark" title="HoYo.Bookmark">Bookmark</a></code> 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.</p></div></div><div id="synopsis"><details id="syn"><summary>Synopsis</summary><ul class="details-toggle" data-details-id="syn"><li class="src short"><span class="keyword">data</span> <a href="#t:Bookmark">Bookmark</a> = <a href="#v:Bookmark">Bookmark</a> {<ul class="subs"><li><a href="#v:_bookmarkDirectory">_bookmarkDirectory</a> :: !<a href="HoYo.html#t:TFilePath" title="HoYo">TFilePath</a></li><li><a href="#v:_bookmarkIndex">_bookmarkIndex</a> :: !<a href="file:///home/freddy/.ghcup/ghc/8.10.7/share/doc/ghc-8.10.7/html/libraries/base-4.14.3.0/Data-Int.html#t:Int" title="Data.Int">Int</a></li><li><a href="#v:_bookmarkCreationTime">_bookmarkCreationTime</a> :: !<a href="file:///home/freddy/.cabal/store/ghc-8.10.7/time-1.12.2-e2043c0bbb0625a5f9be54ef422f120db1be74974db096e3031ad7b4a12b2407/share/doc/html/Data-Time-LocalTime.html#t:ZonedTime" title="Data.Time.LocalTime">ZonedTime</a></li><li><a href="#v:_bookmarkName">_bookmarkName</a> :: !(<a href="file:///home/freddy/.ghcup/ghc/8.10.7/share/doc/ghc-8.10.7/html/libraries/base-4.14.3.0/Data-Maybe.html#t:Maybe" title="Data.Maybe">Maybe</a> <a href="file:///home/freddy/.cabal/store/ghc-8.10.7/text-2.0.1-1c73111e195963a014cd7c91a64e15df44e0812b0ca9c8f628f075b48b01fae1/share/doc/html/Data-Text.html#t:Text" title="Data.Text">Text</a>)</li></ul>}</li><li class="src short"><span class="keyword">newtype</span> <a href="#t:Bookmarks">Bookmarks</a> = <a href="#v:Bookmarks">Bookmarks</a> {<ul class="subs"><li><a href="#v:unBookmarks">unBookmarks</a> :: [<a href="HoYo-Bookmark.html#t:Bookmark" title="HoYo.Bookmark">Bookmark</a>]</li></ul>}</li><li class="src short"><span class="keyword">data</span> <a href="#t:BookmarkSearchTerm">BookmarkSearchTerm</a><ul class="subs"><li>= <a href="#v:SearchIndex">SearchIndex</a> <a href="file:///home/freddy/.ghcup/ghc/8.10.7/share/doc/ghc-8.10.7/html/libraries/base-4.14.3.0/Data-Int.html#t:Int" title="Data.Int">Int</a></li><li>| <a href="#v:SearchName">SearchName</a> <a href="file:///home/freddy/.cabal/store/ghc-8.10.7/text-2.0.1-1c73111e195963a014cd7c91a64e15df44e0812b0ca9c8f628f075b48b01fae1/share/doc/html/Data-Text.html#t:Text" title="Data.Text">Text</a></li></ul></li><li class="src short"><a href="#v:formatBookmark">formatBookmark</a> :: <a href="file:///home/freddy/.ghcup/ghc/8.10.7/share/doc/ghc-8.10.7/html/libraries/base-4.14.3.0/Data-Bool.html#t:Bool" title="Data.Bool">Bool</a> -&gt; <a href="file:///home/freddy/.ghcup/ghc/8.10.7/share/doc/ghc-8.10.7/html/libraries/base-4.14.3.0/Data-Int.html#t:Int" title="Data.Int">Int</a> -&gt; <a href="HoYo-Bookmark.html#t:Bookmark" title="HoYo.Bookmark">Bookmark</a> -&gt; <a href="file:///home/freddy/.cabal/store/ghc-8.10.7/text-2.0.1-1c73111e195963a014cd7c91a64e15df44e0812b0ca9c8f628f075b48b01fae1/share/doc/html/Data-Text.html#t:Text" title="Data.Text">Text</a></li><li class="src short"><a href="#v:formatBookmarks">formatBookmarks</a> :: <a href="file:///home/freddy/.ghcup/ghc/8.10.7/share/doc/ghc-8.10.7/html/libraries/base-4.14.3.0/Data-Bool.html#t:Bool" title="Data.Bool">Bool</a> -&gt; [<a href="HoYo-Bookmark.html#t:Bookmark" title="HoYo.Bookmark">Bookmark</a>] -&gt; [<a href="file:///home/freddy/.cabal/store/ghc-8.10.7/text-2.0.1-1c73111e195963a014cd7c91a64e15df44e0812b0ca9c8f628f075b48b01fae1/share/doc/html/Data-Text.html#t:Text" title="Data.Text">Text</a>]</li><li class="src short"><span class="keyword">data</span> <a href="#t:DefaultBookmark">DefaultBookmark</a> = <a href="#v:DefaultBookmark">DefaultBookmark</a> {<ul class="subs"><li><a href="#v:_defaultBookmarkDirectory">_defaultBookmarkDirectory</a> :: !<a href="HoYo.html#t:TFilePath" title="HoYo">TFilePath</a></li><li><a href="#v:_defaultBookmarkName">_defaultBookmarkName</a> :: !(<a href="file:///home/freddy/.ghcup/ghc/8.10.7/share/doc/ghc-8.10.7/html/libraries/base-4.14.3.0/Data-Maybe.html#t:Maybe" title="Data.Maybe">Maybe</a> <a href="file:///home/freddy/.cabal/store/ghc-8.10.7/text-2.0.1-1c73111e195963a014cd7c91a64e15df44e0812b0ca9c8f628f075b48b01fae1/share/doc/html/Data-Text.html#t:Text" title="Data.Text">Text</a>)</li></ul>}</li><li class="src short"><a href="#v:getBookmarks">getBookmarks</a> :: <a href="HoYo.html#t:HoYoMonad" title="HoYo">HoYoMonad</a> <a href="HoYo-Bookmark.html#t:Bookmarks" title="HoYo.Bookmark">Bookmarks</a></li><li class="src short"><a href="#v:searchBookmarks">searchBookmarks</a> :: <a href="HoYo-Bookmark.html#t:BookmarkSearchTerm" title="HoYo.Bookmark">BookmarkSearchTerm</a> -&gt; <a href="HoYo-Bookmark.html#t:Bookmarks" title="HoYo.Bookmark">Bookmarks</a> -&gt; ([<a href="HoYo-Bookmark.html#t:Bookmark" title="HoYo.Bookmark">Bookmark</a>], [<a href="HoYo-Bookmark.html#t:Bookmark" title="HoYo.Bookmark">Bookmark</a>])</li><li class="src short"><a href="#v:filterBookmarks">filterBookmarks</a> :: <a href="file:///home/freddy/.ghcup/ghc/8.10.7/share/doc/ghc-8.10.7/html/libraries/base-4.14.3.0/Data-Maybe.html#t:Maybe" title="Data.Maybe">Maybe</a> <a href="file:///home/freddy/.cabal/store/ghc-8.10.7/text-2.0.1-1c73111e195963a014cd7c91a64e15df44e0812b0ca9c8f628f075b48b01fae1/share/doc/html/Data-Text.html#t:Text" title="Data.Text">Text</a> -&gt; <a href="file:///home/freddy/.ghcup/ghc/8.10.7/share/doc/ghc-8.10.7/html/libraries/base-4.14.3.0/Data-Maybe.html#t:Maybe" title="Data.Maybe">Maybe</a> <a href="file:///home/freddy/.cabal/store/ghc-8.10.7/text-2.0.1-1c73111e195963a014cd7c91a64e15df44e0812b0ca9c8f628f075b48b01fae1/share/doc/html/Data-Text.html#t:Text" title="Data.Text">Text</a> -&gt; <a href="HoYo-Bookmark.html#t:Bookmark" title="HoYo.Bookmark">Bookmark</a> -&gt; <a href="file:///home/freddy/.ghcup/ghc/8.10.7/share/doc/ghc-8.10.7/html/libraries/base-4.14.3.0/Data-Bool.html#t:Bool" title="Data.Bool">Bool</a></li><li class="src short"><a href="#v:filterBookmarkByName">filterBookmarkByName</a> :: <a href="file:///home/freddy/.ghcup/ghc/8.10.7/share/doc/ghc-8.10.7/html/libraries/base-4.14.3.0/Data-Maybe.html#t:Maybe" title="Data.Maybe">Maybe</a> <a href="file:///home/freddy/.cabal/store/ghc-8.10.7/text-2.0.1-1c73111e195963a014cd7c91a64e15df44e0812b0ca9c8f628f075b48b01fae1/share/doc/html/Data-Text.html#t:Text" title="Data.Text">Text</a> -&gt; <a href="HoYo-Bookmark.html#t:Bookmark" title="HoYo.Bookmark">Bookmark</a> -&gt; <a href="file:///home/freddy/.ghcup/ghc/8.10.7/share/doc/ghc-8.10.7/html/libraries/base-4.14.3.0/Data-Bool.html#t:Bool" title="Data.Bool">Bool</a></li><li class="src short"><a href="#v:filterBookmarkByDirInfix">filterBookmarkByDirInfix</a> :: <a href="file:///home/freddy/.ghcup/ghc/8.10.7/share/doc/ghc-8.10.7/html/libraries/base-4.14.3.0/Data-Maybe.html#t:Maybe" title="Data.Maybe">Maybe</a> <a href="file:///home/freddy/.cabal/store/ghc-8.10.7/text-2.0.1-1c73111e195963a014cd7c91a64e15df44e0812b0ca9c8f628f075b48b01fae1/share/doc/html/Data-Text.html#t:Text" title="Data.Text">Text</a> -&gt; <a href="HoYo-Bookmark.html#t:Bookmark" title="HoYo.Bookmark">Bookmark</a> -&gt; <a href="file:///home/freddy/.ghcup/ghc/8.10.7/share/doc/ghc-8.10.7/html/libraries/base-4.14.3.0/Data-Bool.html#t:Bool" title="Data.Bool">Bool</a></li><li class="src short"><a href="#v:bookmarksFromDefault">bookmarksFromDefault</a> :: <a href="file:///home/freddy/.ghcup/ghc/8.10.7/share/doc/ghc-8.10.7/html/libraries/base-4.14.3.0/Control-Monad-IO-Class.html#t:MonadIO" title="Control.Monad.IO.Class">MonadIO</a> m =&gt; [<a href="HoYo-Bookmark.html#t:DefaultBookmark" title="HoYo.Bookmark">DefaultBookmark</a>] -&gt; m <a href="HoYo-Bookmark.html#t:Bookmarks" title="HoYo.Bookmark">Bookmarks</a></li><li class="src short"><a href="#v:bookmarkCodec">bookmarkCodec</a> :: <a href="file:///home/freddy/.cabal/store/ghc-8.10.7/tomland-1.3.3.2-22d8bfcd8b1478094c80899ffb935ba4e5ab8c64134eda1a16a19334182f2e27/share/doc/html/Toml-Codec-Types.html#t:TomlCodec" title="Toml.Codec.Types">TomlCodec</a> <a href="HoYo-Bookmark.html#t:Bookmark" title="HoYo.Bookmark">Bookmark</a></li><li class="src short"><a href="#v:bookmarksCodec">bookmarksCodec</a> :: <a href="file:///home/freddy/.cabal/store/ghc-8.10.7/tomland-1.3.3.2-22d8bfcd8b1478094c80899ffb935ba4e5ab8c64134eda1a16a19334182f2e27/share/doc/html/Toml-Codec-Types.html#t:TomlCodec" title="Toml.Codec.Types">TomlCodec</a> <a href="HoYo-Bookmark.html#t:Bookmarks" title="HoYo.Bookmark">Bookmarks</a></li><li class="src short"><a href="#v:defaultBookmarkCodec">defaultBookmarkCodec</a> :: <a href="file:///home/freddy/.cabal/store/ghc-8.10.7/tomland-1.3.3.2-22d8bfcd8b1478094c80899ffb935ba4e5ab8c64134eda1a16a19334182f2e27/share/doc/html/Toml-Codec-Types.html#t:TomlCodec" title="Toml.Codec.Types">TomlCodec</a> <a href="HoYo-Bookmark.html#t:DefaultBookmark" title="HoYo.Bookmark">DefaultBookmark</a></li><li class="src short"><a href="#v:decodeBookmarks">decodeBookmarks</a> :: <a href="file:///home/freddy/.cabal/store/ghc-8.10.7/text-2.0.1-1c73111e195963a014cd7c91a64e15df44e0812b0ca9c8f628f075b48b01fae1/share/doc/html/Data-Text.html#t:Text" title="Data.Text">Text</a> -&gt; <a href="file:///home/freddy/.ghcup/ghc/8.10.7/share/doc/ghc-8.10.7/html/libraries/base-4.14.3.0/Data-Either.html#t:Either" title="Data.Either">Either</a> <a href="file:///home/freddy/.cabal/store/ghc-8.10.7/text-2.0.1-1c73111e195963a014cd7c91a64e15df44e0812b0ca9c8f628f075b48b01fae1/share/doc/html/Data-Text.html#t:Text" title="Data.Text">Text</a> <a href="HoYo-Bookmark.html#t:Bookmarks" title="HoYo.Bookmark">Bookmarks</a></li><li class="src short"><a href="#v:decodeBookmarksFile">decodeBookmarksFile</a> :: <a href="file:///home/freddy/.ghcup/ghc/8.10.7/share/doc/ghc-8.10.7/html/libraries/base-4.14.3.0/Control-Monad-IO-Class.html#t:MonadIO" title="Control.Monad.IO.Class">MonadIO</a> m =&gt; <a href="HoYo.html#t:TFilePath" title="HoYo">TFilePath</a> -&gt; m (<a href="file:///home/freddy/.ghcup/ghc/8.10.7/share/doc/ghc-8.10.7/html/libraries/base-4.14.3.0/Data-Either.html#t:Either" title="Data.Either">Either</a> <a href="file:///home/freddy/.cabal/store/ghc-8.10.7/text-2.0.1-1c73111e195963a014cd7c91a64e15df44e0812b0ca9c8f628f075b48b01fae1/share/doc/html/Data-Text.html#t:Text" title="Data.Text">Text</a> <a href="HoYo-Bookmark.html#t:Bookmarks" title="HoYo.Bookmark">Bookmarks</a>)</li><li class="src short"><a href="#v:encodeBookmarks">encodeBookmarks</a> :: <a href="HoYo-Bookmark.html#t:Bookmarks" title="HoYo.Bookmark">Bookmarks</a> -&gt; <a href="file:///home/freddy/.cabal/store/ghc-8.10.7/text-2.0.1-1c73111e195963a014cd7c91a64e15df44e0812b0ca9c8f628f075b48b01fae1/share/doc/html/Data-Text.html#t:Text" title="Data.Text">Text</a></li><li class="src short"><a href="#v:encodeBookmarksFile">encodeBookmarksFile</a> :: <a href="file:///home/freddy/.ghcup/ghc/8.10.7/share/doc/ghc-8.10.7/html/libraries/base-4.14.3.0/Control-Monad-IO-Class.html#t:MonadIO" title="Control.Monad.IO.Class">MonadIO</a> m =&gt; <a href="HoYo.html#t:TFilePath" title="HoYo">TFilePath</a> -&gt; <a href="HoYo-Bookmark.html#t:Bookmarks" title="HoYo.Bookmark">Bookmarks</a> -&gt; m ()</li></ul></details></div><div id="interface"><a href="#g:1" id="g:1"><h1>The Bookmark type</h1></a><div class="top"><p class="src"><span class="keyword">data</span> <a id="t:Bookmark" class="def">Bookmark</a> <a href="#t:Bookmark" class="selflink">#</a></p><div class="doc"><p>Bookmark a directory for easy <code>cd</code>. A bookmark remembers the directory,
  the index, the creation time, and optionally a user-specified nickname