summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Smith <tsmith@chef.io>2018-07-30 09:03:36 -0700
committerTim Smith <tsmith@chef.io>2018-07-30 09:03:36 -0700
commitcfcb97655ac7fa32e4c7a32a1c5f8ca0c6726629 (patch)
tree6a742437b3868148fe78daf82796ec2407ad9c5a
parent87681b1af636ea79167d02afaf5931eb8c85bec7 (diff)
downloadmixlib-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--Gemfile19
-rw-r--r--README.md10
-rw-r--r--Rakefile8
-rw-r--r--mixlib-cli.gemspec6
4 files changed, 36 insertions, 7 deletions
diff --git a/Gemfile b/Gemfile
index ed7da20..61a122d 100644
--- a/Gemfile
+++ b/Gemfile
@@ -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")
diff --git a/README.md b/README.md
index 7dd7477..1309e63 100644
--- a/README.md
+++ b/README.md
@@ -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
diff --git a/Rakefile b/Rakefile
index ab6080b..3508f98 100644
--- a/Rakefile
+++ b/Rakefile
@@ -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) }