cli_markdown 0.1.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec2eb95b5cd0c7a7295f1b31195979c9d9fad652676517a0e59166875b76e330
-  data.tar.gz: 0cf8d886a34c22b26ffa8f8fe49f12ab68a30e36286ddfcb149646394939dac9
+  metadata.gz: dbea0fd699683bc2e402c1a0ec809b6a457a32eef56b8ac95b5e529c40f50170
+  data.tar.gz: c4c9dc36d788d020a7bfc8f8124e27bfac5fb3da4a3cc452cab63dcb5a1cafcd
 SHA512:
-  metadata.gz: 65805b1221655539b07cfb7144f4ed86e52446f7ee8c5e1d04972b5e5615e13f3dabcecfb0face82f17f1db4433795d4edf859749304e5cf010ae40a55b9c75b
-  data.tar.gz: a6b7bf93e2763b2e3557a0d0f8c6e57cba0081be9476267059b0c4b66a26d89da0fb84355165edfe679d74601e9ad3beb3682a3eb94403fbddbcbd06c34db6d3
+  metadata.gz: 3eb1acf51d748b6cc380e491cf7263509685ec72207f2cd329a9053754625b1d6155085fd8408a387d78f66c4fae3f376684861776a64067a2cfdbcb978c9570
+  data.tar.gz: b8066d9900fd282156475a423bdcf94a2d55c0304404db2b1b153ecf550e5746dcd097e329521ae440d25dd683e39459aae7d01fb3eb58f15ec3667cc9e933d1

data/.gitignore

@@ -7,3 +7,7 @@
 /spec/reports/
 /tmp/
 /docs
+Gemfile
+/Gemfile.lock
+/bin
+

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Change Log
 
+## [0.1.3] - 2022-03-03
+- ensure docs/_includes folder exists
+
+## [0.1.2] - 2021-12-29
+- dont generate docs for hidden commands
+
+## [0.1.1] - 2021-12-29
+- fix cli markdown initialize options
+
 ## [0.1.0]
 - Initial release
 - Extract cli doc generation out of lono

data/Rakefile

@@ -1,11 +1,2 @@
 require "bundler/gem_tasks"
 task :default => :spec
-
-# In a real project the require will be the project itself.
-# This ask is only here to pass specs.
-require "lono"
-require "./lib/cli_markdown"
-desc "Generates cli reference docs as markdown"
-task :docs do
-  CliMarkdown::Creator.create_all(cli_class: Lono::CLI, cli_name: "lono")
-end

data/cli_markdown.gemspec

@@ -19,7 +19,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler"
-  spec.add_development_dependency "lono"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
 end

data/lib/cli_markdown/creator.rb

@@ -1,3 +1,4 @@
+require "active_support"
 require "active_support/core_ext/object"
 
 module CliMarkdown
@@ -15,16 +16,17 @@ module CliMarkdown
     end
 
     # cli_class is top-level CLI class.
-    def initialize(cli_class:, cli_name:, parent_command_name: nil)
-      @cli_class = cli_class
-      @cli_name = cli_name
-      @parent_command_name = parent_command_name
+    def initialize(options={})
+      @cli_class = options[:cli_class]
+      @cli_name = options[:cli_name]
+      @parent_command_name = options[:parent_command_name]
     end
 
     def create_all
       create_index unless @parent_command_name
 
