na 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (66) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.md +8 -0
  3. data/Gemfile +2 -0
  4. data/Gemfile.lock +35 -0
  5. data/README.rdoc +6 -0
  6. data/Rakefile +31 -0
  7. data/bin/na +285 -0
  8. data/html/App.html +105 -0
  9. data/html/NA/Action.html +299 -0
  10. data/html/NA/Color.html +373 -0
  11. data/html/NA.html +100 -0
  12. data/html/README_rdoc.html +328 -0
  13. data/html/String.html +368 -0
  14. data/html/created.rid +9 -0
  15. data/html/css/fonts.css +167 -0
  16. data/html/css/rdoc.css +639 -0
  17. data/html/fonts/Lato-Light.ttf +0 -0
  18. data/html/fonts/Lato-LightItalic.ttf +0 -0
  19. data/html/fonts/Lato-Regular.ttf +0 -0
  20. data/html/fonts/Lato-RegularItalic.ttf +0 -0
  21. data/html/fonts/SourceCodePro-Bold.ttf +0 -0
  22. data/html/fonts/SourceCodePro-Regular.ttf +0 -0
  23. data/html/images/add.png +0 -0
  24. data/html/images/arrow_up.png +0 -0
  25. data/html/images/brick.png +0 -0
  26. data/html/images/brick_link.png +0 -0
  27. data/html/images/bug.png +0 -0
  28. data/html/images/bullet_black.png +0 -0
  29. data/html/images/bullet_toggle_minus.png +0 -0
  30. data/html/images/bullet_toggle_plus.png +0 -0
  31. data/html/images/date.png +0 -0
  32. data/html/images/delete.png +0 -0
  33. data/html/images/find.png +0 -0
  34. data/html/images/loadingAnimation.gif +0 -0
  35. data/html/images/macFFBgHack.png +0 -0
  36. data/html/images/package.png +0 -0
  37. data/html/images/page_green.png +0 -0
  38. data/html/images/page_white_text.png +0 -0
  39. data/html/images/page_white_width.png +0 -0
  40. data/html/images/plugin.png +0 -0
  41. data/html/images/ruby.png +0 -0
  42. data/html/images/tag_blue.png +0 -0
  43. data/html/images/tag_green.png +0 -0
  44. data/html/images/transparent.png +0 -0
  45. data/html/images/wrench.png +0 -0
  46. data/html/images/wrench_orange.png +0 -0
  47. data/html/images/zoom.png +0 -0
  48. data/html/index.html +297 -0
  49. data/html/js/darkfish.js +84 -0
  50. data/html/js/navigation.js +105 -0
  51. data/html/js/navigation.js.gz +0 -0
  52. data/html/js/search.js +110 -0
  53. data/html/js/search_index.js +1 -0
  54. data/html/js/search_index.js.gz +0 -0
  55. data/html/js/searcher.js +229 -0
  56. data/html/js/searcher.js.gz +0 -0
  57. data/html/table_of_contents.html +237 -0
  58. data/lib/na/action.rb +65 -0
  59. data/lib/na/colors.rb +335 -0
  60. data/lib/na/next_action.rb +181 -0
  61. data/lib/na/string.rb +42 -0
  62. data/lib/na/version.rb +3 -0
  63. data/lib/na.rb +11 -0
  64. data/na.gemspec +26 -0
  65. data/na.rdoc +167 -0
  66. metadata +211 -0
