Update documentation, bump version

psibi · psibi · commit ec0f0298ceeb · 2019-10-20T18:11:01.000+05:30
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,7 +2,7 @@
 
 * Make it obey --platform option
 * Add -u as an alias for --update
-
+* Make parsing more robust
 
 # 0.5.1
 
@@ -12,7 +12,7 @@
 
 * Obey XdgData for storing the files.
 * Also search pages from sunos directory now.
-* Support subcommansds ie. tldr git submodule will now work.
+* Support subcommands ie. tldr git submodule will now work.
 
 # 0.4.0.2
 
diff --git a/README.md b/README.md
@@ -19,16 +19,35 @@ Haskell client for tldr
 $ tldr --help
 tldr - Simplified and community-driven man pages
 
-Usage: tldr [-v|--version] [--update] COMMAND
+Usage: tldr [-v|--version] ((-u|--update) | [-p|--platform PLATFORM] COMMAND)
   tldr Client program
 
 Available options:
   -h,--help                Show this help text
   -v,--version             Show version
-  --update                 Update tldr pages
+  -u,--update              Update offline cache of tldr pages
+  -p,--platform PLATFORM   Prioritize specfic platform while searching. Valid
+                           values include linux, osx, windows, sunos
   COMMAND                  name of the command
 ```
 
+Or a much better example of the usage:
+
+``` shellsession
+$ tldr tldr
+tldr
+Simplified man pages.More information: https://tldr.sh.
+
+ - Get typical usages of a command (hint: this is how you got here!):
+   tldr {{command}}
+
+ - Show the tar tldr page for linux:
+   tldr -p {{linux}} {{tar}}
+
+ - Get help for a git subcommand:
+   tldr {{git checkout}}
+```
+
 ## Snapshot
 
 ![tldr](https://cloud.githubusercontent.com/assets/737477/24076451/2a5a604c-0c57-11e7-9bf7-13d76e8e7f12.png)
diff --git a/app/Main.hs b/app/Main.hs
@@ -1,5 +1,6 @@
 {-# LANGUAGE ScopedTypeVariables #-}
 {-# LANGUAGE RecordWildCards #-}
+{-# LANGUAGE BangPatterns #-}
 
 module Main
   ( main
@@ -8,6 +9,7 @@ module Main
 import Control.Monad
 import Data.List (intercalate)
 import Data.Semigroup ((<>))
+import qualified Data.Set as Set
 import Data.Version (showVersion)
 import GHC.IO.Handle.FD (stdout)
 import Options.Applicative
@@ -39,7 +41,10 @@ programOptions :: Parser TldrOpts
 programOptions = (TldrOpts <$> (updateIndexCommand <|> viewPageCommand))
 
 updateIndexCommand :: Parser TldrCommand
-updateIndexCommand = flag' UpdateIndex (long "update" <> short 'u')
+updateIndexCommand =
+  flag'
+    UpdateIndex
+    (long "update" <> short 'u' <> help "Update offline cache of tldr pages")
 
 viewOptionsParser :: Parser ViewOptions
 viewOptionsParser = ViewOptions <$> platformFlag
@@ -51,7 +56,15 @@ viewPageCommand =
 
 platformFlag :: Parser (Maybe String)
 platformFlag =
-  optional (strOption (long "platform" <> short 'p' <> metavar "PLATFORM"))
+  optional
+    (strOption
+       (long "platform" <> short 'p' <> metavar "PLATFORM" <>
+        help
+          ("Prioritize specfic platform while searching. Valid values include " <>
+           platformHelpValue)))
+  where
+    platformHelpValue :: String
+    platformHelpValue = intercalate ", " platformDirs
 
 tldrDirName :: String
 tldrDirName = "tldr"
@@ -60,7 +73,10 @@ repoHttpsUrl :: String
 repoHttpsUrl = "https://github.com/tldr-pages/tldr.git"
 
 checkDirs :: [String]
-checkDirs = ["common", "linux", "osx", "windows", "sunos"]
+checkDirs = "common" : platformDirs
+
+platformDirs :: [String]
+platformDirs = ["linux", "osx", "windows", "sunos"]
 
 tldrInitialized :: IO Bool
 tldrInitialized = do
@@ -120,7 +136,16 @@ getCheckDirs :: ViewOptions -> [String]
 getCheckDirs voptions =
   case platformOption voptions of
     Nothing -> checkDirs
-    Just platform -> ["common", platform]
+    Just platform -> nubOrd $ ["common", platform] <> checkDirs
+
+-- | Strip out duplicates
+nubOrd :: Ord a => [a] -> [a]
+nubOrd = loop mempty
+  where
+    loop _ [] = []
+    loop !s (a:as)
+      | a `Set.member` s = loop s as
+      | otherwise = a : loop (Set.insert a s) as
 
 handleTldrOpts :: TldrOpts -> IO ()
 handleTldrOpts TldrOpts {..} = do
diff --git a/tldr.cabal b/tldr.cabal
@@ -1,8 +1,8 @@
 name:                tldr
-version:             0.5.1
+version:             0.6.0
 synopsis:            Haskell tldr client
 description:         Haskell tldr client with support for viewing tldr pages. Has offline
-                     cache for accessing pages.
+                     cache for accessing pages. Visit https://tldr.sh for more details.
 homepage:            https://github.com/psibi/tldr-hs#readme
 license:             BSD3
 license-file:        LICENSE
@@ -36,6 +36,7 @@ executable tldr
                      , filepath
                      , typed-process
                      , semigroups
+                     , containers
   default-language:    Haskell2010
 
 test-suite tldr-test
