Stefan Saasen avatar Stefan Saasen committed f067323

Add simple build.hs script to extract the command list overview from the man pages

build.hs will:

* Extract the command name/short description from the main/git-* man pages.
* Replace the "Commands" section in the README file with a properly formatted
list of commands

Run manually:

$> runhaskell build.hs

This can be executed as part of a post-commit script to automatically update
the README file.

Comments (0)

Files changed (1)

+module Main where
+
+import System.Directory
+import Control.Monad
+import Data.List
+
+extractCommandName :: String -> String
+extractCommandName input = dropWhile (not . isPrefixOf ".SH NAME") (lines input) !! 1
+
+-- | Extract the command name and short description from
+-- the man pages
+extractCommandOverview :: FilePath -> IO [String]
+extractCommandOverview path = do
+    entries <- getDirectoryContents path
+    let files = map (\e -> path ++ "/" ++ e) $ filter (isPrefixOf "git-") entries
+    mapM (fmap extractCommandName . readFile) files
+
+replaceCommandsIn :: FilePath -> [String] -> IO String
+replaceCommandsIn path content = do
+    existing <- readFile path
+    let new = break (== separator) $ lines existing
+    let clean = unwords . filter (/= "\\-") . words
+    let format e = "* `" ++ unwords (take 2 $ words e) ++ "` -> " ++ unwords (drop 2 $ words e)
+    return $ unlines $ fst new ++ [separator, "=========", ""] ++ map (format . clean) content
+
+separator = "Commands"
+
+main = do
+    let readme = "README.md"
+    let tmp = "README2.md"
+    commandList <- extractCommandOverview "man"
+    new <- replaceCommandsIn readme commandList
+    writeFile tmp new
+    renameFile tmp readme
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.