class Ameba::Rule::Lint::SpecFocus

• Ameba::Rule::Lint::SpecFocus
• Ameba::Rule::Base
• Reference
• Object

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

• YAML::Serializable
• YAML::Serializable::Strict

Defined in:

Constant Summary

MSG = "Focused spec item detected"

SPEC_ITEM_NAMES = ["describe", "context", "it", "pending"] of ::String

Constructors

• .new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
• .new(config = nil)

  Checks if specs are focused.

Class Method Summary

• .parsed_doc : String | Nil

  Returns documentation for this rule, if there is any.

Instance Method Summary

• #description : String
• #description=(description : String)
• #enabled=(enabled : Bool)
• #enabled? : Bool
• #excluded : Array(String) | Nil
• #excluded=(excluded : Array(String) | Nil)
• #severity : Ameba::Severity
• #severity=(severity : Ameba::Severity)
• #test(source, node : Crystal::Call)
• #test(source)

Constructor Detail

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

describe MyClass do
end

describe ".new" do
end

context "my context" do
end

it "works" do
end

Lint/SpecFocus:
  Enabled: true

Class Method Detail

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