cli_markdown 0.1.0 → 0.1.1

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: ec2eb95b5cd0c7a7295f1b31195979c9d9fad652676517a0e59166875b76e330
4
- data.tar.gz: 0cf8d886a34c22b26ffa8f8fe49f12ab68a30e36286ddfcb149646394939dac9
3
+ metadata.gz: 712013ecc2ea35c7a18e1c45f55693d6af97ad19d9bfc6f0cb5686338a7a4ebd
4
+ data.tar.gz: 54b20339e4abbcb120396e786d266c1fa2f33be1df340b4fd88bb07ae22ab290
5
5
  SHA512:
6
- metadata.gz: 65805b1221655539b07cfb7144f4ed86e52446f7ee8c5e1d04972b5e5615e13f3dabcecfb0face82f17f1db4433795d4edf859749304e5cf010ae40a55b9c75b
7
- data.tar.gz: a6b7bf93e2763b2e3557a0d0f8c6e57cba0081be9476267059b0c4b66a26d89da0fb84355165edfe679d74601e9ad3beb3682a3eb94403fbddbcbd06c34db6d3
6
+ metadata.gz: 0d55af80f96888c34cda3e69e7def870c8167da6a079ca039ec0618982b28ebeadeb44bb79c4b42d9cd5a31dee7ea6f0297c9aaf9c19fc507e175a6396db0b8b
7
+ data.tar.gz: 35b49d783caccc6ae3fb05b348841ee5f02ae6fc66e882d8739d0c09510850634a7576dd1402addca9d5c958e053a4d86331ef653ae1daf2f96ecdb8d3a16c06
data/.gitignore CHANGED
@@ -7,3 +7,5 @@
7
7
  /spec/reports/
8
8
  /tmp/
9
9
  /docs
10
+ /Gemfile
11
+ /bin
data/CHANGELOG.md CHANGED
@@ -1,5 +1,8 @@
1
1
  # Change Log
2
2
 
3
+ ## [0.1.1] - 2021-12-29
4
+ - fix cli markdown initialize options
5
+
3
6
  ## [0.1.0]
4
7
  - Initial release
5
8
  - Extract cli doc generation out of lono
data/Gemfile.lock CHANGED
@@ -1,129 +1,35 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- cli_markdown (0.1.0)
4
+ cli_markdown (0.1.1)
5
5
 
6
6
  GEM
7
7
  remote: https://rubygems.org/
8
8
  specs:
