diff options
author | Tim Smith <tsmith@chef.io> | 2018-07-30 09:03:36 -0700 |
---|---|---|
committer | Tim Smith <tsmith@chef.io> | 2018-07-30 09:03:36 -0700 |
commit | cfcb97655ac7fa32e4c7a32a1c5f8ca0c6726629 (patch) | |
tree | 6a742437b3868148fe78daf82796ec2407ad9c5a | |
parent | 87681b1af636ea79167d02afaf5931eb8c85bec7 (diff) | |
download | mixlib-cli-cfcb97655ac7fa32e4c7a32a1c5f8ca0c6726629.tar.gz |
Move dev deps to the Gemfile and add console task
Signed-off-by: Tim Smith <tsmith@chef.io>
-rw-r--r-- | Gemfile | 19 | ||||
-rw-r--r-- | README.md | 10 | ||||
-rw-r--r-- | Rakefile | 8 | ||||
-rw-r--r-- | mixlib-cli.gemspec | 6 |
4 files changed, 36 insertions, 7 deletions
@@ -7,3 +7,22 @@ group :docs do gem "redcarpet" gem "github-markup" end + +group :test do + gem "chefstyle", git: "https://github.com/chef/chefstyle.git", branch: "master" + gem "rspec", "~> 3.0" + gem "rake" +end + +group :development do + gem "pry" + gem "pry-byebug" + gem "pry-stack_explorer" + gem "rb-readline" +end + +instance_eval(ENV["GEMFILE_MOD"]) if ENV["GEMFILE_MOD"] + +# If you want to load debugging tools into the bundle exec sandbox, +# add these additional dependencies into Gemfile.local +eval_gemfile(__FILE__ + ".local") if File.exist?(__FILE__ + ".local") @@ -88,9 +88,17 @@ cli.parse_options cli.cli_arguments # [ 'file1', 'file2', 'file3' ] ``` +## Documentation + +All documentation is written using YARD. You can generate a by running: + +``` +rake yard +``` + ## Contributing -For information on contributing to this gem please see our [Contributing Documentation](https://github.com/chef/chef/blob/master/CONTRIBUTING.md) +For information on contributing to this project please see our [Contributing Documentation](https://github.com/chef/chef/blob/master/CONTRIBUTING.md) ## License & Copyright @@ -26,3 +26,11 @@ begin rescue LoadError puts "yard is not available. bundle install first to make sure all dependencies are installed." end + +task :console do + require "irb" + require "irb/completion" + require "mixlib/cli" + ARGV.clear + IRB.start +end diff --git a/mixlib-cli.gemspec b/mixlib-cli.gemspec index 1dbd0eb..da25754 100644 --- a/mixlib-cli.gemspec +++ b/mixlib-cli.gemspec @@ -12,12 +12,6 @@ Gem::Specification.new do |s| s.homepage = "https://www.chef.io" s.license = "Apache-2.0" - # Uncomment this to add a dependency - #s.add_dependency "mixlib-log" - s.add_development_dependency "chefstyle" - s.add_development_dependency "rspec", "~> 3.0" - s.add_development_dependency "rake", "~> 12.0" - s.require_path = "lib" s.files = %w{LICENSE README.md Gemfile Rakefile NOTICE} + Dir.glob("*.gemspec") + Dir.glob("{lib,spec}/**/*", File::FNM_DOTMATCH).reject { |f| File.directory?(f) } |