@@ -0,0 +1,328 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta charset="UTF-8">
6
+
7
+ <title>README - Your application title</title>
8
+
9
+ <script type="text/javascript">
10
+ var rdoc_rel_prefix = "./";
11
+ var index_rel_prefix = "./";
12
+ </script>
13
+
14
+ <script src="./js/navigation.js" defer></script>
15
+ <script src="./js/search.js" defer></script>
16
+ <script src="./js/search_index.js" defer></script>
17
+ <script src="./js/searcher.js" defer></script>
18
+ <script src="./js/darkfish.js" defer></script>
19
+
20
+ <link href="./css/fonts.css" rel="stylesheet">
21
+ <link href="./css/rdoc.css" rel="stylesheet">
22
+
23
+
24
+ <body id="top" role="document" class="file">
25
+ <nav role="navigation">
26
+ <div id="project-navigation">
27
+ <div id="home-section" role="region" title="Quick navigation" class="nav-section">
28
+ <h2>
29
+ <a href="./index.html" rel="home">Home</a>
30
+ </h2>
31
+
32
+ <div id="table-of-contents-navigation">
33
+ <a href="./table_of_contents.html#pages">Pages</a>
34
+ <a href="./table_of_contents.html#classes">Classes</a>
35
+ <a href="./table_of_contents.html#methods">Methods</a>
36
+ </div>
37
+ </div>
38
+
39
+ <div id="search-section" role="search" class="project-section initially-hidden">
40
+ <form action="#" method="get" accept-charset="utf-8">
41
+ <div id="search-field-wrapper">
42
+ <input id="search-field" role="combobox" aria-label="Search"
43
+ aria-autocomplete="list" aria-controls="search-results"
44
+ type="text" name="search" placeholder="Search" spellcheck="false"
45
+ title="Type to search, Up and Down to navigate, Enter to load">
46
+ </div>
47
+
48
+ <ul id="search-results" aria-label="Search Results"
49
+ aria-busy="false" aria-expanded="false"
50
+ aria-atomic="false" class="initially-hidden"></ul>
51
+ </form>
52
+ </div>
53
+
54
+ </div>
55
+
56
+
57
+ <div class="nav-section">
58
+ <h3>Table of Contents</h3>
59
+
60
+ <ul class="link-list" role="directory">
61
+ <li><a href="#label-na">na</a>
62
+ <li><a href="#label-na+-+Add+and+list+next+actions+for+the+current+project">na - Add and list next actions for the current project</a>
63
+ <li><a href="#label-Global+Options">Global Options</a>
64
+ <li><a href="#label-d-7C--depth+DEPTH">-d|–depth DEPTH</a>
65
+ <li><a href="#label--ext+FILE_EXTENSION">–ext FILE_EXTENSION</a>
66
+ <li><a href="#label--na_tag+TAG">–na_tag TAG</a>
67
+ <li><a href="#label-p-7C--priority+PRIORITY">-p|–priority PRIORITY</a>
68
+ <li><a href="#label-a-7C--add">-<a href="no-">a|–</a>add</a>
69
+ <li><a href="#label--help">–help</a>
70
+ <li><a href="#label-n-7C--note">-<a href="no-">n|–</a>note</a>
71
+ <li><a href="#label-r-7C--recurse">-<a href="no-">r|–</a>recurse</a>
72
+ <li><a href="#label--version">–version</a>
73
+ <li><a href="#label-Commands">Commands</a>
74
+ <li><a href="#label-Command-3A+add++TASK">Command: <code>add TASK</code></a>
75
+ <li><a href="#label-Options">Options</a>
76
+ <li><a href="#label-f-7C--file+PATH">-f|–file PATH</a>
77
+ <li><a href="#label-p-7C--priority+arg">-p|–priority arg</a>
78
+ <li><a href="#label-t-7C--tag+TAG">-t|–tag TAG</a>
79
+ <li><a href="#label-n-7C--note">-<a href="no-">n|–</a>note</a>
80
+ <li><a href="#label-Command-3A+find++PATTERN">Command: <code>find PATTERN</code></a>
81
+ <li><a href="#label-Options">Options</a>
82
+ <li><a href="#label-d-7C--depth+DEPTH">-d|–depth DEPTH</a>
83
+ <li><a href="#label-x-7C--exact">-<a href="no-">x|–</a>exact</a>
84
+ <li><a href="#label-Command-3A+help++command">Command: <code>help command</code></a>
85
+ <li><a href="#label-Options">Options</a>
86
+ <li><a href="#label-c">-c</a>
87
+ <li><a href="#label-Command-3A+initconfig+">Command: <code>initconfig </code></a>
88
+ <li><a href="#label-Options">Options</a>
89
+ <li><a href="#label---5Bno--5Dforce">–[no-]force</a>
90
+ <li><a href="#label-Command-3A+next-7Cshow+">Command: <code>next|show </code></a>
91
+ <li><a href="#label-Options">Options</a>
92
+ <li><a href="#label-d-7C--depth+DEPTH">-d|–depth DEPTH</a>
93
+ <li><a href="#label-t-7C--tag+arg">-t|–tag arg</a>
94
+ <li><a href="#label-Command-3A+tagged++TAG+-5BVALUE-5D">Command: <code>tagged TAG [VALUE]</code></a>
95
+ <li><a href="#label-Options">Options</a>
96
+ <li><a href="#label-d-7C--depth+DEPTH">-d|–depth DEPTH</a>
97
+ </ul>
98
+ </div>
99
+
100
+
101
+ <div id="project-metadata">
102
+
103
+ <div id="fileindex-section" class="nav-section">
104
+ <h3>Pages</h3>
105
+
106
+ <ul class="link-list">
107
+ <li><a href="./README_rdoc.html">README</a>
108
+ </ul>
109
+ </div>
110
+
111
+ </div>
112
+ </nav>
113
+
114
+ <main role="main" aria-label="Page README.rdoc">
115
+
116
+ <h1 id="label-na">na<span><a href="#label-na">&para;</a> <a href="#top">&uarr;</a></span></h1>
117
+
118
+ <p>A command line tool for adding and listing project todos in TaskPaper format.</p>
119
+
120
+ <h2 id="label-na+-+Add+and+list+next+actions+for+the+current+project">na - Add and list next actions for the current project<span><a href="#label-na+-+Add+and+list+next+actions+for+the+current+project">&para;</a> <a href="#top">&uarr;</a></span></h2>
121
+
122
+ <p>v1.0.0</p>
123
+
124
+ <h3 id="label-Global+Options">Global Options<span><a href="#label-Global+Options">&para;</a> <a href="#top">&uarr;</a></span></h3>
125
+
126
+ <h3 id="label-d-7C--depth+DEPTH">-d|–depth DEPTH<span><a href="#label-d-7C--depth+DEPTH">&para;</a> <a href="#top">&uarr;</a></span></h3>
127
+
128
+ <p>Recurse to depth</p>
129
+ <dl class="rdoc-list label-list"><dt>Default Value
130
+ <dd>
131
+ <p>1</p>
132
+ </dd><dt>Must Match
133
+ <dd>
134
+ <p>(?-mix:^d+$)</p>
135
+ </dd></dl>
136
+
137
+ <h3 id="label--ext+FILE_EXTENSION">–ext FILE_EXTENSION<span><a href="#label--ext+FILE_EXTENSION">&para;</a> <a href="#top">&uarr;</a></span></h3>
138
+
139
+ <p>File extension to consider a todo file</p>
140
+ <dl class="rdoc-list label-list"><dt>Default Value
141
+ <dd>
142
+ <p>taskpaper</p>
143
+ </dd></dl>
144
+
145
+ <h3 id="label--na_tag+TAG">–na_tag TAG<span><a href="#label--na_tag+TAG">&para;</a> <a href="#top">&uarr;</a></span></h3>
146
+
147
+ <p>Tag to consider a next action</p>
148
+ <dl class="rdoc-list label-list"><dt>Default Value
149
+ <dd>
150
+ <p>na</p>
151
+ </dd></dl>
152
+
153
+ <h3 id="label-p-7C--priority+PRIORITY">-p|–priority PRIORITY<span><a href="#label-p-7C--priority+PRIORITY">&para;</a> <a href="#top">&uarr;</a></span></h3>
154
+
155
+ <p>Set a priority 0-5 (deprecated, for backwards compatibility)</p>
156
+ <dl class="rdoc-list label-list"><dt>Default Value
157
+ <dd>
158
+ <p>None</p>
159
+ </dd></dl>
160
+
161
+ <h3 id="label-a-7C--add">-<a href="no-">a|–</a>add<span><a href="#label-a-7C--add">&para;</a> <a href="#top">&uarr;</a></span></h3>
162
+
163
+ <p>Add a next action (deprecated, for backwards compatibility)</p>
164
+
165
+ <h3 id="label--help">–help<span><a href="#label--help">&para;</a> <a href="#top">&uarr;</a></span></h3>
166
+
167
+ <p>Show this message</p>
168
+
169
+ <h3 id="label-n-7C--note">-<a href="no-">n|–</a>note<span><a href="#label-n-7C--note">&para;</a> <a href="#top">&uarr;</a></span></h3>
170
+
171
+ <p>Prompt for additional notes (deprecated, for backwards compatibility)</p>
172
+
173
+ <h3 id="label-r-7C--recurse">-<a href="no-">r|–</a>recurse<span><a href="#label-r-7C--recurse">&para;</a> <a href="#top">&uarr;</a></span></h3>
174
+
175
+ <p>Recurse 3 directories deep (deprecated, for backwards compatability)</p>
176
+
177
+ <h3 id="label--version">–version<span><a href="#label--version">&para;</a> <a href="#top">&uarr;</a></span></h3>
178
+
179
+ <p>Display the program version</p>
180
+
181
+ <h3 id="label-Commands">Commands<span><a href="#label-Commands">&para;</a> <a href="#top">&uarr;</a></span></h3>
182
+
183
+ <h4 id="label-Command-3A+add++TASK">Command: <code>add TASK</code><span><a href="#label-Command-3A+add++TASK">&para;</a> <a href="#top">&uarr;</a></span></h4>
184
+
185
+ <p>Add a new next action</p>
186
+
187
+ <h5 id="label-Options">Options<span><a href="#label-Options">&para;</a> <a href="#top">&uarr;</a></span></h5>
188
+
189
+ <h5 id="label-f-7C--file+PATH">-f|–file PATH<span><a href="#label-f-7C--file+PATH">&para;</a> <a href="#top">&uarr;</a></span></h5>
190
+
191
+ <p>Specify the file to which the task should be added</p>
192
+ <dl class="rdoc-list label-list"><dt>Default Value
193
+ <dd>
194
+ <p>None</p>
195
+ </dd></dl>
196
+
197
+ <h5 id="label-p-7C--priority+arg">-p|–priority arg<span><a href="#label-p-7C--priority+arg">&para;</a> <a href="#top">&uarr;</a></span></h5>
198
+
199
+ <p>Add a priority level 1-5</p>
200
+ <dl class="rdoc-list label-list"><dt>Default Value
201
+ <dd>
202
+ <p>0</p>
203
+ </dd><dt>Must Match
204
+ <dd>
205
+ <p>(?-<a href="1-5">mix:</a>)</p>
206
+ </dd></dl>
207
+
208
+ <h5 id="label-t-7C--tag+TAG">-t|–tag TAG<span><a href="#label-t-7C--tag+TAG">&para;</a> <a href="#top">&uarr;</a></span></h5>
209
+
210
+ <p>Use a tag other than the default next action tag</p>
211
+ <dl class="rdoc-list label-list"><dt>Default Value
212
+ <dd>
213
+ <p>None</p>
214
+ </dd></dl>
215
+
216
+ <h5 id="label-n-7C--note">-<a href="no-">n|–</a>note<span><a href="#label-n-7C--note">&para;</a> <a href="#top">&uarr;</a></span></h5>
217
+
218
+ <p>Prompt for additional notes</p>
219
+
220
+ <h4 id="label-Command-3A+find++PATTERN">Command: <code>find PATTERN</code><span><a href="#label-Command-3A+find++PATTERN">&para;</a> <a href="#top">&uarr;</a></span></h4>
221
+
222
+ <p>Find actions matching a search pattern</p>
223
+
224
+ <p>Search tokens are separated by spaces. Actions matching any token in the pattern will be shown</p>
225
+
226
+ <pre>(partial matches allowed). Add a + before a token to make it required, e.g. `na find +feature +maybe`</pre>
227
+
228
+ <h5 id="label-Options">Options<span><a href="#label-Options">&para;</a> <a href="#top">&uarr;</a></span></h5>
229
+
230
+ <h5 id="label-d-7C--depth+DEPTH">-d|–depth DEPTH<span><a href="#label-d-7C--depth+DEPTH">&para;</a> <a href="#top">&uarr;</a></span></h5>
231
+
232
+ <p>Recurse to depth</p>
233
+ <dl class="rdoc-list label-list"><dt>Default Value
234
+ <dd>
235
+ <p>1</p>
236
+ </dd><dt>Must Match
237
+ <dd>
238
+ <p>(?-mix:^d+$)</p>
239
+ </dd></dl>
240
+
241
+ <h5 id="label-x-7C--exact">-<a href="no-">x|–</a>exact<span><a href="#label-x-7C--exact">&para;</a> <a href="#top">&uarr;</a></span></h5>
242
+
243
+ <p>Match pattern exactly</p>
244
+
245
+ <h4 id="label-Command-3A+help++command">Command: <code>help command</code><span><a href="#label-Command-3A+help++command">&para;</a> <a href="#top">&uarr;</a></span></h4>
246
+
247
+ <p>Shows a list of commands or help for one command</p>
248
+
249
+ <p>Gets help for the application or its commands. Can also list the commands in a way helpful to creating a bash-style completion function</p>
250
+
251
+ <h5 id="label-Options">Options<span><a href="#label-Options">&para;</a> <a href="#top">&uarr;</a></span></h5>
252
+
253
+ <h5 id="label-c">-c<span><a href="#label-c">&para;</a> <a href="#top">&uarr;</a></span></h5>
254
+
255
+ <p>List commands one per line, to assist with shell completion</p>
256
+
257
+ <h4 id="label-Command-3A+initconfig+">Command: <code>initconfig </code><span><a href="#label-Command-3A+initconfig+">&para;</a> <a href="#top">&uarr;</a></span></h4>
258
+
259
+ <p>Initialize the config file using current global options</p>
260
+
261
+ <p>Initializes a configuration file where you can set default options for command line flags, both globally and on a per-command basis. These defaults override the built-in defaults and allow you to omit commonly-used command line flags when invoking this program</p>
262
+
263
+ <h5 id="label-Options">Options<span><a href="#label-Options">&para;</a> <a href="#top">&uarr;</a></span></h5>
264
+
265
+ <h5 id="label---5Bno--5Dforce">–[no-]force<span><a href="#label---5Bno--5Dforce">&para;</a> <a href="#top">&uarr;</a></span></h5>
266
+
267
+ <p>force overwrite of existing config file</p>
268
+
269
+ <h4 id="label-Command-3A+next-7Cshow+">Command: <code>next|show </code><span><a href="#label-Command-3A+next-7Cshow+">&para;</a> <a href="#top">&uarr;</a></span></h4>
270
+
271
+ <p>Show next actions</p>
272
+
273
+ <h5 id="label-Options">Options<span><a href="#label-Options">&para;</a> <a href="#top">&uarr;</a></span></h5>
274
+
275
+ <h5 id="label-d-7C--depth+DEPTH">-d|–depth DEPTH<span><a href="#label-d-7C--depth+DEPTH">&para;</a> <a href="#top">&uarr;</a></span></h5>
276
+
277
+ <p>Recurse to depth</p>
278
+ <dl class="rdoc-list label-list"><dt>Default Value
279
+ <dd>
280
+ <p>None</p>
281
+ </dd><dt>Must Match
282
+ <dd>
283
+ <p>(?-mix:^d+$)</p>
284
+ </dd></dl>
285
+
286
+ <h5 id="label-t-7C--tag+arg">-t|–tag arg<span><a href="#label-t-7C--tag+arg">&para;</a> <a href="#top">&uarr;</a></span></h5>
287
+
288
+ <p>Alternate tag to search for</p>
289
+ <dl class="rdoc-list label-list"><dt>Default Value
290
+ <dd>
291
+ <p>na</p>
292
+ </dd></dl>
293
+
294
+ <h4 id="label-Command-3A+tagged++TAG+-5BVALUE-5D">Command: <code>tagged TAG [VALUE]</code><span><a href="#label-Command-3A+tagged++TAG+-5BVALUE-5D">&para;</a> <a href="#top">&uarr;</a></span></h4>
295
+
296
+ <p>Find actions matching a tag</p>
297
+
298
+ <p>Finds actions with tags matching the arguments. An action is shown if it</p>
299
+
300
+ <pre>contains any of the tags listed. Add a + before a tag to make it required,
301
+ e.g. `na tagged feature +maybe`</pre>
302
+
303
+ <h5 id="label-Options">Options<span><a href="#label-Options">&para;</a> <a href="#top">&uarr;</a></span></h5>
304
+
305
+ <h5 id="label-d-7C--depth+DEPTH">-d|–depth DEPTH<span><a href="#label-d-7C--depth+DEPTH">&para;</a> <a href="#top">&uarr;</a></span></h5>
306
+
307
+ <p>Recurse to depth</p>
308
+ <dl class="rdoc-list label-list"><dt>Default Value
309
+ <dd>
310
+ <p>1</p>
311
+ </dd><dt>Must Match
312
+ <dd>
313
+ <p>(?-mix:^d+$)</p>
314
+ </dd><dt>Default Command
315
+ <dd>
316
+ <p>next</p>
317
+ </dd></dl>
318
+
319
+ </main>
320
+
321
+
322
+
323
+ <footer id="validator-badges" role="contentinfo">
324
+ <p><a href="https://validator.w3.org/check/referer">Validate</a>
325
+ <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.3.
326
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
327
+ </footer>
328
+