-      @cli_class.commands.keys.each do |command_name|
+      commands = @cli_class.commands.reject { |command_name, command| command.hidden? }
+      commands.keys.each do |command_name|
         page = Page.new(
             cli_class: @cli_class,
             cli_name: @cli_name,
@@ -63,6 +65,7 @@ module CliMarkdown
 
     def create_include_reference
       path = "docs/_includes/reference.md"
+      FileUtils.mkdir_p(File.dirname(path))
       IO.write(path, "Generic tool description. Please edit #{path} with a description.") unless File.exist?(path)
     end
 

data/lib/cli_markdown/index.rb

@@ -10,7 +10,8 @@ module CliMarkdown
     end
 
     def command_list
-      @cli_class.commands.keys.sort.map.each do |command_name|
+      commands = @cli_class.commands.reject { |command_name, command| command.hidden? }
+      commands.keys.sort.map.each do |command_name|
         page = Page.new(
             cli_class: @cli_class,
             cli_name: @cli_name,

data/lib/cli_markdown/page.rb

@@ -2,7 +2,7 @@ module CliMarkdown
   class Page
     attr_reader :cli_name
     def initialize(cli_class:, cli_name:, command_name:, parent_command_name: nil)
-      @cli_class = cli_class # IE: Lono::CLI
+      @cli_class = cli_class # IE: Jets::Commands::Main
       @cli_name = cli_name # IE: lono
       @command_name = command_name # IE: generate
       @parent_command_name = parent_command_name # IE: cfn

data/lib/cli_markdown/version.rb

@@ -1,3 +1,3 @@
 module CliMarkdown
-  VERSION = "0.1.0"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cli_markdown
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.3
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-26 00:00:00.000000000 Z
+date: 2022-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: lono
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -77,11 +63,8 @@ files:
 - ".rspec"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - cli_markdown.gemspec
 - lib/cli_markdown.rb
 - lib/cli_markdown/creator.rb
@@ -107,8 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.2.32
 signing_key: 
 specification_version: 4
 summary: Generate markdown docs from cli docs

data/Gemfile.lock

@@ -1,129 +0,0 @@
-PATH
-  remote: .
-  specs:
-    cli_markdown (0.1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (5.1.5)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    aws-partitions (1.67.0)
-    aws-sdk-cloudformation (1.3.0)
-      aws-sdk-core (~> 3)
-      aws-sigv4 (~> 1.0)
-    aws-sdk-core (3.16.0)
-      aws-partitions (~> 1.0)
-      aws-sigv4 (~> 1.0)
-      jmespath (~> 1.0)
-    aws-sdk-kms (1.5.0)
-      aws-sdk-core (~> 3)
-      aws-sigv4 (~> 1.0)
-    aws-sdk-s3 (1.8.2)
-      aws-sdk-core (~> 3)
-      aws-sdk-kms (~> 1)
-      aws-sigv4 (~> 1.0)
-    aws-sigv4 (1.0.2)
-    coderay (1.1.2)
-    colorize (0.8.1)
-    concurrent-ruby (1.0.5)
-    diff-lcs (1.3)
-    ffi (1.9.23)
-    filesize (0.1.1)
-    formatador (0.2.5)
-    graph (2.8.2)
-    guard (2.14.2)
-      formatador (>= 0.2.4)
-      listen (>= 2.7, < 4.0)
-      lumberjack (>= 1.0.12, < 2.0)
-      nenv (~> 0.1)
-      notiffany (~> 0.0)
-      pry (>= 0.9.12)
-      shellany (~> 0.0)
-      thor (>= 0.18.1)
-    guard-cloudformation (0.0.3)
-      colorize
-      guard
-    guard-compat (1.2.1)
-    guard-lono (1.0.1)
-      colorize
-      guard
-      guard-compat
-    hashie (3.5.7)
-    i18n (0.9.5)
-      concurrent-ruby (~> 1.0)
-    jmespath (1.3.1)
-    json (2.1.0)
-    listen (3.1.5)
-      rb-fsevent (~> 0.9, >= 0.9.4)
-      rb-inotify (~> 0.9, >= 0.9.7)
-      ruby_dep (~> 1.2)
-    lono (4.0.6)
-      activesupport
-      aws-sdk-cloudformation
-      aws-sdk-s3
-      colorize
-      filesize
-      graph
-      guard
-      guard-cloudformation
-      guard-lono
-      hashie
-      json
-      rb-fsevent
-      render_me_pretty
-      thor
-    lumberjack (1.0.12)
-    method_source (0.9.0)
-    minitest (5.11.3)
-    nenv (0.3.0)
-    notiffany (0.1.1)
-      nenv (~> 0.1)
-      shellany (~> 0.0)
-    pry (0.11.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rake (12.3.0)
-    rb-fsevent (0.10.2)
-    rb-inotify (0.9.10)
-      ffi (>= 0.5.0, < 2)
-    render_me_pretty (0.7.1)
-      activesupport
-      colorize
-      tilt
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
-    ruby_dep (1.5.0)
-    shellany (0.0.1)
-    thor (0.20.0)
-    thread_safe (0.3.6)
-    tilt (2.0.8)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler
-  cli_markdown!
-  lono
-  rake
-  rspec
-
-BUNDLED WITH
-   1.16.1

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "cli_markdown"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here