cli-template 3.3.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17cbbe8fe23b402c5d7186db07b36efb7558de259644e26b16bdcec71aef8e2d
-  data.tar.gz: 4786c899d4991565425a177028c0392af5d99d89578ebe16266f8b9d21eeb0a9
+  metadata.gz: 27407ac819b71368058edec6400c5489610b7446622c3636a423c49068da6fdf
+  data.tar.gz: ca8952b2291e00868fb233d611ad51970cf5964df8aba0e4f9e2cef11eff611f
 SHA512:
-  metadata.gz: 62acac1019b70985dbcc86c45249ecd8d7ead6730780b8b90379981ae2a244c1716d3c93eb1fb6f23d5bc8057517fc7d4062548b5be633427794636ab61c0f59
-  data.tar.gz: 0a9b85c698aabcde90a88f8b47cb400dfee8ced3761d926ea7201752a287e487cf99630af0fd544bd8037e3cb4f49c4663b95897508bd86560b21b4865822d1e
+  metadata.gz: 32911657ed62c3ceb799f2103f22d8fa62d0a85d94e8d1fe57a6ab25a94eed31a2369284a7e457b45546c77e0829d7528047ad62707147815cac15a8ed6073e3
+  data.tar.gz: e80cebb0c4e8b0c727ef6c0adf8e44045fd2ea84240e0b1a4ee6ecb217e61826bdc5987d42524fb7acc02aae89d2f6b0c171961ae32f288e9c13468844993c92

data/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 This project *tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
 
+## [3.4.0]
+- add class Error in generated class
+- add cli_markdown and rake docs task
+- add possible website url reference to cli help
+- change help also available at
+- move common commands to base Command class
+- move version, completion commands back to the CLI class so subcommands dont inherit them
+- override command_help to include description in long_description
+- remove unused completion.rb, fix command_help override
+- use 4 spaces for cli help
+
 ## [3.3.0]
 - fix completer for thor group and use public_instance_methods(false)
 - fix shared new options for thor group and cli

data/lib/cli-template/help/new.md

@@ -1,4 +1,4 @@
 Examples:
 
-  cli-template new hello
-  cli-template new another_project
+    cli-template new hello
+    cli-template new another_project

data/lib/cli-template/new.rb

@@ -27,7 +27,6 @@ module CliTemplate
     end
 
     def make_executable
-      chmod("bin", 0755 & ~File.umask, verbose: false) if File.exist?("bin")
       chmod("exe", 0755 & ~File.umask, verbose: false) if File.exist?("exe")
     end
 
@@ -55,6 +54,7 @@ Congrats 🎉 You have successfully created a CLI project.
 Test the CLI:
 
   cd #{project_name}
+  bundle
   exe/#{project_name} hello       # top-level commands
   exe/#{project_name} sub:goodbye # sub commands
   bundle exec rspec

data/lib/cli-template/version.rb

@@ -1,3 +1,3 @@
 module CliTemplate
-  VERSION = "3.3.0"
+  VERSION = "3.4.0"
 end

data/lib/templates/colon_namespaces/%project_name%.gemspec.tt

@@ -1,7 +1,5 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "<%= underscored_name %>/version"
+# -*- encoding: utf-8 -*-
+require_relative "lib/<%= underscored_name %>/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "<%= project_name %>"

data/lib/templates/colon_namespaces/Rakefile

@@ -1,6 +1,6 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-task :default => :spec
+task default: :spec
 
 RSpec::Core::RakeTask.new

data/lib/templates/colon_namespaces/exe/%project_name%.tt

@@ -7,8 +7,5 @@ Signal.trap("INT") {
   exit
 }
 
-$:.unshift(File.expand_path("../../lib", __FILE__))
-require "<%= project_name %>"
-require "<%= underscored_name %>/cli"
-
-<%= project_class_name %>::CLI.start(ARGV)
+require_relative "../lib/<%= project_name %>"
+<%= project_class_name %>::CLI.start

data/lib/templates/default/%project_name%.gemspec.tt

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["tongueroo@gmail.com"]
   spec.summary       = "Generated with cli-template tool. Please write a gem summary"
   spec.description   = "Generated with cli-template tool. Write a longer description or delete this line."
-  spec.homepage      = "Generated with cli-template tool. Put your gem's website or public repo URL here."
+  spec.homepage      = ""
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
@@ -19,12 +19,13 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "thor"
-  spec.add_dependency "colorize"
-  spec.add_dependency "rake"
   spec.add_dependency "activesupport"
