bashly 1.0.8 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b82e5ead650cc1774cf3870af91b9046b1e5f69f05484d833f72dd4090eab091
-  data.tar.gz: 26626b09b79382d2d4530241b5517ed04d3e4a27c004130adadad3b27421f100
+  metadata.gz: d333139a3555fdc50cdb3ddf21119712fcada4ab837f5703f29529f346c6ad24
+  data.tar.gz: 0a40e42bfa542ed5d4f8d59792aa2a19518ae1c9098db0309f9349db391c74b2
 SHA512:
-  metadata.gz: 9e3b78d5975c92954347be94d567f28d240d628e080fb3d136382cc4f8fa1ae81827057ad3b61ac144b5ab930c3f5353128f9d6068b983d0e2e77ac996d4ab0d
-  data.tar.gz: 2595428ca74b3ada25619fc7839f99993f98bcda169b47fcda84c82b279ebcaa1882864d2d842c67f05ca1ca946f2f64867d6905892f2ff5f5f5107f32f49037
+  metadata.gz: e601e098208e0a5de186279e67c001ff58c44536f09e5cea6815722e9bef3ec3dc1b257c1b9ca2267e94977f05514916a66f03721c88c5a795cab93e8eadb20d
+  data.tar.gz: 670bcae80903cdabc5d76b5139b1c6d80b1ee3ca33af03078a340a847c4ef1385ca74ca08b2b0a274845f0be5ecfc7ecd9822575b8f8ea8cb3592b821df22760

data/README.md

@@ -71,7 +71,8 @@ Bashly is responsible for:
   - **Config file management** (INI format).
   - **YAML parsing**.
   - **Bash completions**.
-  - and more.
+  - *and more*.
+- Auto-generating **markdown and man page documentation** for your script.
 
 ## Contributing / Support
 

data/lib/bashly/cli.rb

@@ -16,6 +16,7 @@ module Bashly
       runner.route 'add',         to: Commands::Add
       runner.route 'doc',         to: Commands::Doc
       runner.route 'completions', to: Commands::Completions
+      runner.route 'render',      to: Commands::Render
       runner.route 'shell',       to: Commands::Shell unless ENV['BASHLY_SHELL']
 
       runner

data/lib/bashly/commands/render.rb

@@ -0,0 +1,103 @@
+require 'filewatcher'
+require 'tty-markdown'
+
+module Bashly
+  module Commands
+    class Render < Base
+      help 'Render the bashly data structure using cutsom templates'
+
+      usage 'bashly render SOURCE TARGET [--watch --show PATH]'
+      usage 'bashly render SOURCE --about'
+      usage 'bashly render --list'
+      usage 'bashly render (-h|--help)'
+
+      param 'SOURCE', <<~HELP
+        An ID to an internal templates source, or a path to a custom templates directory.
+
+        A leading colon (:) denotes an internal ID (see `--list`).
+      HELP
+
+      param 'TARGET', 'Output directory'
+
+      option '-w --watch', 'Watch bashly.yml and the templates source for changes and render on change'
+      option '-s --show PATH', <<~USAGE
+        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.
+      USAGE
+
+      option '-l --list', 'Show list of built-in templates'
+      option '-a --about', 'Show information about a given templates source'
+
+      example 'bashly render --list'
+      example 'bashly render :markdown --about'
+      example 'bashly render :markdown docs --watch'
+      example 'bashly render :markdown docs --show "cli-download.1"'
+      example 'bashly render /path/to/templates ./out_path'
+
+      attr_reader :watching, :target, :source
+
+      def run
+        if args['--list'] then show_list
+        elsif args['--about'] then show_about
+        else
+          start_render
+        end
+      end
+
+    private
+
+      def show_list
+        RenderSource.internal.each_value do |source|
+          say "g`:#{source.selector.to_s.ljust 10}`  #{source.summary}"
+        end
+      end
+
+      def show_about
+        puts TTY::Markdown.parse(render_source.readme)
+      end
+
+      def start_render
+        @target = args['TARGET']
+        @watching = args['--watch']
+
+        render
+        watch if watching
+      end
+
+      def render
+        render_source.render target, show: args['--show']
+      end
+
+      def watch
+        say "g`watching`\n"
+
+        Filewatcher.new(watchables).watch do
+          render
+          say "g`waiting`\n"
+        end
+      end
+
+      def render_source
+        @render_source ||= begin
+          source = RenderSource.new selector
+          raise "Invalid render source: #{args['SOURCE']}" unless source.exist?
+
+          source
+        end
+      end
+
+      def selector
+        return args['SOURCE'] unless args['SOURCE'].start_with? ':'
+
+        args['SOURCE'][1..].to_sym
+      end
+
+      def watchables
+        @watchables ||= [Settings.config_path, render_source.path]
+      end
+    end
+  end
+end

