howzit 2.0.7 → 2.0.10

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 8ad8cdc085654826428d432429473e7b12375288058f3c0ce993f94937441485
4
- data.tar.gz: 8dfda4d862d35559b0cd9a1e89c4a69597aa16ef9dba5dac29eff1ee61ed295a
3
+ metadata.gz: bd8307dc1bdbf51c7a78333c5880990b0bf82acb3fb2401d9e9969fe312ce125
4
+ data.tar.gz: 72ef1a744da1debcd5faf9ff9ee170eae3389b04e585cd652450eb65ba177c30
5
5
  SHA512:
6
- metadata.gz: 9ec8eea72d9177717e0ed6dcd07c35d9eb12f998dabea1347efae1dca1fc145a8c5e4b8317f1cf4805606a86209e389643c959aa60deb240ebd2808ddbe456f4
7
- data.tar.gz: a9f3e5472866af519bc053ab50ef3f6a5089ddc4334e9687cb64dd9a8e026d00a0b2bb12d1246631f209892de9bb03168cb05cbaa852d97c44734395b00b122b
6
+ metadata.gz: affa665e5f83a8b836f5fe0a3d3c8e178d6fc880bcf3cecfe13afe44e61f4392831a45ff57f1a412a6ae7878f5cd7c00cd541aea1d780eb2b61aa01247268855
7
+ data.tar.gz: 85449c9184c5927d56acbd00e4086f11a9f4ee85085bfe07c12eb3e7b27e71c00eccee203fd73bda94919dfef000ead8f99f61e275b4d73700b442e25caa38c9
data/CHANGELOG.md CHANGED
@@ -1,3 +1,35 @@
1
+ ### 2.0.10
2
+
3
+ 2022-08-05 08:17
4
+
5
+ #### IMPROVED
6
+
7
+ - Provide more helpful feedback if no content is found in build note
8
+ - Confirm whether the user wants to create a new note when one isn't found
9
+
10
+ ### 2.0.9
11
+
12
+ 2022-08-05 07:29
13
+
14
+ #### IMPROVED
15
+
16
+ - Avoid error trace on interrupt
17
+ - Better stty settings for y/n prompt
18
+ - Better coloring of default options in dialogs
19
+
20
+ #### FIXED
21
+
22
+ - Encoding issues with older ruby versions
23
+ - Globbing for build notes was picking up files that contained "build" but not at the beginning of the filename
24
+
25
+ ### 2.0.8
26
+
27
+ 2022-08-04 13:28
28
+
29
+ #### FIXED
30
+
31
+ - Bugfixes
32
+
1
33
  ### 2.0.7
2
34
 
3
35
  2022-08-04 13:04
data/README.md CHANGED
@@ -37,350 +37,9 @@ You can install `howzit` by running:
37
37
 
38
38
  gem install howzit
39
39
 
40
- ## Anatomy of a Build Notes File
40
+ ### Usage
41
41
 
