Rubocop::Sane

TODO: Delete this and the text below, and describe your gem

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/rubocop/sane. To experiment with that code, run bin/console for an interactive prompt.

TODO: Replace UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.

Install the gem and add to the application's Gemfile by executing:

bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG

If bundler is not being used to manage dependencies, install the gem by executing:

gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG

TODO: Write usage instructions here

Enabled by default and supports autocorrection. Removes the final . from a comment unless an earlier . appears in that comment. Consecutive standalone # lines form one block; a blank line or code starts a new block. Inline comments and =begin/=end comments are checked independently. Any earlier dot counts, including dots in abbreviations, URLs, and ellipses.

# bad
# Explain this operation.

# bad
# Explain this operation
# across two lines.

# good
# Explain this operation

# good
# First sentence.
# Second sentence.

# good
# See example.com.

Reports each prohibited character in standalone, inline, and =begin/=end comment text. Enabled by default with ; prohibited. Characters are literal, including Unicode characters. Comment delimiters are excluded. This cop reports offenses without autocorrection so you can choose appropriate wording or punctuation.

Override the list in .rubocop.yml (use [] to allow all characters):

Sane/ProhibitedCommentCharacters:
  ProhibitedCharacters:
    - ";"
    - "!"

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rubocop-sane. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

The gem is available as open source under the terms of the MIT License.

Everyone interacting in the Rubocop::Sane project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.