data/lib/bashly/concerns/validation_helpers.rb

@@ -40,7 +40,7 @@ module Bashly
 
       return unless keys
 
-      invalid_keys = value.keys.map(&:to_sym) - keys
+      invalid_keys = (value.keys.map(&:to_sym) - keys).reject { |k| k.start_with? 'x_' }
       assert invalid_keys.empty?, "#{key} contains invalid options: #{invalid_keys.join ', '}"
     end
 

data/lib/bashly/config.rb

@@ -1,5 +1,3 @@
-require 'yaml'
-
 module Bashly
   # A convenience class to use either a hash or a filename as a configuration
   # source.

data/lib/bashly/extensions/string.rb

@@ -1,6 +1,18 @@
 class String
   def sanitize_for_print
-    gsub("\n", '\\n').gsub('"', '\"')
+    gsub("\n", '\\n').gsub('"', '\"').gsub('`', '\\\\`')
+  end
+
+  def for_markdown
+    gsub('<', '\\<').gsub('>', '\\>').nl2br
+  end
+
+  def for_manpage
+    gsub('<', '\\<').gsub('>', '\\>').gsub('`', '**').gsub("  \n", "\n\n")
+  end
+
+  def nl2br
+    gsub("\n", "  \n")
   end
 
   def indent(offset)
@@ -13,6 +25,10 @@ class String
     gsub(/(.)([A-Z])/, '\1_\2').gsub(/[- ]/, '_').downcase
   end
 
+  def to_hyphen
+    tr(' ', '-').gsub(/([a-z])([A-Z])/, '\1-\2').downcase
+  end
+
   def to_path
     tr(' ', '/').downcase
   end

data/lib/bashly/extensions/yaml.rb

@@ -1,9 +1,12 @@
+require 'erb'
+require 'yaml'
+
 module YAML
   # We trust our loaded YAMLs
   # This patch is due to https://bugs.ruby-lang.org/issues/17866
   # StackOverflow: https://stackoverflow.com/questions/71191685/visit-psych-nodes-alias-unknown-alias-default-psychbadalias/71192990#71192990
   class << self
-    alias load unsafe_load
+    alias load unsafe_load if YAML.respond_to? :unsafe_load
 
     def load_erb_file(path)
       YAML.load ERB.new(File.read(path)).result

data/lib/bashly/libraries/libraries.yml

@@ -56,6 +56,37 @@ lib:
     - source: "lib/sample_function.sh"
       target: "%{user_lib_dir}/sample_function.%{user_ext}"
 
+render_markdown:
+  help: Copy the markdown templates to your project, allowing you to customize the markdown documentation output.
+  skip_src_check: true
+  files:
+    - source: "render/markdown/README.md"
+      target: "templates/markdown/README.md"
+    - source: "render/markdown/markdown.gtx"
+      target: "templates/markdown/markdown.gtx"
+    - source: "render/markdown/render.rb"
+      target: "templates/markdown/render.rb"
+  post_install_message: |
+    Generate your markdown documentation by running:
+
+      m`$ bashly render templates/markdown docs`
+
+render_mandoc:
+  help: Copy the mandoc templates to your project, allowing you to customize the man documentation output.
+  skip_src_check: true
+  files:
+    - source: "render/mandoc/README.md"
+      target: "templates/mandoc/README.md"
+    - source: "render/mandoc/mandoc.gtx"
+      target: "templates/mandoc/mandoc.gtx"
+    - source: "render/mandoc/render.rb"
+      target: "templates/mandoc/render.rb"
+  post_install_message: |
+    Note that this template requires pandoc.
+    Generate your man pages by running:
+
+      m`$ bashly render templates/mandoc docs`
+
 settings:
   help: Copy a sample settings.yml file to your project, allowing you to customize some bashly options.
   skip_src_check: true