9
- activesupport (5.1.5)
10
- concurrent-ruby (~> 1.0, >= 1.0.2)
11
- i18n (~> 0.7)
12
- minitest (~> 5.1)
13
- tzinfo (~> 1.1)
14
- aws-partitions (1.67.0)
15
- aws-sdk-cloudformation (1.3.0)
16
- aws-sdk-core (~> 3)
17
- aws-sigv4 (~> 1.0)
18
- aws-sdk-core (3.16.0)
19
- aws-partitions (~> 1.0)
20
- aws-sigv4 (~> 1.0)
21
- jmespath (~> 1.0)
22
- aws-sdk-kms (1.5.0)
23
- aws-sdk-core (~> 3)
24
- aws-sigv4 (~> 1.0)
25
- aws-sdk-s3 (1.8.2)
26
- aws-sdk-core (~> 3)
27
- aws-sdk-kms (~> 1)
28
- aws-sigv4 (~> 1.0)
29
- aws-sigv4 (1.0.2)
30
- coderay (1.1.2)
31
- colorize (0.8.1)
32
- concurrent-ruby (1.0.5)
33
- diff-lcs (1.3)
34
- ffi (1.9.23)
35
- filesize (0.1.1)
36
- formatador (0.2.5)
37
- graph (2.8.2)
38
- guard (2.14.2)
39
- formatador (>= 0.2.4)
40
- listen (>= 2.7, < 4.0)
41
- lumberjack (>= 1.0.12, < 2.0)
42
- nenv (~> 0.1)
43
- notiffany (~> 0.0)
44
- pry (>= 0.9.12)
45
- shellany (~> 0.0)
46
- thor (>= 0.18.1)
47
- guard-cloudformation (0.0.3)
48
- colorize
49
- guard
50
- guard-compat (1.2.1)
51
- guard-lono (1.0.1)
52
- colorize
53
- guard
54
- guard-compat
55
- hashie (3.5.7)
56
- i18n (0.9.5)
57
- concurrent-ruby (~> 1.0)
58
- jmespath (1.3.1)
59
- json (2.1.0)
60
- listen (3.1.5)
61
- rb-fsevent (~> 0.9, >= 0.9.4)
62
- rb-inotify (~> 0.9, >= 0.9.7)
63
- ruby_dep (~> 1.2)
64
- lono (4.0.6)
65
- activesupport
66
- aws-sdk-cloudformation
67
- aws-sdk-s3
68
- colorize
69
- filesize
70
- graph
71
- guard
72
- guard-cloudformation
73
- guard-lono
74
- hashie
75
- json
76
- rb-fsevent
77
- render_me_pretty
78
- thor
79
- lumberjack (1.0.12)
80
- method_source (0.9.0)
81
- minitest (5.11.3)
82
- nenv (0.3.0)
83
- notiffany (0.1.1)
84
- nenv (~> 0.1)
85
- shellany (~> 0.0)
86
- pry (0.11.3)
87
- coderay (~> 1.1.0)
88
- method_source (~> 0.9.0)
89
- rake (12.3.0)
90
- rb-fsevent (0.10.2)
91
- rb-inotify (0.9.10)
92
- ffi (>= 0.5.0, < 2)
93
- render_me_pretty (0.7.1)
94
- activesupport
95
- colorize
96
- tilt
97
- rspec (3.7.0)
98
- rspec-core (~> 3.7.0)
99
- rspec-expectations (~> 3.7.0)
100
- rspec-mocks (~> 3.7.0)
101
- rspec-core (3.7.1)
102
- rspec-support (~> 3.7.0)
103
- rspec-expectations (3.7.0)
9
+ diff-lcs (1.5.0)
10
+ rake (13.0.6)
11
+ rspec (3.10.0)
12
+ rspec-core (~> 3.10.0)
13
+ rspec-expectations (~> 3.10.0)
14
+ rspec-mocks (~> 3.10.0)
15
+ rspec-core (3.10.1)
16
+ rspec-support (~> 3.10.0)
17
+ rspec-expectations (3.10.1)
104
18
  diff-lcs (>= 1.2.0, < 2.0)
105
- rspec-support (~> 3.7.0)
106
- rspec-mocks (3.7.0)
19
+ rspec-support (~> 3.10.0)
20
+ rspec-mocks (3.10.2)
107
21
  diff-lcs (>= 1.2.0, < 2.0)
108
- rspec-support (~> 3.7.0)
109
- rspec-support (3.7.1)
110
- ruby_dep (1.5.0)
111
- shellany (0.0.1)
112
- thor (0.20.0)
113
- thread_safe (0.3.6)
114
- tilt (2.0.8)
115
- tzinfo (1.2.5)
116
- thread_safe (~> 0.1)
22
+ rspec-support (~> 3.10.0)
23
+ rspec-support (3.10.3)
117
24
 
118
25
  PLATFORMS
119
- ruby
26
+ x86_64-linux
120
27
 
121
28
  DEPENDENCIES
122
29
  bundler
123
30
  cli_markdown!
124
- lono
125
31
  rake
126
32
  rspec
127
33
 
128
34
  BUNDLED WITH
129
- 1.16.1
35
+ 2.2.32
data/Rakefile CHANGED
@@ -1,11 +1,2 @@
1
1
  require "bundler/gem_tasks"
2
2
  task :default => :spec
3
-
4
- # In a real project the require will be the project itself.
5
- # This ask is only here to pass specs.
6
- require "lono"
7
- require "./lib/cli_markdown"
8
- desc "Generates cli reference docs as markdown"
9
- task :docs do
10
- CliMarkdown::Creator.create_all(cli_class: Lono::CLI, cli_name: "lono")
11
- end
data/cli_markdown.gemspec CHANGED
@@ -19,7 +19,6 @@ Gem::Specification.new do |spec|
19
19
  spec.require_paths = ["lib"]
