README.md in gemsmith-10.3.0 vs README.md in gemsmith-10.4.0

- old
+ new

@@ -48,26 +48,27 @@ - Uses [Versionaire](https://github.com/bkuhlmann/versionaire) for semantic versioning. - Uses [Runcom](https://github.com/bkuhlmann/runcom) for resource configuration management. - Uses [Milestoner](https://github.com/bkuhlmann/milestoner) for consistent project/gem versioning. - Uses [Pragmater](https://github.com/bkuhlmann/pragmater) for Ruby source pragma directives. - Uses [Tocer](https://github.com/bkuhlmann/tocer) for README table of contents generation. -- Supports [Thor](https://github.com/erikhuda/thor). -- Supports [Ruby on Rails](http://rubyonrails.org). -- Supports [RubyGems Security](http://guides.rubygems.org/security). -- Supports [Pry](http://pryrepl.org). -- Supports [Guard](https://github.com/guard/guard). -- Supports [RSpec](http://rspec.info). +- Supports [Bundler Audit](https://github.com/rubysec/bundler-audit). +- Supports [Circle CI](https://circleci.com). +- Supports [Code Climate](https://codeclimate.com). +- Supports [Gemnasium](https://gemnasium.com). - Supports [Git Cop](https://github.com/bkuhlmann/git-cop). +- Supports [GitHub](https://github.com). +- Supports [Guard](https://github.com/guard/guard). +- Supports [Patreon](https://www.patreon.com). +- Supports [Pry](http://pryrepl.org). - Supports [Reek](https://github.com/troessner/reek). +- Supports [RSpec](http://rspec.info). - Supports [Rubocop](https://github.com/bbatsov/rubocop). +- Supports [Ruby on Rails](http://rubyonrails.org). +- Supports [RubyGems Security](http://guides.rubygems.org/security). - Supports [SCSS Lint](https://github.com/brigade/scss-lint). -- Supports [GitHub](https://github.com). -- Supports [Code Climate](https://codeclimate.com). -- Supports [Gemnasium](https://gemnasium.com). -- Supports [Circle CI](https://circleci.com). -- Supports [Patreon](https://www.patreon.com). -- Supports common settings and a structured layout for building new gems. +- Supports [Thor](https://github.com/erikhuda/thor). +- Supports common settings and a structured layout for building gems. - Supports publishing to public or private gem servers. - Provides common documentation: - [README](README.md) - [CHANGES](CHANGES.md) - [CONTRIBUTING](CONTRIBUTING.md) @@ -134,25 +135,26 @@ :url: "" :versions: :ruby: "<current Ruby version>" :rails: "5.1" :generate: + :bundler_audit: false + :circle_ci: false :cli: false - :rails: false - :security: true - :pry: true - :guard: true + :code_climate: false + :gemnasium: false :git_cop: true - :rspec: true + :git_hub: false + :guard: true + :patreon: false + :pry: true + :rails: false :reek: true + :rspec: true :rubocop: true :scss_lint: false - :git_hub: false - :code_climate: false - :gemnasium: false - :circle_ci: false - :patreon: false + :security: true :publish: :sign: false Feel free to take this default configuration, modify, and save as your own custom `configuration.yml`. @@ -193,48 +195,53 @@ gemsmith -r, [--read=GEM] # Open a gem in default browser. gemsmith -v, [--version] # Show gem version. For more gem generation options, type: `gemsmith --help --generate` - [--cli], [--no-cli] # Add CLI support. - [--rails], [--no-rails] # Add Rails support. - [--security], [--no-security] # Add security support. - # Default: true - [--pry], [--no-pry] # Add Pry support. - # Default: true - [--guard], [--no-guard] # Add Guard support. - # Default: true - [--git-cop], [--no-git-cop] # Add Git Cop support. - # Default: true - [--rspec], [--no-rspec] # Add RSpec support. - # Default: true - [--reek], [--no-reek] # Add Reek support. - # Default: true - [--rubocop], [--no-rubocop] # Add Rubocop support. - # Default: true - [--scss-lint], [--no-scss-lint] # Add SCSS Lint support. - [--git-hub], [--no-git-hub] # Add GitHub support. - [--code-climate], [--no-code-climate] # Add Code Climate support. - [--gemnasium], [--no-gemnasium] # Add Gemnasium support. - [--circle-ci], [--no-circle-ci] # Add Circle CI support. - [--patreon], [--no-patreon] # Add Patreon support. + [--bundler-audit], [--no-bundler-audit] # Add Bundler Audit support. + [--circle-ci], [--no-circle-ci] # Add Circle CI support. + [--cli], [--no-cli] # Add CLI support. + [--code-climate], [--no-code-climate] # Add Code Climate support. + [--gemnasium], [--no-gemnasium] # Add Gemnasium support. + [--git-cop], [--no-git-cop] # Add Git Cop support. + # Default: true + [--git-hub], [--no-git-hub] # Add GitHub support. + [--guard], [--no-guard] # Add Guard support. + # Default: true + [--patreon], [--no-patreon] # Add Patreon support. + [--pry], [--no-pry] # Add Pry support. + # Default: true + [--rails], [--no-rails] # Add Rails support. + [--reek], [--no-reek] # Add Reek support. + # Default: true + [--rspec], [--no-rspec] # Add RSpec support. + # Default: true + [--rubocop], [--no-rubocop] # Add Rubocop support. + # Default: true + [--scss-lint], [--no-scss-lint] # Add SCSS Lint support. + [--security], [--no-security] # Add security support. + # Default: true ### Rake Once a gem skeleton has been created, the following tasks are available (i.e. `bundle exec rake -T`): rake build # Build example-0.1.0.gem package + rake bundle:audit # Updates the ruby-advisory-db then runs bundle-audit rake clean # Clean gem artifacts rake code_quality # Run code quality checks rake doc # Update README (table of contents) rake git_cop # Run Git Cop rake install # Install example-0.1.0.gem package rake publish # Build, tag as v0.1.0 (unsigned), and push example-0.1.0.gem to RubyGems rake reek # Check for code smells rake rubocop # Run RuboCop rake rubocop:auto_correct # Auto-correct RuboCop offenses rake spec # Run RSpec code examples + +*NOTE: Some tasks might differ depending on what options you enabled/disabled during gem +generation.* When building/testing your gem locally, a typical workflow is: 0. `bundle exec rake install` 0. Test your gem locally.