decko-commons/decko

View on GitHub

Showing 661 of 695 total issues

Missing top-level module documentation comment.
Open

module Decko
Severity: Minor
Found in decko/lib/decko.rb by rubocop

This cop checks for missing top-level documentation of classes and modules. Classes with no body are exempt from the check and so are namespace modules - modules that have nothing in their bodies except classes, other modules, or constant definitions.

The documentation requirement is annulled if the class or module has a "#:nodoc:" comment next to it. Likewise, "#:nodoc: all" does the same for all its children.

Example:

# bad
class Person
  # ...
end

# good
# Description/Explanation of Person class
class Person
  # ...
end

Missing top-level class documentation comment.
Open

      class Parser < OptionParser

This cop checks for missing top-level documentation of classes and modules. Classes with no body are exempt from the check and so are namespace modules - modules that have nothing in their bodies except classes, other modules, or constant definitions.

The documentation requirement is annulled if the class or module has a "#:nodoc:" comment next to it. Likewise, "#:nodoc: all" does the same for all its children.

Example:

# bad
class Person
  # ...
end

# good
# Description/Explanation of Person class
class Person
  # ...
end

Use SCREAMING_SNAKE_CASE for constants.
Open

Decko::ModsSpecHelper = :needs_a_value_so_spring_loader_is_happy
Severity: Minor
Found in decko/lib/decko/mods_spec_helper.rb by rubocop

This cop checks whether constant names are written using SCREAMINGSNAKECASE.

To avoid false positives, it ignores cases in which we cannot know for certain the type of value that would be assigned to a constant.

Example:

# bad
InchInCm = 2.54
INCHinCM = 2.54
Inch_In_Cm = 2.54

# good
INCH_IN_CM = 2.54

Missing top-level class documentation comment.
Open

  class SpecBuilder

This cop checks for missing top-level documentation of classes and modules. Classes with no body are exempt from the check and so are namespace modules - modules that have nothing in their bodies except classes, other modules, or constant definitions.

The documentation requirement is annulled if the class or module has a "#:nodoc:" comment next to it. Likewise, "#:nodoc: all" does the same for all its children.

Example:

# bad
class Person
  # ...
end

# good
# Description/Explanation of Person class
class Person
  # ...
end

Missing top-level module documentation comment.
Open

  module Array

This cop checks for missing top-level documentation of classes and modules. Classes with no body are exempt from the check and so are namespace modules - modules that have nothing in their bodies except classes, other modules, or constant definitions.

The documentation requirement is annulled if the class or module has a "#:nodoc:" comment next to it. Likewise, "#:nodoc: all" does the same for all its children.

Example:

# bad
class Person
  # ...
end

# good
# Description/Explanation of Person class
class Person
  # ...
end

Missing top-level module documentation comment.
Open

      module PostgreSQLAdapter

This cop checks for missing top-level documentation of classes and modules. Classes with no body are exempt from the check and so are namespace modules - modules that have nothing in their bodies except classes, other modules, or constant definitions.

The documentation requirement is annulled if the class or module has a "#:nodoc:" comment next to it. Likewise, "#:nodoc: all" does the same for all its children.

Example:

# bad
class Person
  # ...
end

# good
# Description/Explanation of Person class
class Person
  # ...
end

Re-enable Lint/AmbiguousRegexpLiteral cop with # rubocop:enable after disabling it.
Open

# rubocop:disable Lint/AmbiguousRegexpLiteral

Re-enable Lint/AmbiguousRegexpLiteral cop with # rubocop:enable after disabling it.
Open

# rubocop:disable Lint/AmbiguousRegexpLiteral

Start context description with 'when', 'with', or 'without'.
Open

    context "css" do

Name your test subject if you need to reference it explicitly.
Open

          expect(subject.key).to eq(:logo.cardname.key)

Missing top-level module documentation comment.
Open

module CoreExtensions

This cop checks for missing top-level documentation of classes and modules. Classes with no body are exempt from the check and so are namespace modules - modules that have nothing in their bodies except classes, other modules, or constant definitions.

The documentation requirement is annulled if the class or module has a "#:nodoc:" comment next to it. Likewise, "#:nodoc: all" does the same for all its children.

Example:

# bad
class Person
  # ...
end

# good
# Description/Explanation of Person class
class Person
  # ...
end

Start context description with 'when', 'with', or 'without'.
Open

    context "view = new" do

Use only ascii symbols in comments.
Open

# This mod is strongly recommended for platypuses – coders working on the decko core
Severity: Minor
Found in Gemfile by rubocop

This cop checks for non-ascii (non-English) characters in comments. You could set an array of allowed non-ascii chars in AllowedChars attribute (empty by default).

Example:

# bad
# Translates from English to 日本語。

# good
# Translates from English to Japanese

Start context description with 'when', 'with', or 'without'.
Open

  context "raw format" do
Severity: Minor
Found in card/spec/card/diff_spec.rb by rubocop

Missing top-level module documentation comment.
Open

      module SQLiteAdapter

This cop checks for missing top-level documentation of classes and modules. Classes with no body are exempt from the check and so are namespace modules - modules that have nothing in their bodies except classes, other modules, or constant definitions.

The documentation requirement is annulled if the class or module has a "#:nodoc:" comment next to it. Likewise, "#:nodoc: all" does the same for all its children.

Example:

# bad
class Person
  # ...
end

# good
# Description/Explanation of Person class
class Person
  # ...
end

Missing top-level module documentation comment.
Open

      module ClassMethods

This cop checks for missing top-level documentation of classes and modules. Classes with no body are exempt from the check and so are namespace modules - modules that have nothing in their bodies except classes, other modules, or constant definitions.

The documentation requirement is annulled if the class or module has a "#:nodoc:" comment next to it. Likewise, "#:nodoc: all" does the same for all its children.

Example:

# bad
class Person
  # ...
end

# good
# Description/Explanation of Person class
class Person
  # ...
end

Line is too long. [104/90]
Open

  # Precompile additional assets (application.js, application.css, and all non-JS/CSS are already added)

Re-enable Lint/AmbiguousRegexpLiteral cop with # rubocop:enable after disabling it.
Open

# rubocop:disable Lint/AmbiguousRegexpLiteral

Re-enable Lint/AmbiguousRegexpLiteral cop with # rubocop:enable after disabling it.
Open

# rubocop:disable Lint/AmbiguousRegexpLiteral

Missing top-level class documentation comment.
Open

class FetchTest < ActionDispatch::PerformanceTest

This cop checks for missing top-level documentation of classes and modules. Classes with no body are exempt from the check and so are namespace modules - modules that have nothing in their bodies except classes, other modules, or constant definitions.

The documentation requirement is annulled if the class or module has a "#:nodoc:" comment next to it. Likewise, "#:nodoc: all" does the same for all its children.

Example:

# bad
class Person
  # ...
end

# good
# Description/Explanation of Person class
class Person
  # ...
end
Severity
Category
Status
Source
Language