pocke / dont_comment

Do not comment out unused code, use version control system instead and remove it!

DontComment

Do not comment out unused code, use version control system instead and remove it!

What's this?

If you use version control system, you must not comment out unused code.

For example, you can remove the old implementation in the following code.

# def some_method
#   puts 'an old implementation'
# end

def some_method
  puts 'a new implementation'
end

This tool detects this problem.

Detect comment outs for debug

class ExampleController < ApplicationController
  # before_action :validate_foobar
end

Sometime we comment out validation or something for debug. If we forget to restore the comment before we commit the change, it will be a serious bug.

We can avoid the bug by this tool.

False positives

Maybe, This tools will make many false positives. I design this tools to use with a pull-request. Do not use use this tool for all ruby files in your repository. It probably will not be useful.

Installation

Add this line to your application's Gemfile:

gem 'dont_comment'

And then execute:

$ bundle

Or install it yourself as:

$ gem install dont_comment

Requirements

• Ruby 2.4 or higher

Usage

$ dont_comment some/ruby/file/path.rb
some/ruby/file/path.rb:3: Do not comment out unused code, use version control system instead and remove it!
some/ruby/file/path.rb:7: Do not comment out unused code, use version control system instead and remove it!

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/pocke/dont_comment.

dont_comment's Issues

Update README

• Installation
• Usage
• Design philosophy

--format

• simple (default)
• json

Rafactoring

Configurable Ruby version for parsing

Add test

Display relative path

Ignore English sentence without dot

# This method returns a value of String

Maybe it is not a Ruby code, but parsable.

For all ruby files by default

$ dont_comment

Currently, it doesn't work.

Ignore URL

# https://example.com

Maybe it is not a ruby code.

Add badges into README

• rubygems
• travis