42
- Howzit relies on there being a file in the current directory with a name that starts with "build" or "howzit" and an extension of `.md`, `.txt`, or `.markdown`, e.g. `buildnotes.md` or `howzit.txt`. This note contains topics such as "Build" and "Deploy" with brief notes about each topic in Markdown (or just plain text) format.
43
-
44
- > Tip: Add "buildprivate.md" to your global gitignore (`git config --get core.excludesfile`). In a project where you don't want to share your build notes, just name the file "buildprivate.md" instead of "buildnotes.md" and it will automatically be ignored.
45
-
46
- If there are files that match the "build*" pattern that should not be recognized as build notes by howzit, add them to `~/.config/howzit/ignore.yaml`. This file is a simple list of patterns that should be ignored when scanning for build note files. Use `(?:i)` at the beginning of a pattern to make it case insensitive.
47
-
48
- The topics of the notes are delineated by Markdown headings, level 2 or higher, with the heading being the title of the topic. I split all of mine apart with h2s. For example, a short one from the little website I was working on yesterday:
49
-
50
- ## Build
51
-
52
- gulp js: compiles and minifies all js to dist/js/main.min.js
53
-
54
- gulp css: compass compile to dist/css/
55
-
56
- gulp watch
57
-
58
- gulp (default): [css,js]
59
-
60
- ## Deploy
61
-
62
- gulp sync: rsync /dist/ to scoffb.local
63
-
64
- ## Package management
65
-
66
- yarn
67
-
68
- ## Components
69
-
70
- - UIKit
71
-
72
- Howzit expects there to only be one header level used to split topics. Anything before the first header is ignored. If your topics use h2 (`##`), you can use a single h1 (`#`) line at the top to title the project.
73
-
74
- ### @Commands
75
-
76
- You can include commands that can be executed by howzit. Commands start at the beginning of a line anywhere in a topic. Only one topic's commands can be run at once, but all commands in the topic will be executed when howzit is run with `-r`. Commands can include any of:
77
-
78
- - `@run(COMMAND)`
79
-
80
- The command in parenthesis will be executed as is from the current directory of the shell
81
- - `@copy(TEXT)`
82
-
83
- On macOS this will copy the text within the parenthesis to the clipboard. An easy way to offer a shortcut to a longer build command while still allowing it to be edited prior to execution.
84
- - `@open(FILE|URL)`
85
-
86
- Will open the file or URL using the default application for the filetype. On macOS this uses the `open` command, on Windows it uses `start`, and on Linux it uses `xdg-open`, which may require separate installation.
87
- - `@include(TOPIC)`
88
-
89
- Includes all tasks from another topic, matching the name (partial match allowed) and returning first match.
90
- - `@before...@end`
91
-
92
- A block defined between @before and @end markers will be considered prerequisite for any task the topic can run. If one or more of these blocks exist in the topic, they will be displayed before running and a yes/no dialog will request confirmation that the prerequisites have been met. The content between these markers is still included when viewing the topic, but the tags themselves do not show up in output.
93
- - `@after...@end`
94
-
95
- A block defined between @after and @end markers will be displayed after a topic is run. Use it to remind yourself of additional tasks after automated ones have been executed. The content between these markers is still included when viewing the topic, but the tags themselves do not show up in output.
96
-
97
- ### Adding Titles
98
-
99
- When displaying a topic, howzit can display a title instead of the contents of a directive. Any text after the closing parenthesis will be considered the task title.
100
-
101
- ```
102
- @run(~/scripts/deploy.sh) Deploy script
103
- ```
104
-
105
- When the topic is displayed, it will now show "Run Deploy script" instead of the path to the script. This can be overridden with the `--show-code` flag, which will instead show the contents of the directive.
106
-
107
- For adding titles to run blocks (fenced code), see below.
108
-
109
- ### Run blocks (embedded scripts)
110
-
111
- For longer scripts you can write shell scripts and then call them with `@run(myscript.sh)`. For those in-between cases where you need a few commands but aren't motivated to create a separate file, you can use fenced code blocks with `run` as the language.
112
-
113
- ```run OPTIONAL TITLE
114
- #!/bin/bash
115
- # Commands...
116
- ```
117
-
118
- The contents of the block will be written to a temporary file and executed with `/bin/sh -c`. This means that you need a hashbang at the beginning to tell the shell how to interpret the script. If no hashbang is given, the script will be executed as a `sh` script.
119
-
120
- Example:
121
-
122
- ```run Just Testing
123
- #!/bin/bash
124
- echo "Just needed a few lines"
125
- echo "To get through all these commands"
126
- echo "Almost there!"
127
- say "Phew, we did it."
128
- ```
129
-
130
- Multiple blocks can be included in a topic. @commands take priority over code blocks and will be run first if they exist in the same topic.
131
-
132
- ### Requiring Confirmation
133
-
134
- You can have howzit confirm whether to execute an @command at runtime by including a question mark to the directive, e.g. `@run?(...)`. This will present a yes/no dialog before running the directive, with a default response of "yes" if you just hit return. To make the default response "no," add an exclamation point, e.g. `@run?!(...)`.
135
-
136
- This works for any directive, including `@include`, and run blocks, which can use `run?` as the language specifier.
137
-
138
- ### Variables
139
-
140
- When running commands in a topic, you can use a double dash (`--`) in the command line (surrounded by spaces) and anything after it will be interpreted as shell arguments. These can be used in commands with `$` placeholders. `$1` represents the first argument, counting up from there. Use `$@` to pass all arguments as a shell-escaped string.
141
-
142
- For example, the topic titled "Test" could contain an @run command with placeholders:
143
-
144
- ## Test
145
- @run(./myscript.sh $@)
146
-
147
- Then you would run it on the command line using:
148
-
149
- howzit -r test -- -x "arg 1" arg2
150
-
151
- This would execute the command as `./myscript.sh -x arg\ 1 arg2`.
152
-
153
- Placeholders can be used in both commands and run blocks. If a placeholder doesn't have an argument supplied, it's not replaced (e.g. leaves `$2` in the command).
154
-
155
- ### Templates and metadata
156
-
157
- You can create templates to reuse topics in multiple build note files. Create files using the same formatting as a build note in `~/.config/howzit/templates` with `.md` extensions. Name them the way you'll reference them:
158
-
159
- ~/.config/howzit/templates
160
- - markdown.md
161
- - ruby.md
162
- - obj-c.md
163
-
164
- > Use `howzit --templates` for a list of templates you've created, along with the topics they'll add when included. Just in case you make a bunch and can't remember what they're called or what they do. I was just planning ahead.
165
-
166
- You can then include the topics from a template in any build note file using a `template:` key at the top of the file.
167
-
168
- Howzit allows MultiMarkdown-style metadata at the top of a build notes file. These are key/value pairs separated by a colon:
169
-
170
- template: markdown
171
- key 1: value 1
172
- key 2: value 2
173
-
174
- The template key can include multiple template names separated by commas.
175
-
176
- Additional metadata keys populate variables you can then use inside of your templates (and build notes), using `[%key]`. You can define a default value for a placeholder with `[%key:default]`.
177
-
178
- For example, in the template `markdown.md` you could have:
179
-
180
- ### Spellcheck
181
-
182
- Check spelling of all Markdown files in git repo.
183
-
184
- ```run
185
- #!/bin/bash
186
- for dir in [%dirs:.]; do
187
- cd "$dir"
188
- /Users/ttscoff/scripts/spellcheck.bash
189
- cd -
190
- done
191
- ```
192
-
193
- Then, in a `buildnotes.md` file in your project, you could include at the top of the file:
194
-
195
- template: markdown
196
- dirs: . docs
197
-
198
- # My Project...
199
-
200
- If you only want to include certain topics from a template file, use the format `template_name[topic]` or include multiple topics separated by commas: `template_name[topic 1, topic 2]`. You can also use `*` as a wildcard, where `template_name[build*]` would include topics "Build" and "Build and Run".
201
-
202
- If a topic in the current project's build note has an identical name to a template topic, the local topic takes precedence. This allows you to include a template but modify just a part of it by duplicating the topic title.
203
-
204
- Templates can include other templates with a `template:` key at the top of the template.
205
-
206
- You can define what metadata keys are required for the template using a `required:` key at the top of the template. For example, if the template `script.md` uses a placeholder `[%executable]` that can't have a default value as it's specific to each project, you can add:
207
-
208
- required: executable
209
-
210
- at the top of `project.md`. If the template is included in a build notes file and the `executable:` key is not defined, an error will be shown.
211
-
212
- ## Using howzit
213
-
214
- Run `howzit` on its own to view the current folder's buildnotes.
215
-
216
- Include a topic name to see just that topic, or no argument to display all.
217
-
218
- howzit build
219
-
220
- You can combine multiple topic searches by separating with a comma. When multiple results are returned, the `:multiple_results:` configuration determines how they're handled.
221
-
222
- howzit build,deploy
223
-
224
- Use `-l` to list all topics.
225
-
226
- howzit -l
227
-
228
- Use `-r` to execute any @copy, @run, or @open commands in the given topic. Options can come after the topic argument, so to run the commands from the last topic you viewed, just hit the up arrow to load the previous command and add `-r`.
229
-
230
- howzit build -r
231
-
232
- Other options:
233
-
234
- Usage: howzit [OPTIONS] [TOPIC]
235
-
236
- Show build notes for the current project (buildnotes.md). Include a topic name to see just that topic, or no argument to display all.
237
-
238
- Options:
239
- -c, --create Create a skeleton build note in the current working directory
240
- -e, --edit Edit buildnotes file in current working directory
241
- using $EDITOR
242
- --grep PATTERN Display sections matching a search pattern
243
- -L, --list-completions List topics for completion
244
- -l, --list List available topics
245
- -m, --matching TYPE Topics matching type
246
- (partial, exact, fuzzy, beginswith)
247
- --multiple TYPE Multiple result handling
248
- (first, all, choose)
249
- -R, --list-runnable List topics containing @ directives (verbose)
250
- -r, --run Execute @run, @open, and/or @copy commands for given topic
251
- -s, --select Select topic from menu
252
- -T, --task-list List topics containing @ directives (completion-compatible)
253
- -t, --title Output title with build notes
254
- -q, --quiet Silence info message
255
- --verbose Show all messages
256
- -u, --[no-]upstream Traverse up parent directories for additional build notes
257
- --show-code Display the content of fenced run blocks
258
- -w, --wrap COLUMNS Wrap to specified width (default 80, 0 to disable)
259
- --edit-config Edit configuration file using default $EDITOR
260
- --title-only Output title only
261
- --templates List available templates
262
- --[no-]color Colorize output (default on)
263
- --[no-]md-highlight Highlight Markdown syntax (default on), requires mdless or mdcat
264
- --[no-]pager Paginate output (default on)
265
- -h, --help Display this screen
266
- -v, --version Display version number
267
- --default Answer all prompts with default response
268
-
269
-
270
- ## Configuration
271
-
272
- Some of the command line options can be set as defaults. The first time you run `howzit`, a YAML file is written to `~/.config/howzit/howzit.yaml`. You can open it in your default editor automatically by running `howzit --edit-config`. It contains the available options:
273
-
274
- ---
275
- :color: true
276
- :config_editor: subl
277
- :editor: subl
278
- :header_format: block
279
- :highlight: true
280
- :highlighter: mdcat
281
- :include_upstream: true
282
- :log_level: 0
283
- :matching: fuzzy
284
- :multiple_matches: choose
285
- :output_title: false
286
- :pager: auto
287
- :paginate: true
288
- :show_all_code: false
289
- :show_all_on_error: false
290
- :wrap: 0
291
-
292
- If `:color:` is false, output will not be colored, and markdown highlighting will be bypassed.
293
-
294
- If `:color:` is true and `:highlight:` is true, the `:highlighter:` option will be used to add Markdown highlighting.
295
-
296
- If `:paginate:` is true, the `:pager:` option will be used to determine the tool used for pagination. If it's false and you're using iTerm, "marks" will be added to topic titles allowing keyboard navigation.
297
-
298
- `:highlighter:` and `:pager:` can be set to `auto` (default) or a command of your choice for markdown highlighting and pagination.
299
-
300
- `:matching:` can be "partial", "beginswith", "fuzzy" or "exact" (see below).
301
-
302
- If `:include_upstream:` is true, build note files in parent directories will be included in addition to the current directory. Priority goes from current directory to root in descending order, so the current directory is top priority, and a build notes file in / is the lowest. Higher priority topics will not be overwritten by a duplicate topic from a lower priority note.
303
-
304
- Set `:log_level:` to 0 for debug messages, or 3 to suppress superfluous info messages.
305
-
306
- `:multiple_matches:` determines how howzit will handle cases where a search results in multiple matches. It can be set to "first" (first match in notes), "best" (shortest topic match), "all" (display all results), or "choose" (displays a menu of results). Default is "choose." When grepping for results, only "all" or "choose" are valid, if the default is something else, "choose" will be used. Can be overridden with the `--multiple TYPE` flag.
307
-
308
- `:header_format:` changes the way topic titles are displayed. Setting it to "border" will add a horizontal rule and brackets around the title. Setting it to "block" will mark topic titles with a unicode block instead.
309
-
310
- ### Matching
311
-
312
- All matching is case insensitive. This setting can be overridden by the `--matching TYPE` flag on the command line.
313
-
314
- - `:matching: partial`
315
-
316
- Partial is the default, search matches any part of the topic title.
317
-
318
- _Example:_ `howzit other` matches 'An<mark>other</mark> Topic'.
319
-
320
- - `:matching: beginswith`
321
-
322
- Matches from the start of the title.
323
-
324
- _Example:_ `howzit another` matches '<mark>Another</mark> Topic', but neither 'other' or 'topic' will.
325
-
326
- - `:matching: fuzzy`
327
-
328
- Matches anything containing the search characters in order, no matter what comes between them.
329
-
330
- _Example:_ `howzit asct` matches '<mark>A</mark>nother <mark>S</mark>e<mark>c</mark><mark>t</mark>ion'
331
-
332
- - `:matching: exact`
333
-
334
- Case insensitive but must match the entire title.
335
-
336
- _Example:_ Only `howzit another topic` will match 'Another Topic'
337
-
338
- ### Pager
339
-
340
- If set to `auto`, howzit will look for pagers in this order, using the first one it finds available:
341
-
342
- - $GIT_PAGER
343
- - $PAGER
344
- - bat
345
- - less
346
- - more
347
- - cat
348
- - pager
349
-
350
- If you're defining your own, make sure to include any flags necessary to handle the output. If you're using howzit's coloring, for example, you need to specify any options needed to display ANSI escape sequences (e.g. `less -r`).
351
-
352
- ### Highlighter
353
-
354
- If set to `auto` howzit will look for markdown highlighters in this order, using the first it finds available:
355
-
356
- - mdcat
357
- - mdless
358
-
359
- If you're combining a highlighter with howzit's pagination, include any flags needed to disable the highlighter's pagination (e.g. `mdless --no-pager`).
360
-
361
- ### Configuring from the Command Line
362
-
363
- You can get and set config options from the command line using `--config-get` and `--config-set`. If you run `--config-get` with no argument, it will display all config options. If you add a key (exact match required) you can get just the value for that key.
364
-
365
- Using `--config-set` requires an argument in the format `key=value`. The type of the value (boolean, integer, string, symbol) will be automatically determined and converted. To change your highlighter, for example, use `howzit --config-set highlighter=mdcat`.
366
-
367
- ## Shell Integration
368
-
369
- I personally like to alias `bld` to `howzit -r`. If you define a function in your shell, you can have it default to "build" but accept an alternate argument. There's an example for Fish included, and in Bash it would be as simple as `howzit -r ${1:build}`.
370
-
371
- For completion you can use `howzit -L` to list all topics, and `howzit -T` to list all "runnable" topics (topics containing an @directive or run block). Completion examples for Fish are included in the `fish` directory.
372
-
373
- ## Similar Projects
374
-
375
- - [mask](https://github.com/jakedeichert/mask/)
376
- - [maid](https://github.com/egoist/maid)
377
- - [saku](https://github.com/kt3k/saku)
378
-
379
- There are a few projects that tackle the same concept (a Markdown makefile). Most of them are superior task runners, so if you're looking for a `make` replacement, I recommend exploring the links above. What I like about `howzit` (and what keeps me from switching) is that it's documentation-first, and that I can display the description for each topic on the command line. The others also don't have options for listing topics or runnable tasks, so I can't use completion (or my cool script that adds available tasks to my Macbook Pro Touch Bar...). But no, I don't think `howzit` is as good an overall task runner as `mask` or `maid`.
380
-
381
- ## Roadmap
382
-
383
- - Recognize header hierarchy, allow showing/running all sub-topics
42
+ [See the wiki](https://github.com/ttscoff/howzit/wiki) for documentation.
384
43
 
385
44
  ## Author
386
45
 
@@ -401,9 +60,11 @@ purpose.
401
60
 
402
61
  ## Documentation
403
62
 
63
+ - [Howzit Wiki][Wiki].
404
64
  - [YARD documentation][RubyDoc] is hosted by RubyDoc.info.
405
65
  - [Interactive documentation][Omniref] is hosted by Omniref.
406
66
 
67
+ [Wiki]: https://github.com/ttscoff/howzit/wiki
407
68
  [RubyDoc]: http://www.rubydoc.info/gems/howzit
408
69
  [Omniref]: https://www.omniref.com/ruby/gems/howzit
409
70
 
data/bin/howzit CHANGED
@@ -18,28 +18,10 @@ OptionParser.new do |opts|
18
18
  opts.separator ''
19
19
  opts.separator 'Options:'
20
20
 
21
- opts.on('-c', '--create', 'Create a skeleton build note in the current working directory') do
22
- Howzit.buildnote.create_note
23
- Process.exit 0
24
- end
21
+ opts.separator " Behavior:\n\n" #=================================================================== BEHAVIOR
25
22
 
26
- opts.on('-e', '--edit', "Edit buildnotes file in current working directory
27
- using $EDITOR") do
28
- Howzit.buildnote.edit
29
- Process.exit 0
30
- end
31
-
32
- opts.on('--grep PATTERN', 'Display sections matching a search pattern') do |pat|
33
- Howzit.options[:grep] = pat
34
- end
35
-
36
- opts.on('-L', '--list-completions', 'List topics for completion') do
37
- Howzit.options[:list_topics] = true
38
- Howzit.options[:list_topic_titles] = true
39
- end
40
-
41
- opts.on('-l', '--list', 'List available topics') do
42
- Howzit.options[:list_topics] = true
23
+ opts.on('--default', 'Answer all prompts with default response') do
24
+ Howzit.options[:default] = true
43
25
  end
44
26
 
45
27
  opts.on('-m', '--matching TYPE', MATCHING_OPTIONS,
@@ -52,52 +34,63 @@ OptionParser.new do |opts|
52
34
  Howzit.options[:multiple_matches] = c.to_sym
53
35
  end
54
36
 
55
- opts.on('-R', '--list-runnable', 'List topics containing @ directives (verbose)') do
56
- Howzit.options[:list_runnable] = true
37
+ opts.on('-u', '--[no-]upstream', 'Traverse up parent directories for additional build notes') do |p|
38
+ Howzit.options[:include_upstream] = p
57
39
  end
58
40
 
59
- opts.on('-r', '--run', 'Execute @run, @open, and/or @copy commands for given topic') do
60
- Howzit.options[:run] = true
61
- end
41
+ opts.separator "\n Listing:\n\n" #=================================================================== LISTING
62
42
 
63
- opts.on('-s', '--select', 'Select topic from menu') do
64
- Howzit.options[:choose] = true
43
+ opts.on('-L', '--list-completions', 'List topics for completion') do
44
+ Howzit.options[:list_topics] = true
45
+ Howzit.options[:list_topic_titles] = true
65
46
  end
66
47
 
67
- opts.on('-T', '--task-list', 'List topics containing @ directives (completion-compatible)') do
68
- Howzit.options[:list_runnable] = true
69
- Howzit.options[:list_runnable_titles] = true
48
+ opts.on('-l', '--list', 'List available topics') do
49
+ Howzit.options[:list_topics] = true
70
50
  end
71
51
 
72
- opts.on('-t', '--title', 'Output title with build notes') do
73
- Howzit.options[:output_title] = true
52
+ opts.on('-R', '--list-runnable', 'List topics containing @ directives (verbose)') do
53
+ Howzit.options[:list_runnable] = true
74
54
  end
75
55
 
76
- opts.on('-q', '--quiet', 'Silence info message') do
77
- Howzit.options[:log_level] = 4
78
- Howzit.console.reset_level
56
+ opts.on('-T', '--task-list', 'List topics containing @ directives (completion-compatible)') do
57
+ Howzit.options[:list_runnable] = true
58
+ Howzit.options[:list_runnable_titles] = true
79
59
  end
80
60
 
81
- opts.on('-v', '--verbose', 'Show all messages') do
82
- Howzit.options[:log_level] = 1
83
- Howzit.console.reset_level
61
+ opts.on('--templates', 'List available templates') do
62
+ Dir.chdir(Howzit.config.template_folder)
63
+ Dir.glob('*.md').each do |file|
64
+ template = File.basename(file, '.md')
65
+ puts Howzit::Color.template("{Mk}template:{Yk}#{template}{x}")
66
+ puts Howzit::Color.template('{bk}[{bl}tasks{bk}]──────────────────────────────────────┐{x}')
67
+ metadata = file.extract_metadata
68
+ topics = Howzit.buildnote.read_file(file)
69
+ topics.each do |topic|
70
+ puts Howzit::Color.template(" {bk}│{bw}-{x} {bcK}#{template}:#{topic.title.sub(/^.*?:/, '')}{x}")
71
+ end
72
+ unless metadata.empty?
73
+ meta = []
74
+ meta << metadata['required'].split(/\s*,\s*/).map { |m| "*{bw}#{m}{xw}" } if metadata.key?('required')
75
+ meta << metadata['optional'].split(/\s*,\s*/).map(&:to_s) if metadata.key?('optional')
76
+ puts Howzit::Color.template('{bk}[{bl}meta{bk}]───────────────────────────────────────┤{x}')
77
+ puts Howzit::Color.template(" {bk}│ {xw}#{meta.join(', ')}{x}")
78
+ end
79
+ puts Howzit::Color.template(' {bk}└───────────────────────────────────────────┘{x}')
80
+ end
81
+ Process.exit 0
84
82
  end
85
83
 
86
- opts.on('-d', '--debug', 'Show debug messages (and all messages)') do
87
- Howzit.options[:log_level] = 0
88
- Howzit.console.reset_level
84
+ opts.on('--title-only', 'Output title only') do
85
+ Howzit.options[:output_title] = true
86
+ Howzit.options[:title_only] = true
89
87
  end
90
88
 
91
- opts.on('-u', '--[no-]upstream', 'Traverse up parent directories for additional build notes') do |p|
92
- Howzit.options[:include_upstream] = p
93
- end
89
+ opts.separator("\n Commands:\n\n") #=================================================================== COMMANDS
94
90
 
95
- opts.on('--show-code', 'Display the content of fenced run blocks') do
96
- Howzit.options[:show_all_code] = true
97
- end
98
-
99
- opts.on('-w', '--wrap COLUMNS', 'Wrap to specified width (default 80, 0 to disable)') do |w|
100
- Howzit.options[:wrap] = w.to_i
91
+ opts.on('-c', '--create', 'Create a skeleton build note in the current working directory') do
92
+ Howzit.buildnote.create_note
93
+ Process.exit 0
101
94
  end
102
95
 
103
96
  opts.on('--config-get [KEY]', 'Display the configuration settings or setting for a specific key') do |k|
@@ -133,49 +126,41 @@ OptionParser.new do |opts|
133
126
  Process.exit 0
134
127
  end
135
128
 
136
- opts.on('--edit-config', 'Edit configuration file using default $EDITOR') do
129
+ opts.on('--edit-config', "Edit configuration file using editor (#{Howzit.options[:editor]})") do
137
130
  Howzit.config.editor
138
131
  Process.exit 0
139
132
  end
140
133
 
141
- opts.on('--title-only', 'Output title only') do
142
- Howzit.options[:output_title] = true
143
- Howzit.options[:title_only] = true
134
+ desc = %(Edit buildnotes file in current working directory using editor (#{Howzit.options[:config_editor]}))
135
+ opts.on('-e', '--edit', desc) do
136
+ Howzit.buildnote.edit
137
+ Process.exit 0
144
138
  end
145
139
 
146
- opts.on('--templates', 'List available templates') do
147
- Dir.chdir(Howzit.config.template_folder)
148
- Dir.glob('*.md').each do |file|
149
- template = File.basename(file, '.md')
150
- puts Howzit::Color.template("{Mk}template:{Yk}#{template}{x}")
151
- puts Howzit::Color.template('{bk}[{bl}tasks{bk}]──────────────────────────────────────┐{x}')
152
- metadata = file.extract_metadata
153
- topics = Howzit.buildnote.read_file(file)
154
- topics.each do |topic|
155
- puts Howzit::Color.template(" {bk}│{bw}-{x} {bcK}#{template}:#{topic.title.sub(/^.*?:/, '')}{x}")
156
- end
157
- unless metadata.empty?
158
- meta = []
159
- meta << metadata['required'].split(/\s*,\s*/).map { |m| "*{bw}#{m}{xw}" } if metadata.key?('required')
160
- meta << metadata['optional'].split(/\s*,\s*/).map(&:to_s) if metadata.key?('optional')
161
- puts Howzit::Color.template('{bk}[{bl}meta{bk}]───────────────────────────────────────┤{x}')
162
- puts Howzit::Color.template(" {bk}│ {xw}#{meta.join(', ')}{x}")
163
- end
164
- puts Howzit::Color.template(' {bk}└───────────────────────────────────────────┘{x}')
165
- end
166
- Process.exit 0
140
+ opts.on('--grep PATTERN', 'Display sections matching a search pattern') do |pat|
141
+ Howzit.options[:grep] = pat
167
142
  end
168
143
 
169
- opts.on('--header-format TYPE', HEADER_FORMAT_OPTIONS,
170
- "Formatting style for topic titles (#{HEADER_FORMAT_OPTIONS.join(', ')})") do |t|
171
- Howzit.options[:header_format] = t
144
+ opts.on('-r', '--run', 'Execute @run, @open, and/or @copy commands for given topic') do
145
+ Howzit.options[:run] = true
146
+ end
147
+
148
+ opts.on('-s', '--select', 'Select topic from menu') do
149
+ Howzit.options[:choose] = true
172
150
  end
173
151
 
152
+ opts.separator("\n Formatting:\n\n") #=================================================================== FORMATTING
153
+
174
154
  opts.on('--[no-]color', 'Colorize output (default on)') do |c|
175
155
  Howzit.options[:color] = c
176
156
  Howzit.options[:highlight] = false unless c
177
157
  end
178
158
 
159
+ opts.on('--header-format TYPE', HEADER_FORMAT_OPTIONS,
160
+ "Formatting style for topic titles (#{HEADER_FORMAT_OPTIONS.join(', ')})") do |t|
161
+ Howzit.options[:header_format] = t
162
+ end
163
+
179
164
  opts.on('--[no-]md-highlight', 'Highlight Markdown syntax (default on), requires mdless or mdcat') do |m|
180
165
  Howzit.options[:highlight] = Howzit.options[:color] ? m : false
181
166
  end
@@ -184,6 +169,37 @@ OptionParser.new do |opts|
184
169
  Howzit.options[:paginate] = p
185
170
  end
186
171
 
172
+ opts.on('--show-code', 'Display the content of fenced run blocks') do
173
+ Howzit.options[:show_all_code] = true
174
+ end
175
+
176
+ opts.on('-t', '--title', 'Output title with build notes') do
177
+ Howzit.options[:output_title] = true
178
+ end
179
+
180
+ opts.on('-w', '--wrap COLUMNS', 'Wrap to specified width (default 80, 0 to disable)') do |w|
181
+ Howzit.options[:wrap] = w.to_i
182
+ end
183
+
184
+ opts.separator("\n Logging:\n\n") #=================================================================== LOGGING
185
+
186
+ opts.on('-d', '--debug', 'Show debug messages (and all messages)') do
187
+ Howzit.options[:log_level] = 0
188
+ Howzit.console.reset_level
189
+ end
190
+
191
+ opts.on('-q', '--quiet', 'Silence info message') do
192
+ Howzit.options[:log_level] = 4
193
+ Howzit.console.reset_level
194
+ end
195
+
196
+ opts.on('--verbose', 'Show all messages') do
197
+ Howzit.options[:log_level] = 1
198
+ Howzit.console.reset_level
199
+ end
200
+
201
+ opts.separator("\n Misc:\n\n") #=================================================================== MISC
202
+
187
203
  opts.on('-h', '--help', 'Display this screen') do
188
204
  puts opts
189
205
  Process.exit 0
@@ -193,12 +209,14 @@ OptionParser.new do |opts|
193
209
  puts "how v#{Howzit::VERSION}"
194
210
  Process.exit 0
195
211
  end
196
-
197
- opts.on('--default', 'Answer all prompts with default response') do
198
- Howzit.options[:default] = true
199
- end
200
212
  end.parse!(args)
201
213
 
214
+ trap('INT') do
215
+ puts
216
+ puts 'Cancelled'
217
+ Process.exit 0
218
+ end
219
+
202
220
  Howzit.options[:multiple_matches] = Howzit.options[:multiple_matches].to_sym
203
221
  Howzit.options[:header_format] = Howzit.options[:header_format].to_sym
204
222