class Ameba::Rule::Lint::SpecFocus

Overview

Checks if specs are focused.

In specs focus: true is mainly used to focus on a spec item locally during development. However, if such change is committed, it silently runs only focused spec on all other environment, which is undesired.

This is considered bad:

describe MyClass, focus: true do
end

describe ".new", focus: true do
end

context "my context", focus: true do
end

it "works", focus: true do
end

And it should be written as the following:

describe MyClass do
end

describe ".new" do
end

context "my context" do
end

it "works" do
end

YAML configuration example:

Lint/SpecFocus:
  Enabled: true

Included Modules

Defined in:

ameba/rule/lint/spec_focus.cr

Constant Summary

MSG = "Focused spec item detected"
SPEC_ITEM_NAMES = ["describe", "context", "it", "pending"] of ::String

Constructors

Class Method Summary

Instance Method Summary

Instance methods inherited from class Ameba::Rule::Base

==(other) ==, catch(source : Source) catch, excluded?(source) excluded?, group group, hash hash, name name, special? special?, test(source : Source, node : Crystal::ASTNode, *opts)
test(source : Source) test

Class methods inherited from class Ameba::Rule::Base

default_severity : Ameba::Severity default_severity

Macros inherited from class Ameba::Rule::Base

issue_for(*args, **kwargs, &block) issue_for

Macros inherited from module Ameba::Config::RuleConfig

properties(&block) properties

Constructor Detail

def self.new(ctx : YAML::ParseContext, node : YAML::Nodes::Node) #

def self.new(config = nil) #

Checks if specs are focused.

In specs focus: true is mainly used to focus on a spec item locally during development. However, if such change is committed, it silently runs only focused spec on all other environment, which is undesired.

This is considered bad:

describe MyClass, focus: true do
end

describe ".new", focus: true do
end

context "my context", focus: true do
end

it "works", focus: true do
end

And it should be written as the following:

describe MyClass do
end

describe ".new" do
end

context "my context" do
end

it "works" do
end

YAML configuration example:

Lint/SpecFocus:
  Enabled: true

[View source]

Class Method Detail

def self.parsed_doc : String | Nil #

Returns documentation for this rule, if there is any.

module Ameba
  # This is a test rule.
  # Does nothing.
  class MyRule < Ameba::Rule::Base
    def test(source)
    end
  end
end

MyRule.parsed_doc # => "This is a test rule.\nDoes nothing."

Instance Method Detail

def description : String #

def description=(description : String) #

def enabled=(enabled : Bool) #

def enabled? : Bool #

def excluded : Array(String) | Nil #

def excluded=(excluded : Array(String) | Nil) #

def severity : Ameba::Severity #

def severity=(severity : Ameba::Severity) #

def since_version : SemanticVersion | Nil #

[View source]
def since_version=(since_version : String) #

def test(source, node : Crystal::Call) #

[View source]
def test(source) #

[View source]