+  spec.add_dependency "colorize"
+  spec.add_dependency "thor"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "byebug"
+  spec.add_development_dependency "cli_markdown"
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
 end

data/lib/templates/default/README.md.tt

@@ -11,10 +11,8 @@ TODO: Write a gem description
 
 ## Usage
 
-```sh
-<%= project_name %> hello yourname
-<%= project_name %> sub:goodbye yourname
-```
+    <%= project_name %> hello yourname
+    <%= project_name %> sub:goodbye yourname
 
 The CLI tool also detects and tasks in the current folder's Rakefile and delegate to those tasks.
 
@@ -22,21 +20,15 @@ The CLI tool also detects and tasks in the current folder's Rakefile and delegat
 
 Add this line to your application's Gemfile:
 
-```sh
-gem "<%= project_name %>"
-```
+    gem "<%= project_name %>"
 
 And then execute:
 
-```sh
-bundle
-```
+    bundle
 
 Or install it yourself as:
 
-```sh
-gem install <%= project_name %>
-```
+    gem install <%= project_name %>
 
 ## Contributing
 

data/lib/templates/default/Rakefile.tt

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task default: :spec
+
+RSpec::Core::RakeTask.new
+
+require_relative "lib/<%= project_name %>"
+require "cli_markdown"
+desc "Generates cli reference docs as markdown"
+task :docs do
+  CliMarkdown::Creator.create_all(cli_class: <%= project_class_name %>::CLI, cli_name: "<%= project_name %>")
+end

data/lib/templates/default/lib/%project_name%.rb.tt

@@ -2,10 +2,12 @@ $:.unshift(File.expand_path("../", __FILE__))
 require "<%= underscored_name %>/version"
 
 module <%= project_class_name %>
-  autoload :Help, "<%= underscored_name %>/help"
-  autoload :Command, "<%= underscored_name %>/command"
+  class Error < StandardError; end
+
   autoload :CLI, "<%= underscored_name %>/cli"
-  autoload :Sub, "<%= underscored_name %>/sub"
-  autoload :Completion, "<%= underscored_name %>/completion"
+  autoload :Command, "<%= underscored_name %>/command"
   autoload :Completer, "<%= underscored_name %>/completer"
+  autoload :Completion, "<%= underscored_name %>/completion"
+  autoload :Help, "<%= underscored_name %>/help"
+  autoload :Sub, "<%= underscored_name %>/sub"
 end

data/lib/templates/default/lib/%underscored_name%/cli.rb.tt

@@ -3,7 +3,7 @@ module <%= project_class_name %>
     class_option :verbose, type: :boolean
     class_option :noop, type: :boolean
 
-    desc "hello NAME", "say hello to NAME"
+    desc "hello NAME", "Say hello to NAME."
     long_desc Help.text(:hello)
     option :from, desc: "from person"
     def hello(name="you")
@@ -15,13 +15,13 @@ module <%= project_class_name %>
     long_desc Help.text(:sub)
     subcommand "sub", Sub
 
-    desc "completion *PARAMS", "prints words for auto-completion"
+    desc "completion *PARAMS", "Prints words for auto-completion."
     long_desc Help.text("completion")
     def completion(*params)
       Completer.new(CLI, *params).run
     end
 
-    desc "completion_script", "generates script that can be eval to setup auto-completion", hide: true
+    desc "completion_script", "Generates a script that can be eval to setup auto-completion."
     long_desc Help.text("completion_script")
     def completion_script
       Completer::Script.generate

data/lib/templates/default/lib/%underscored_name%/command.rb.tt

@@ -42,6 +42,41 @@ module <%= project_class_name %>
 
         super
       end
+
+      # Override command_help to include the description at the top of the
+      # long_description.
+      def command_help(shell, command_name)
+        meth = normalize_command_name(command_name)
+        command = all_commands[meth]
+        alter_command_description(command)
+        super
+      end
+
+      def alter_command_description(command)
+        return unless command
+
+        # Add description to beginning of long_description
+        long_desc = if command.long_description
+            "#{command.description}\n\n#{command.long_description}"
+          else
+            command.description
+          end
+
+        # add reference url to end of the long_description
+        unless website.empty?
+          full_command = [command.ancestor_name, command.name].compact.join('-')
+          url = "#{website}/reference/<%= project_name %>-#{full_command}"
+          long_desc += "\n\nHelp also available at: #{url}"
+        end
+
+        command.long_description = long_desc
+      end
+      private :alter_command_description
+
+      # meant to be overriden
+      def website
+        ""
+      end
     end
   end
 end