20
20
 
21
21
  spec.add_development_dependency "bundler"
22
- spec.add_development_dependency "lono"
23
22
  spec.add_development_dependency "rake"
24
23
  spec.add_development_dependency "rspec"
25
24
  end
@@ -1,3 +1,4 @@
1
+ require "active_support"
1
2
  require "active_support/core_ext/object"
2
3
 
3
4
  module CliMarkdown
@@ -15,10 +16,10 @@ module CliMarkdown
15
16
  end
16
17
 
17
18
  # cli_class is top-level CLI class.
18
- def initialize(cli_class:, cli_name:, parent_command_name: nil)
19
- @cli_class = cli_class
20
- @cli_name = cli_name
21
- @parent_command_name = parent_command_name
19
+ def initialize(options={})
20
+ @cli_class = options[:cli_class]
21
+ @cli_name = options[:cli_name]
22
+ @parent_command_name = options[:parent_command_name]
22
23
  end
23
24
 
24
25
  def create_all
@@ -2,7 +2,7 @@ module CliMarkdown
2
2
  class Page
3
3
  attr_reader :cli_name
4
4
  def initialize(cli_class:, cli_name:, command_name:, parent_command_name: nil)
5
- @cli_class = cli_class # IE: Lono::CLI
5
+ @cli_class = cli_class # IE: Jets::Commands::Main
6
6
  @cli_name = cli_name # IE: lono
7
7
  @command_name = command_name # IE: generate
8
8
  @parent_command_name = parent_command_name # IE: cfn
@@ -1,3 +1,3 @@
1
1
  module CliMarkdown
2
- VERSION = "0.1.0"
2
+ VERSION = "0.1.1"
3
3
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: cli_markdown
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.1.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Tung Nguyen
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2018-02-26 00:00:00.000000000 Z
11
+ date: 2021-12-29 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler
@@ -24,20 +24,6 @@ dependencies:
24
24
  - - ">="
25
25
  - !ruby/object:Gem::Version
26
26
  version: '0'
27
- - !ruby/object:Gem::Dependency
28
- name: lono
29
- requirement: !ruby/object:Gem::Requirement
30
- requirements:
31
- - - ">="
32
- - !ruby/object:Gem::Version
33
- version: '0'
34
- type: :development
35
- prerelease: false
36
- version_requirements: !ruby/object:Gem::Requirement
37
- requirements:
38
- - - ">="
39
- - !ruby/object:Gem::Version
40
- version: '0'
41
27
  - !ruby/object:Gem::Dependency
42
28
  name: rake
43
29
  requirement: !ruby/object:Gem::Requirement
@@ -80,8 +66,6 @@ files:
80
66
  - Gemfile.lock
81
67
  - README.md
82
68
  - Rakefile
83
- - bin/console
84
- - bin/setup
85
69
  - cli_markdown.gemspec
86
70
  - lib/cli_markdown.rb
87
71
  - lib/cli_markdown/creator.rb
@@ -107,8 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
107
91
  - !ruby/object:Gem::Version
108
92
  version: '0'
109
93
  requirements: []
110
- rubyforge_project:
111
- rubygems_version: 2.7.3
94
+ rubygems_version: 3.2.32
112
95
  signing_key:
113
96
  specification_version: 4
114
97
  summary: Generate markdown docs from cli docs
data/bin/console DELETED
@@ -1,14 +0,0 @@
1
- #!/usr/bin/env ruby
2
-
3
- require "bundler/setup"
4
- require "cli_markdown"
5
-
6
- # You can add fixtures and/or initialization code here to make experimenting
7
- # with your gem easier. You can also use a different console, if you like.
8
-
9
- # (If you use this, don't forget to add pry to your Gemfile!)
10
- # require "pry"
11
- # Pry.start
12
-
13
- require "irb"
14
- IRB.start(__FILE__)
data/bin/setup DELETED
@@ -1,8 +0,0 @@
1
- #!/usr/bin/env bash
2
- set -euo pipefail
3
- IFS=$'\n\t'
4
- set -vx
5
-
6
- bundle install
7
-
8
- # Do any other automated setup that you need to do here