refactor command specs

Author: DannyBen

lib/bashly/commands/render.rb

@@ -25,7 +25,7 @@ class Render < Base
 
         The provided PATH is treated as relative TARGET.
 
-        Note that this works only if the template source defines a preview command.
+        Note that this works only if the template source supports it.
       USAGE
 
       option '-l --list', 'Show list of built-in templates'
@@ -71,10 +71,6 @@ def render
         render_source.render target, show: args['--show']
       end
 
-      def show(path)
-        render_source.show path
-      end
-
       def watch
         say "g`watching`\n"
 

lib/bashly/libraries/render/markdown/markdown.gtx

@@ -94,7 +94,7 @@ if commands.any?
     > ## {{ group.gsub(/:$/, '') }}
     >
     commands.each do |subcommand|
-      > - [{{ subcommand.name }}]({{ subcommand.full_name }}) - {{ subcommand.summary.for_markdown }}
+      > - [{{ subcommand.name }}]({{ subcommand.full_name.gsub(' ', '%20') }}) - {{ subcommand.summary.for_markdown }}
     end
     >
   end

lib/bashly/libraries/render/markdown/render.rb

@@ -21,4 +21,3 @@
   file = "#{target}/#{show}"
   puts TTY::Markdown.parse_file(file) if File.exist?(file)
 end
-

spec/approvals/cli/render/about-markdown

@@ -1,34 +1 @@
-Render markdown
-
-Render markdown documents for your script.
-
-  Usage
-
-  # Generate all documents to the ./docs directory
-  $ bashly render :markdown docs
-  
-  Viewing the output
-
-  In order to view your markdown files, you can use
-  Madness markdown server » https://madness.dannyb.co/:
-
-  $ gem install madness
-  $ madness server docs
-  
-  Supported custom definitions
-
-  Add these definitions to your bashly.yml to render them in your
-  markdown:
-
-    Footer: x_markdown_footer
-
-    Add additional sections to your man pages. This field is expected
-    to be in markdown format.
-
-      Example
-
-      x_markdown_footer: |-
-        # ISSUE TRACKER
-      
-        Report issues at <https://github.com/lanalang/smallville>
-      
+Heading

spec/approvals/cli/render/help

@@ -1,7 +1,7 @@
 Render the bashly data structure using cutsom templates
 
 Usage:
-  bashly render SOURCE TARGET [options]
+  bashly render SOURCE TARGET [--watch --show PATH]
   bashly render SOURCE --about
   bashly render --list
   bashly render (-h|--help)
@@ -10,6 +10,13 @@ Options:
   -w --watch
     Watch bashly.yml and the templates source for changes and render on change
 
+  -s --show PATH
+    After rendering, show the result generated in PATH.
+    
+    The provided PATH is treated as relative TARGET.
+    
+    Note that this works only if the template source supports it.
+
   -l --list
     Show list of built-in templates
 
@@ -33,4 +40,5 @@ Examples:
   bashly render --list
   bashly render :markdown --about
   bashly render :markdown docs --watch
+  bashly render :markdown docs --show "cli-download.1"
   bashly render /path/to/templates ./out_path

spec/approvals/cli/render/markdown

@@ -1,10 +1,4 @@
-saved spec/tmp/index.md
-saved spec/tmp/cli download.md
-saved spec/tmp/cli upload.md
 watching
 
-saved spec/tmp/index.md
-saved spec/tmp/cli download.md
-saved spec/tmp/cli upload.md
 waiting
 

spec/approvals/cli/render/watch

@@ -1,8 +1,8 @@
 + bashly render :mandoc docs
 saved docs/download.md
 saved docs/download.1
-+ man docs/download.1
 + col -bx
++ man docs/download.1
 download(1)                   Sample application                   download(1)
 
 NAME

spec/approvals/cli/render/watch-stderr

@@ -14,7 +14,7 @@ cli COMMAND
 
 ## Commands
 
-- [download](cli download) - Download a file
-- [upload](cli upload) - Upload a file
+- [download](cli%20download) - Download a file
+- [upload](cli%20upload) - Upload a file