data/lib/templates/default/lib/%underscored_name%/completer.rb.tt

@@ -68,7 +68,7 @@ Sometimes the commands are not simple thor commands but are subcommands or Thor:
 
 Auto-completion accounts for each of these type of commands.
 =end
-module Ufo
+module <%= project_class_name %>
   class Completer
     autoload :Script, '<%= underscored_name %>/completer/script'
 

data/lib/templates/default/lib/%underscored_name%/help/completion.md.tt

@@ -1,22 +1,22 @@
 Example:
 
-  <%= project_name %> completion
+    <%= project_name %> completion
 
 Prints words for TAB auto-completion.
 
 Examples:
 
-  <%= project_name %> completion
-  <%= project_name %> completion hello
-  <%= project_name %> completion hello name
+    <%= project_name %> completion
+    <%= project_name %> completion hello
+    <%= project_name %> completion hello name
 
 To enable, TAB auto-completion add the following to your profile:
 
-  eval $(<%= project_name %> completion script)
+    eval $(<%= project_name %> completion_script)
 
 Auto-completion example usage:
 
-  <%= project_name %> [TAB]
-  <%= project_name %> hello [TAB]
-  <%= project_name %> hello name [TAB]
-  <%= project_name %> hello name --[TAB]
+    <%= project_name %> [TAB]
+    <%= project_name %> hello [TAB]
+    <%= project_name %> hello name [TAB]
+    <%= project_name %> hello name --[TAB]

data/lib/templates/default/lib/%underscored_name%/help/completion_script.md.tt

@@ -1,3 +1,3 @@
-To use, add the following to your ~/.bashrc or ~/.profile
+To use, add the following to your `~/.bashrc` or `~/.profile`
 
-  eval $(<%= project_name %> completion script)
+    eval $(<%= project_name %> completion_script)

data/lib/templates/default/lib/%underscored_name%/help/hello.md.tt

@@ -1,5 +1,5 @@
 Examples:
 
-  <%= project_name %> hello
-  <%= project_name %> hello NAME
-  <%= project_name %> hello NAME --from me
+    <%= project_name %> hello
+    <%= project_name %> hello NAME
+    <%= project_name %> hello NAME --from me

data/lib/templates/default/lib/%underscored_name%/help/sub/goodbye.md.tt

@@ -1,5 +1,5 @@
 Examples:
 
-  <%= project_name %> sub:goodbye
-  <%= project_name %> sub:goodbye NAME
-  <%= project_name %> sub:goodbye NAME --from me
+    <%= project_name %> sub:goodbye
+    <%= project_name %> sub:goodbye NAME
+    <%= project_name %> sub:goodbye NAME --from me

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cli-template
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.4.0
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-14 00:00:00.000000000 Z
+date: 2018-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -202,7 +202,7 @@ files:
 - lib/templates/default/Guardfile
 - lib/templates/default/LICENSE.txt
 - lib/templates/default/README.md.tt
-- lib/templates/default/Rakefile
+- lib/templates/default/Rakefile.tt
 - lib/templates/default/exe/%project_name%.tt
 - lib/templates/default/lib/%project_name%.rb.tt
 - lib/templates/default/lib/%underscored_name%/cli.rb.tt
@@ -210,7 +210,6 @@ files:
 - lib/templates/default/lib/%underscored_name%/completer.rb.tt
 - lib/templates/default/lib/%underscored_name%/completer/script.rb.tt
 - lib/templates/default/lib/%underscored_name%/completer/script.sh.tt
-- lib/templates/default/lib/%underscored_name%/completion.rb.tt
 - lib/templates/default/lib/%underscored_name%/help.rb.tt
 - lib/templates/default/lib/%underscored_name%/help/completion.md.tt
 - lib/templates/default/lib/%underscored_name%/help/completion_script.md.tt
@@ -242,7 +241,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Generate a CLI tool quickly

data/lib/templates/default/Rakefile

@@ -1,6 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-task :default => :spec
-
-RSpec::Core::RakeTask.new

data/lib/templates/default/lib/%underscored_name%/completion.rb.tt

@@ -1,15 +0,0 @@
-module <%= project_class_name %>
-  class Completion < Command
-    desc "script", "generates script that can be eval to setup auto-completion"
-    long_desc Help.text("completion:script")
-    def script
-      Completer::Script.generate
-    end
-
-    desc "completions *PARAMS", "prints words for auto-completion"
-    long_desc Help.text("completion:list")
-    def list(*params)
-      Completer.new(*params).run
-    end
-  end
-end