data/lib/bashly/libraries/render/mandoc/README.md

@@ -0,0 +1,45 @@
+# Render mandoc
+
+Render man pages for your script.
+
+Note that this renderer will render specially formatted markdown documents and
+will then use [pandoc](https://command-not-found.com/pandoc) to convert them.
+
+## Usage
+
+```bash
+# Generate all man pages to the ./docs directory
+$ bashly render :mandoc docs
+
+# Generate on change, and show one of the files
+$ bashly render :mandoc docs --watch --show cli-download.1
+```
+
+## Supported custom definitions
+
+Add these definitions to your `bashly.yml` to render them in your
+markdown:
+
+### Footer: `x_mandoc_footer`
+
+Add additional sections to your man pages. This field is expected
+to be in markdown format.
+
+#### Example
+
+```yaml
+x_mandoc_footer: |-
+  # ISSUE TRACKER
+
+  Report issues at <https://github.com/lanalang/smallville>
+```
+
+### Authors: `x_mandoc_authors`
+
+Add an authors string to your man pages.
+
+#### Example
+
+```yaml
+x_mandoc_authors: Lana Lang
+```

data/lib/bashly/libraries/render/mandoc/mandoc.gtx

@@ -0,0 +1,196 @@
+# Reference: https://linux.die.net/man/5/pandoc_markdown
+
+if version
+  > % {{ full_name.to_hyphen }}(1) Version {{ version }} | {{ summary }}
+else
+  > % {{ full_name.to_hyphen }}(1) | {{ summary }}
+end
+
+> % {{ x_mandoc_authors&.for_manpage }}
+> % {{ Date.today.strftime "%B %Y" }}
+>
+
+> NAME
+> ==================================================
+> 
+> **{{ full_name }}** - {{ summary }}
+>
+
+> SYNOPSIS
+> ==================================================
+> 
+> {{ usage_string.gsub(/^#{full_name}/, "**#{full_name}**") }}
+>
+
+> DESCRIPTION
+> ==================================================
+> 
+> {{ help.for_manpage }}
+>
+
+if default
+  > - *Default Command*
+end
+if alt.any?
+  > - Alias: **{{ alt.join ', ' }}**
+end
+if extensible
+  if extensible.is_a? String
+    > - Extensible: **{{ extensible }}**
+  else
+    > - *Extensible*
+  end
+end
+>
+
+if public_commands.any?
+  grouped_commands.each do |group, commands|
+    > {{ group.gsub(/:$/, '').upcase }}
+    > ==================================================
+    >
+    commands.each do |subcommand|
+      > {{ subcommand.full_name }}
+      > --------------------------------------------------
+      >
+      > {{ subcommand.summary.for_manpage }}
+      >
+    end
+    >
+  end
+end
+
+if args.any?
+  > ARGUMENTS
+  > ==================================================
+  > 
+  args.each do |arg|
+    > {{ arg.name.upcase }}
+    > --------------------------------------------------
+    >
+    > {{ arg.help.for_manpage }}
+    >
+    if arg.required
+      > - *Required*
+    end
+    if arg.repeatable
+      > - *Repeatable*
+    end
+    if arg.default
+      > - Default Value: **{{ arg.default }}**
+    end
+    if arg.allowed
+      > - Allowed Values: **{{ arg.allowed.join(', ') }}**
+    end    
+    >
+  end
+
+  if catch_all.label && catch_all.help
+    > {{ catch_all.label }}
+    > --------------------------------------------------
+    >
+    if catch_all.help
+      > {{ catch_all.help.for_manpage }}
+      >
+    end
+    >
+
+    if catch_all.required?
+      > - *Required*
+      >
+    end
+  end
+end
+
+if flags.any?
+  > OPTIONS
+  > ==================================================
+  > 
+  flags.each do |flag|
+    > {{ flag.usage_string }}
+    > --------------------------------------------------
+    >
+    > {{ flag.help.for_manpage }}
+    >
+
+    if flag.required
+      > - *Required*
+    end
+    if flag.repeatable
+      > - *Repeatable*
+    end
+    if flag.default
+      > - Default Value: **{{ flag.default }}**
+    end
+    if flag.allowed
+      > - Allowed Values: **{{ flag.allowed.join(', ') }}**
+    end
+    if flag.conflicts
+      > - Conflicts With: **{{ flag.conflicts.join(', ') }}**
+    end
+    >
+  end
+end
+
+if dependencies.any?
+  > DEPENDENCIES
+  > ==================================================
+  >
+  dependencies.each do |dependency|
+    > {{ dependency.commands.join ', ' }}
+    > --------------------------------------------------
+    >
+    if dependency.help
+      > {{ dependency.help.for_manpage }}
+      >
+    end
+    >
+  end
+end
+
+if public_environment_variables.any?
+  > ENVIRONMENT VARIABLES
+  > ==================================================
+  >
+  public_environment_variables.each do |environment_variable|
+    > {{ environment_variable.name.upcase }}
+    > --------------------------------------------------
+    >
+    > {{ environment_variable.help.for_manpage }}
+    >
+
+    if environment_variable.required
+      > - *Required*
+    end
+    if environment_variable.default
+      > - Default Value: **{{ environment_variable.default }}**
+    end
+    >
+  end
+end
+
+if examples
+  > EXAMPLES
+  > ==================================================
+  >
+  > ~~~
+  examples.each do |example|
+    > {{ example.for_manpage }}
+    >
+  end
+  > ~~~
+  >
+end
+
+if public_commands.any? || parents.any?
+  > SEE ALSO
+  > ==================================================
+  >
+  if parents.any?
+    > **{{ parents.first }}**(1)
+  end
+  = public_commands.map { |x| "**#{x.full_name.to_hyphen}**(1)" }.join ', '
+  >
+end
+
+= x_mandoc_footer&.for_manpage
+>

data/lib/bashly/libraries/render/mandoc/render.rb

@@ -0,0 +1,34 @@
+# render script - mandoc
+require 'gtx'
+
+# Load the GTX template
+template = "#{source}/mandoc.gtx"
+gtx = GTX.load_file template
+
+# Define a reusable code block for rendering a man page for a command
+save_manpage = lambda { |command|
+  mdfile = "#{target}/#{command.full_name.tr(' ', '-')}.md"
+  manfile = "#{target}/#{command.full_name.tr(' ', '-')}.1"
+  save mdfile, gtx.parse(command)
+
+  # The pandoc command that creates a manpage from markdown
+  cmd = %[pandoc -f markdown-smart -s --to man "#{mdfile}" > "#{manfile}"]
+  success = system cmd
+  raise "Failed running pandoc\nMake sure the following command succeeds and try again:\n\n  #{cmd}" unless success
+
+  say "g`saved` #{manfile}"
+}
+
+# Render the main command
+save_manpage.call command
+
+# Render all subcommands
+command.deep_commands.reject(&:private).each do |subcommand|
+  save_manpage.call subcommand
+end
+
+# Show one of the files if requested
+if show
+  file = "#{target}/#{show}"
+  system "man #{file}" if File.exist?(file)
+end

data/lib/bashly/libraries/render/mandoc/summary.txt

@@ -0,0 +1 @@
+Render man pages for your script

data/lib/bashly/libraries/render/markdown/README.md

@@ -0,0 +1,42 @@
+# Render markdown
+
+Render markdown documents for your script.
+
+## Usage
+
+```bash
+# Generate all documents to the ./docs directory
+$ bashly render :markdown docs
+
+# Generate on change, and show one of the files
+$ bashly render :markdown docs --watch --show index.md
+```
+
+## 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
+
+```yaml
+x_markdown_footer: |-
+  # ISSUE TRACKER
+
+  Report issues at <https://github.com/lanalang/smallville>
+```
+
+## Markdown server
+
+In order to view your markdown files in a browser, you can use the
+[Madness markdown server](https://madness.dannyb.co/):
+
+```bash
+$ gem install madness
+$ madness server docs
+```

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

@@ -0,0 +1,186 @@
+# === Header
+
+> # {{ full_name }}
+>
+> {{ help.for_markdown }}
+>
+
+attributes = version || alt.any? || default || extensible
+
+if attributes
+  > | Attributes       |  
+  > |------------------|-------------
+  if version
+    > | Version:         | {{ version }}
+  end
+  if alt.any?
+    > | Alias:           | {{ alt.join ', ' }}
+  end
+  if default
+    > | Default Command: | ✓ Yes
+  end
+  if extensible
+    > | Extensible:      | {{ extensible.is_a?(String) ? extensible : "✓ Yes" }}
+  end
+  >
+end
+
+# === Usage
+
+> ## Usage
+>
+> ```bash
+> {{ usage_string.for_markdown }}
+> ```
+>
+
+# === Examples
+
+if examples
+  > ## Examples
+  >
+  examples.each do |example|
+    > ```bash
+    > {{ example }}
+    > ```
+    >
+  end
+end
+
+# === Dependencies
+
+if dependencies.any?
+  > ## Dependencies
+  >
+  dependencies.each do |dependency|
+    > #### *{{ dependency.commands.join ', ' }}*
+    >
+    > {{ dependency.help&.for_markdown }}
+    >
+  end
+end
+
+# === Environment Variables
+
+if public_environment_variables.any?
+  > ## Environment Variables
+  >
+  public_environment_variables.each do |environment_variable|
+    attributes = environment_variable.required || environment_variable.default
+
+    > #### *{{ environment_variable.name.upcase }}*
+    >
+    > {{ environment_variable.help.for_markdown }}
+    >
+
+    if attributes
+      > | Attributes      |  
+      > |-----------------|-------------
+      if environment_variable.required
+        > | Required:       | ✓ Yes
+      end
+      if environment_variable.default
+        > | Default Value:  | {{ environment_variable.default }}
+      end
+      >
+    end
+  end
+end
+
+# === Commands
+
+if commands.any?
+  grouped_commands.each do |group, commands|
+    > ## {{ group.gsub(/:$/, '') }}
+    >
+    commands.each do |subcommand|
+      > - [{{ subcommand.name }}]({{ subcommand.full_name.gsub(' ', '%20') }}) - {{ subcommand.summary.for_markdown }}
+    end
+    >
+  end
+end
+
+# === Arguments
+
+if args.any?
+  > ## Arguments
+  >
+  args.each do |arg|
+    attributes = arg.required || arg.repeatable || arg.default || arg.allowed
+
+    > #### *{{ arg.name.upcase }}*
+    >
+    > {{ arg.help.for_markdown }}
+    >
+
+    if attributes
+      > | Attributes      |  
+      > |-----------------|-------------
+      if arg.required
+        > | Required:       | ✓ Yes
+      end
+      if arg.repeatable
+        > | Repeatable:     |  ✓ Yes
+      end
+      if arg.default
+        > | Default Value:  | {{ arg.default }}
+      end
+      if arg.allowed
+        > | Allowed Values: | {{ arg.allowed.join(', ') }}
+      end
+      >
+    end
+  end
+
+  if catch_all.label && catch_all.help
+    > #### *{{ catch_all.label }}*
+    >
+    > {{ catch_all.help&.for_markdown }}
+    >
+    if catch_all.required?
+      > | Attributes |  
+      > |------------|-------------
+      > | Required:  | ✓ Yes
+      >
+    end
+  end
+end
+
+# === Flags
+
+if flags.any?
+  > ## Options
+  >
+  flags.each do |flag|
+    attributes = flag.required || flag.repeatable || flag.default || flag.allowed || flag.conflicts
+
+    > #### *{{ flag.usage_string }}*
+    >
+    > {{ flag.help.for_markdown }}
+    >
+
+    if attributes
+      > | Attributes      |  
+      > |-----------------|-------------
+      if flag.required
+        > | Required:       | ✓ Yes
+      end
+      if flag.repeatable
+        > | Repeatable:     |  ✓ Yes
+      end
+      if flag.default
+        > | Default Value:  | {{ flag.default }}
+      end
+      if flag.allowed
+        > | Allowed Values: | {{ flag.allowed.join(', ') }}
+      end
+      if flag.conflicts
+        > | Conflicts With: | *{{ flag.conflicts.join(', ') }}*
+      end
+      >
+    end
+  end
+end
+
+= x_markdown_footer&.for_manpage
+>

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

@@ -0,0 +1,23 @@
+# render script - markdown
+require 'gtx'
+
+# for previewing only (not needed for rendering)
+require 'tty-markdown'
+
+# Load the GTX template
+template = "#{source}/markdown.gtx"
+gtx = GTX.load_file template
+
+# Render the file for the main command
+save "#{target}/index.md", gtx.parse(command)
+
+# Render a file for each subcommand
+command.deep_commands.reject(&:private).each do |subcommand|
+  save "#{target}/#{subcommand.full_name}.md", gtx.parse(subcommand)
+end
+
+# Show one of the files if requested
+if show
+  file = "#{target}/#{show}"
+  puts TTY::Markdown.parse_file(file) if File.exist?(file)
+end

data/lib/bashly/libraries/render/markdown/summary.txt

@@ -0,0 +1 @@
+Render markdown documents for your script

data/lib/bashly/refinements/compose_refinements.rb

@@ -1,5 +1,3 @@
-require 'yaml'
-
 module ComposeRefinements
   refine Hash do
     def compose(keyword = 'import')

data/lib/bashly/render_context.rb

@@ -0,0 +1,30 @@
+require 'date'    # for use by template render scripts
+require 'colsole'
+
+module Bashly
+  class RenderContext
+    include Colsole
+
+    attr_reader :source, :target, :show
+    attr_writer :config
+
+    def initialize(source:, target:, show: nil)
+      @source = source
+      @target = target
+      @show = show
+    end
+
+    def config
+      @config ||= Config.new Settings.config_path
+    end
+
+    def command
+      @command ||= Script::Command.new config
+    end
+
+    def save(filename, content)
+      File.deep_write filename, content
+      say "g`saved` #{filename}"
+    end
+  end
+end

data/lib/bashly/render_source.rb

@@ -0,0 +1,71 @@
+module Bashly
+  class RenderSource
+    attr_reader :selector
+
+    class << self
+      include AssetHelper
+
+      def internal
+        @internal ||= internal_dirs.to_h do |dir|
+          selector = File.basename(dir).to_sym
+          [selector, new(selector)]
+        end
+      end
+
+      def internal_dirs
+        @internal_dirs ||= Dir["#{internal_root}/*"].select { |x| File.directory? x }
+      end
+
+      def internal_root
+        asset('libraries/render')
+      end
+    end
+
+    def initialize(selector)
+      @selector = selector
+    end
+
+    def render(target, show: nil)
+      context = RenderContext.new source: path, target: target, show: show
+      context.instance_eval render_script
+    end
+
+    def internal?
+      selector.is_a? Symbol
+    end
+
+    def path
+      internal? ? "#{internal_root}/#{selector}" : selector
+    end
+
+    def exist?
+      Dir.exist? path
+    end
+
+    def summary
+      File.readlines(summary_file)[0].chomp
+    end
+
+    def readme
+      File.read readme_file if File.exist? readme_file
+    end
+
+  private
+
+    def render_script
+      @render_script ||= File.read "#{path}/render.rb"
+    end
+
+    def internal_root
+      self.class.internal_root
+    end
+
+    def summary_file
+      "#{path}/summary.txt"
+    end
+
+    def readme_file
+      "#{path}/README.md"
+    end
+  end
+end

data/lib/bashly/script/base.rb

@@ -35,7 +35,8 @@ module Bashly
       end
 
       def respond_to_missing?(method_name, include_private = false)
-        self.class.option_keys.include?(method_name) || super
+        self.class.option_keys.include?(method_name) ||
+          method_name.to_s.start_with?('x_') || super
       end
     end
   end

data/lib/bashly/script/command.rb

@@ -200,6 +200,23 @@ module Bashly
         end
       end
 
+      # Returns subcommands by group
+      def grouped_commands
+        result = {}
+
+        public_commands.each do |command|
+          result[command.group_string] ||= []
+          result[command.group_string] << command
+          next unless command.expose
+
+          command.public_commands.each do |subcommand|
+            result[command.group_string] << subcommand
+          end
+        end
+
+        result
+      end
+
       # Returns a mode identifier
       def mode
         @mode ||= if global_flags?    then :global_flags

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = '1.0.8'
+  VERSION = '1.1.0'
 end

data/lib/bashly/views/command/dependencies_filter.gtx

@@ -7,7 +7,7 @@ if dependencies.any?
     > else
     >   printf "{{ strings[:missing_dependency] % { dependency: dependency.name } }}\n" >&2
     if dependency.help
-      >   printf "%s\n" "{{ dependency.help }}" >&2
+      >   printf "%s\n" "{{ dependency.help.sanitize_for_print }}" >&2
     end
     >   exit 1
     > fi

data/lib/bashly/views/command/footer.gtx

@@ -1,5 +1,5 @@
 = view_marker
 
-> printf "{{ footer.gsub("\n", '\n').gsub('"', '\"') }}\n"
+> printf "{{ footer.sanitize_for_print }}\n"
 > echo
 >

data/lib/bashly/views/command/parse_requirements_while.gtx

@@ -27,7 +27,7 @@ if catch_all.enabled?
   >       ;;
 
 else
-  >       printf "<%= strings[:invalid_flag] %>\n" "$key" >&2
+  >       printf "{{ strings[:invalid_flag] }}\n" "$key" >&2
   >       exit 1
   >       ;;
 

data/lib/bashly/views/command/usage.gtx

@@ -4,7 +4,7 @@
 >   if [[ -n $long_usage ]]; then
 
 if summary == help
-  >     printf "{{ caption_string }}\n"
+  >     printf "{{ caption_string.sanitize_for_print }}\n"
   >     echo 
 else
   >     printf "{{ full_name }}\n"
@@ -14,7 +14,7 @@ else
 end
 
 >   else
->     printf "{{ caption_string }}\n"
+>     printf "{{ caption_string.sanitize_for_print }}\n"
 >     echo 
 >   fi
 > 

data/lib/bashly/views/command/usage_commands.gtx

@@ -7,9 +7,9 @@ command_help_data.each do |group, commands|
 
   commands.each do |command, info|
     if info[:help_only]
-      > [[ -n $long_usage ]] && printf "  %s   {{ info[:summary] }}\n" "{{ command.ljust(maxlen).color(:command) }}"
+      > [[ -n $long_usage ]] && printf "  %s   {{ info[:summary].sanitize_for_print }}\n" "{{ command.ljust(maxlen).color(:command) }}"
     else
-      > printf "  %s   {{ info[:summary] }}\n" "{{ command.ljust(maxlen).color(:command) }}"
+      > printf "  %s   {{ info[:summary].sanitize_for_print }}\n" "{{ command.ljust(maxlen).color(:command) }}"
     end
   end
 

data/lib/bashly.rb

@@ -1,16 +1,61 @@
-require 'requires'
-
 if ENV['BYEBUG']
   require 'byebug'
   require 'lp'
 end
 
-requires 'bashly/concerns'
-requires 'bashly/extensions'
-requires 'bashly/settings'
-requires 'bashly/exceptions'
-requires 'bashly/refinements'
-requires 'bashly/script/base'
-requires 'bashly/commands/base'
-requires 'bashly/libraries/base'
-requires 'bashly'
+require 'bashly/extensions/array'
+require 'bashly/extensions/file'
+require 'bashly/extensions/string'
+require 'bashly/extensions/yaml'
+require 'bashly/exceptions'
+
+module Bashly
+  autoload :CLI, 'bashly/cli'
+  autoload :Config, 'bashly/config'
+  autoload :ConfigValidator, 'bashly/config_validator'
+  autoload :Library, 'bashly/library'
+  autoload :LibrarySource, 'bashly/library_source'
+  autoload :MessageStrings, 'bashly/message_strings'
+  autoload :RenderContext, 'bashly/render_context'
+  autoload :RenderSource, 'bashly/render_source'
+  autoload :VERSION, 'bashly/version'
+
+  autoload :AssetHelper, 'bashly/concerns/asset_helper'
+  autoload :Completions, 'bashly/concerns/completions'
+  autoload :ComposeRefinements, 'bashly/refinements/compose_refinements'
+  autoload :Renderable, 'bashly/concerns/renderable'
+  autoload :Settings, 'bashly/settings'
+  autoload :ValidationHelpers, 'bashly/concerns/validation_helpers'
+
+  module Script
+    autoload :Argument, 'bashly/script/argument'
+    autoload :Base, 'bashly/script/base'
+    autoload :CatchAll, 'bashly/script/catch_all'
+    autoload :Command, 'bashly/script/command'
+    autoload :Dependency, 'bashly/script/dependency'
+    autoload :EnvironmentVariable, 'bashly/script/environment_variable'
+    autoload :Flag, 'bashly/script/flag'
+    autoload :Wrapper, 'bashly/script/wrapper'
+  end
+
+  module Commands
+    autoload :Add, 'bashly/commands/add'
+    autoload :Base, 'bashly/commands/base'
+    autoload :Completions, 'bashly/commands/completions'
+    autoload :Doc, 'bashly/commands/doc'
+    autoload :Generate, 'bashly/commands/generate'
+    autoload :Init, 'bashly/commands/init'
+    autoload :Preview, 'bashly/commands/preview'
+    autoload :Render, 'bashly/commands/render'
+    autoload :Shell, 'bashly/commands/shell'
+    autoload :Validate, 'bashly/commands/validate'
+  end
+
+  module Libraries
+    autoload :Base, 'bashly/libraries/base'
+    autoload :CompletionsFunction, 'bashly/libraries/completions/completions_function'
+    autoload :CompletionsScript, 'bashly/libraries/completions/completions_script'
+    autoload :CompletionsYAML, 'bashly/libraries/completions/completions_yaml'
+    autoload :Help, 'bashly/libraries/help/help'
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.1.0
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-11 00:00:00.000000000 Z
+date: 2023-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -101,19 +101,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.7'
 - !ruby/object:Gem::Dependency
-  name: requires
+  name: tty-markdown
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: psych
   requirement: !ruby/object:Gem::Requirement
@@ -152,6 +152,7 @@ files:
 - lib/bashly/commands/generate.rb
 - lib/bashly/commands/init.rb
 - lib/bashly/commands/preview.rb
+- lib/bashly/commands/render.rb
 - lib/bashly/commands/shell.rb
 - lib/bashly/commands/validate.rb
 - lib/bashly/completions/README.md
@@ -187,6 +188,14 @@ files:
 - lib/bashly/libraries/ini/ini.sh
 - lib/bashly/libraries/lib/sample_function.sh
 - lib/bashly/libraries/libraries.yml
+- lib/bashly/libraries/render/mandoc/README.md
+- lib/bashly/libraries/render/mandoc/mandoc.gtx
+- lib/bashly/libraries/render/mandoc/render.rb
+- lib/bashly/libraries/render/mandoc/summary.txt
+- lib/bashly/libraries/render/markdown/README.md
+- lib/bashly/libraries/render/markdown/markdown.gtx
+- lib/bashly/libraries/render/markdown/render.rb
+- lib/bashly/libraries/render/markdown/summary.txt
 - lib/bashly/libraries/settings/settings.yml
 - lib/bashly/libraries/strings/strings.yml
 - lib/bashly/libraries/test/approvals.bash
@@ -200,6 +209,8 @@ files:
 - lib/bashly/library_source.rb
 - lib/bashly/message_strings.rb
 - lib/bashly/refinements/compose_refinements.rb
+- lib/bashly/render_context.rb
+- lib/bashly/render_source.rb
 - lib/bashly/script/argument.rb
 - lib/bashly/script/base.rb
 - lib/bashly/script/catch_all.rb
@@ -289,7 +300,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.18
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Bash Command Line Tool Generator