docs/TaskMonad-Utils.html
<!doctype html>
<html lang="en">
<head>
<!-- Required meta tags -->
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<link rel="shortcut icon" type="image/x-icon" href="images/taskmonad.ico">
<link href="css/ocean.css" rel="stylesheet" type="text/css" title="new-ocean" />
<!-- Bootstrap CSS -->
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css" integrity="sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T" crossorigin="anonymous">
<link href="css/lightbox.min.css" rel="stylesheet">
<link href="css/custom.css" rel="stylesheet">
<title>TaskMonad: xmonad + taskwarrior</title>
</head>
<body>
<a href="https://github.com/mmagorsc/taskmonad" style="position: absolute;top: 0;right: 0;border: 0;"><img width="149" height="149" src="https://github.blog/wp-content/uploads/2008/12/forkme_right_darkblue_121621.png?resize=149%2C149" class="attachment-full size-full" alt="Fork me on GitHub" data-recalc-dims="1"></a>
<div class="container" style="padding-left:66px;padding-right:110px;padding-top:30px;">
<div class="row">
<div class="col-sm-3" style="width:100%;padding-right:40px;padding-left: 10px;padding-top:10px;">
<img src="./images/taskmonad.png" style="width:100%;margin-bottom:10px;">
<!-- Place this tag where you want the button to render. -->
<div style="margin-top:10px;margin-bottom:10px;"><a class="github-button" href="https://github.com/mmagorsc/taskmonad" data-size="large" aria-label="">Star</a>
<a class="github-button" href="https://github.com/mmagorsc/taskmonad/releases" data-icon="octicon-cloud-download" data-size="large" aria-label="">Download</a></div>
<p style="overflow-wrap: break-word; font-family: Georgia, serif; font-size: 14px; line-height: 1.5;color: #555;">
Taskmonad is a collection of tools which can be used to access
taskwarrior from xmonad.
</p>
<h3 style="font-family: Georgia, serif;color: #444;font-size: 24px;font-weight: normal;">Page Content</h3>
<ul style="list-style: none;margin: 10px 0;">
<li><a class="dotted-link" href="#">Documentation</a></li>
</ul>
<h3 style="margin-top:30px;font-family: Georgia, serif;color: #444;font-size: 24px;font-weight: normal;">Modules</h3>
<ul style="list-style: none;margin: 10px 0;">
<li><a class="dotted-link" href="index.html">TaskMonad</a></li>
<li><a style="margin-left:20px;" class="dotted-link" href="TaskMonad-Prompt.html">TaskMonad.Prompt</a></li>
<li><a style="margin-left:20px;" class="dotted-link" href="TaskMonad-GridSelect.html">TaskMonad.GridSelect</a></li>
<li><a style="margin-left:20px;" class="dotted-link" href="TaskMonad-Scratchpad.html">TaskMonad.Scratchpad</a></li>
<li><a style="margin-left:20px;" class="dotted-link" href="TaskMonad-Utils.html">TaskMonad.Utils</a></li>
<li><a class="dotted-link" href="GridSelect-Extras.html">GridSelect.Extras</a></li>
</ul>
<h3 style="margin-top:30px;font-family: Georgia, serif;color: #444;font-size: 24px;font-weight: normal;">Information</h3>
<ul style="list-style: none;margin: 10px 0;">
<li><a class="copyright-link"><strong>Copyright</strong></a></li>
<li><a style="margin-left:20px;" class="copyright-link">Max Magorsch</a></li>
<li><a style="margin-left:20px;" class="copyright-link"><max@magorsch.de></a></li>
<li><a class="copyright-link"><strong>License</strong></a></li>
<li><a style="margin-left:20px;" class="copyright-link">BSD-style</a></li>
<li><a style="margin-left:20px;" class="copyright-link">(see License)</a></li>
<li><a class="copyright-link"><strong>Maintainer</strong></a></li>
<li><a style="margin-left:20px;" class="copyright-link">Max Magorsch</a></li>
<li><a style="margin-left:20px;" class="copyright-link"><max@magorsch.de></a></li>
</ul>
</div>
<div class="col-sm-9">
<h1>TaskMonad.Utils</h1>
<p style="font-family: Georgia, serif; font-size: 17px;margin-top:17px;">Release v1.0.1 (<a class="reference internal" href="src/TaskMonad.Utils.html"><span class=" std std-ref">Source</span></a>)</p>
<a href="https://www.haskell.org/ghc/" ><img src="https://img.shields.io/badge/ghc-8.4.1%2B-blue.svg"></a>
<a href="https://travis-ci.org/mmagorsc/taskmonad"> <img src="https://api.travis-ci.org/mmagorsc/taskmonad.svg?branch=master"></a>
<a href="http://hackage.haskell.org/package/TaskMonad-1.0.1"> <img src="https://img.shields.io/badge/hackage-1.0.1-brightgreen.svg"></a>
<a href="https://codeclimate.com/github/mmagorsc/taskmonad"> <img src="https://api.codeclimate.com/v1/badges/e4de6996bf5bb710d0e7/maintainability"></a>
<a href="https://opensource.org/licenses/BSD-3-Clause"><img src="https://img.shields.io/badge/license-BSD-blue.svg"></a>
<p style="margin-top:30px; margin-bottom:17px; font-family: Georgia, serif;font-size: 17px;color: #3E4349;"><b>TaskMonad.Utils</b> bundles a number of help functions that can be used to interact with the taskwarrior command line application. </p>
<div id="content"><div id="synopsis"><details id="syn"><summary>Synopsis</summary><ul class="details-toggle" data-details-id="syn"><li class="src short"><a href="#v:getTaskwarriorTaskList">getTaskwarriorTaskList</a> :: String -> [String] -> IO [[String]]</li><li class="src short"><a href="#v:getTaskwarriorIds">getTaskwarriorIds</a> :: String -> String -> IO [String]</li><li class="src short"><a href="#v:isTWReport">isTWReport</a> :: String -> Bool</li><li class="src short"><a href="#v:defaulttwreports">defaulttwreports</a> :: [String]</li><li class="src short"><a href="#v:execCommand">execCommand</a> :: MonadIO m => String -> m ()</li><li class="src short"><a href="#v:execCommandWithOutput">execCommandWithOutput</a> :: FilePath -> String -> IO String</li><li class="src short"><a href="#v:twicon">twicon</a> :: [[Bool]]</li></ul></details></div><div id="interface"><h1>Documentation</h1><div class="top"><p class="src"><a id="v:getTaskwarriorTaskList" class="def">getTaskwarriorTaskList</a> <a href="src/TaskMonad.Utils.html#getTaskwarriorTaskList" class="link">Source</a> <a href="#v:getTaskwarriorTaskList" class="selflink">#</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tbody><tr><td class="src">:: String</td><td class="doc"><p>A filter that is applied, e.g. "+INBOX" or "status:pending". Please refer to the <a href="https://taskwarrior.org/docs/filter.html">taskwarrior documentation</a> for further information.</p></td></tr><tr><td class="src">-> [String]</td><td class="doc"><p>A list of properties that should be retrieved for each task, e.g. ["id", "description", "tags"] </p></td></tr><tr><td class="src">-> IO [[String]]</td><td class="doc"><p>A filtered list of tasks that contains the specified properties of each task</p></td></tr></tbody></table></div><div class="doc"><p>Returns a filtered list of tasks that contains the specified properties of each task</p></div></div><div class="top"><p class="src"><a id="v:getTaskwarriorIds" class="def">getTaskwarriorIds</a> <a href="src/TaskMonad.Utils.html#getTaskwarriorIds" class="link">Source</a> <a href="#v:getTaskwarriorIds" class="selflink">#</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tbody><tr><td class="src">:: String</td><td class="doc"><p>A filter that is applied, e.g. "+INBOX" or "status:pending". Please refer to the <a href="https://taskwarrior.org/docs/filter.html">taskwarrior documentation</a> for further information.</p></td></tr><tr><td class="src">-> String</td><td class="doc"><p>The category of properties that should be returned, e.g. "ids" or "tags"</p></td></tr><tr><td class="src">-> IO [String]</td><td class="doc"><p>A filtered list of all properties that belong to the specified category</p></td></tr></tbody></table></div><div class="doc"><p>Returns a filtered list of all properties that belong to a given category. For example</p><pre>getTaskwarriorIds "status:pending" "tags"</pre><p>returns a list of all tags of the pending tasks. Likewise</p><pre>getTaskwarriorIds "status:pending" "ids"</pre><p>returns the ids of all pending tasks.</p></div></div><div class="top"><p class="src"><a id="v:isTWReport" class="def">isTWReport</a> :: String -> Bool <a href="src/TaskMonad.Utils.html#isTWReport" class="link">Source</a> <a href="#v:isTWReport" class="selflink">#</a></p><div class="doc"><p>Checks whether a given taskwarrior command is a report or not</p></div></div><div class="top"><p class="src"><a id="v:defaulttwreports" class="def">defaulttwreports</a> :: [String] <a href="src/TaskMonad.Utils.html#defaulttwreports" class="link">Source</a> <a href="#v:defaulttwreports" class="selflink">#</a></p><div class="doc"><p>A list containing all taskwarrior reports. For further information, please refer to <a href="https://taskwarrior.org/docs/report.html">https://taskwarrior.org/docs/report.html</a> </p></div></div><div class="top"><p class="src"><a id="v:execCommand" class="def">execCommand</a> :: MonadIO m => String -> m () <a href="src/TaskMonad.Utils.html#execCommand" class="link">Source</a> <a href="#v:execCommand" class="selflink">#</a></p><div class="doc"><p>Executes a shell command.</p></div></div><div class="top"><p class="src"><a id="v:execCommandWithOutput" class="def">execCommandWithOutput</a> :: FilePath -> String -> IO String <a href="src/TaskMonad.Utils.html#execCommandWithOutput" class="link">Source</a> <a href="#v:execCommandWithOutput" class="selflink">#</a></p><div class="doc"><p>Executes an executable with args and returns the output.</p></div></div><div class="top"><p class="src"><a id="v:twicon" class="def">twicon</a> :: [[Bool]] <a href="src/TaskMonad.Utils.html#twicon" class="link">Source</a> <a href="#v:twicon" class="selflink">#</a></p><div class="doc"><p>The Taskwarrior icon</p></div></div></div></div>
</div>
</div>
</div>
<!-- Optional JavaScript -->
<!-- jQuery first, then Popper.js, then Bootstrap JS -->
<script src="https://code.jquery.com/jquery-3.3.1.slim.min.js" integrity="sha384-q8i/X+965DzO0rT7abK41JStQIAqVgRVzpbzo5smXKp4YfRvH+8abtTE1Pi6jizo" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.7/umd/popper.min.js" integrity="sha384-UO2eT0CpHqdSJQ6hJty5KVphtPhzWj9WO1clHTMGa3JDZwrnQq4sF86dIHNDz0W1" crossorigin="anonymous"></script>
<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/js/bootstrap.min.js" integrity="sha384-JjSmVgyd0p3pXB1rRibZUAYoIIy6OrQ6VrjIEaFf/nJGzIxFDsf4x0xIM+B07jRM" crossorigin="anonymous"></script>
<!-- GitHub Buttons -->
<script async defer src="https://buttons.github.io/buttons.js"></script>
<script src="js/lightbox-plus-jquery.min.js"></script>
</body>
</html>