TODO found Open
# TODO: make 'last' one date time rather than filename
- Exclude checks
TODO found Open
# TODO: Is this a good idea? Seems like I just don't uderstand ruby class loading
- Exclude checks
TODO found Open
# TODO: Make this exception more meaningful
- Exclude checks
Line is too long. [81/80] Open
# TODO: Is this a good idea? Seems like I just don't uderstand ruby class loading
- Exclude checks
Do not prefix reader method names with get_
. Open
def get_latest_image()
- Read upRead up
- Exclude checks
This cop makes sure that accessor methods are named properly.
Example:
# bad
def set_attribute(value)
end
# good
def attribute=(value)
end
# bad
def get_attribute
end
# good
def attribute
end
Line is too long. [83/80] Open
# Handle inserting screen shots into markdown and copying those to the images dir
- Exclude checks
Use a guard clause instead of wrapping the code inside a conditional expression. Open
if @latest_image.nil?
- Read upRead up
- Exclude checks
Use a guard clause instead of wrapping the code inside a conditional expression
Example:
# bad
def test
if something
work
end
end
# good
def test
return unless something
work
end
# also good
def test
work if something
end
# bad
if something
raise 'exception'
else
ok
end
# good
raise 'exception' if something
ok
Surrounding space missing in default value assignment. Open
def initialize(in_dir, out_dir, name=nil)
- Read upRead up
- Exclude checks
Checks that the equals signs in parameter default assignments have or don't have surrounding space depending on configuration.
Example:
# bad
def some_method(arg1=:default, arg2=nil, arg3=[])
# do something...
end
# good
def some_method(arg1 = :default, arg2 = nil, arg3 = [])
# do something...
end
Omit the parentheses in defs when the method doesn't accept any arguments. Open
def prompt_for_name()
- Read upRead up
- Exclude checks
This cop checks for parentheses in the definition of a method, that does not take any arguments. Both instance and class/singleton methods are checked.
Example:
# bad
def foo()
# does a thing
end
# good
def foo
# does a thing
end
# also good
def foo() does_a_thing end
Example:
# bad
def Baz.foo()
# does a thing
end
# good
def Baz.foo
# does a thing
end
Omit the parentheses in defs when the method doesn't accept any arguments. Open
def move_image()
- Read upRead up
- Exclude checks
This cop checks for parentheses in the definition of a method, that does not take any arguments. Both instance and class/singleton methods are checked.
Example:
# bad
def foo()
# does a thing
end
# good
def foo
# does a thing
end
# also good
def foo() does_a_thing end
Example:
# bad
def Baz.foo()
# does a thing
end
# good
def Baz.foo
# does a thing
end
Prefer single-quoted strings when you don't need string interpolation or special symbols. Open
puts "Error: " + msg
- Read upRead up
- Exclude checks
Checks if uses of quotes match the configured preference.
Example: EnforcedStyle: single_quotes (default)
# bad
"No special symbols"
"No string interpolation"
"Just text"
# good
'No special symbols'
'No string interpolation'
'Just text'
"Wait! What's #{this}!"
Example: EnforcedStyle: double_quotes
# bad
'Just some text'
'No special chars or interpolation'
# good
"Just some text"
"No special chars or interpolation"
"Every string in #{project} uses double_quotes"
Prefer single-quoted strings when you don't need string interpolation or special symbols. Open
puts "What would you like to call the image (no ext)?"
- Read upRead up
- Exclude checks
Checks if uses of quotes match the configured preference.
Example: EnforcedStyle: single_quotes (default)
# bad
"No special symbols"
"No string interpolation"
"Just text"
# good
'No special symbols'
'No string interpolation'
'Just text'
"Wait! What's #{this}!"
Example: EnforcedStyle: double_quotes
# bad
'Just some text'
'No special chars or interpolation'
# good
"Just some text"
"No special chars or interpolation"
"Every string in #{project} uses double_quotes"
Extra blank line detected. Open
module JekyllRake
- Read upRead up
- Exclude checks
This cops checks for two or more consecutive blank lines.
Example:
# bad - It has two empty lines.
some_method
# one empty line
# two empty lines
some_method
# good
some_method
# one empty line
some_method
Useless assignment to variable - new_file_path
. Did you mean new_file
? Open
new_file_path = File.join(Dir.pwd, new_file)
- Read upRead up
- Exclude checks
This cop checks for every useless assignment to local variable in every
scope.
The basic idea for this cop was from the warning of ruby -cw
:
assigned but unused variable - foo
Currently this cop has advanced logic that detects unreferenced reassignments and properly handles varied cases such as branch, loop, rescue, ensure, etc.
Example:
# bad
def some_method
some_var = 1
do_something
end
Example:
# good
def some_method
some_var = 1
do_something(some_var)
end
Omit the parentheses in defs when the method doesn't accept any arguments. Open
def get_latest_image()
- Read upRead up
- Exclude checks
This cop checks for parentheses in the definition of a method, that does not take any arguments. Both instance and class/singleton methods are checked.
Example:
# bad
def foo()
# does a thing
end
# good
def foo
# does a thing
end
# also good
def foo() does_a_thing end
Example:
# bad
def Baz.foo()
# does a thing
end
# good
def Baz.foo
# does a thing
end
Provide an exception class and message as arguments to raise
. Open
raise Exception.new(msg)
- Read upRead up
- Exclude checks
This cop checks the args passed to fail
and raise
. For exploded
style (default), it recommends passing the exception class and message
to raise
, rather than construct an instance of the error. It will
still allow passing just a message, or the construction of an error
with more than one argument.
The exploded style works identically, but with the addition that it will also suggest constructing error objects when the exception is passed multiple arguments.
Example: EnforcedStyle: exploded (default)
# bad
raise StandardError.new("message")
# good
raise StandardError, "message"
fail "message"
raise MyCustomError.new(arg1, arg2, arg3)
raise MyKwArgError.new(key1: val1, key2: val2)
Example: EnforcedStyle: compact
# bad
raise StandardError, "message"
raise RuntimeError, arg1, arg2, arg3
# good
raise StandardError.new("message")
raise MyCustomError.new(arg1, arg2, arg3)
fail "message"