class

Ameba::Config

Inherits Ameba::GlobUtils < Reference < Object

A configuration entry for Ameba::Runner.

Config can be loaded from configuration YAML file and adjusted.

config = Ameba::Config.load
config.formatter = my_formatter

Constants

AVAILABLE_FORMATTERS = { progress: Formatter::DotFormatter, todo: Formatter::TODOFormatter, flycheck: Formatter::FlycheckFormatter, silent: Formatter::BaseFormatter, disabled: Formatter::DisabledFormatter, json: Formatter::JSONFormatter, "github-actions": Formatter::GitHubActionsFormatter, }
DEFAULT_EXCLUDED = Set {"lib"}
DEFAULT_GLOBS = Set {"**/*.{cr,ecr}"}

Class methods

formatter_names(separator = '|')

Returns available formatter names joined by separator.

Source

Instance methods

autocorrect=(autocorrect : Bool)

Returns true if correctable issues should be autocorrected.

Source
autocorrect?

Returns true if correctable issues should be autocorrected.

Source
excluded

Represents a list of paths to exclude from globs. Can have wildcards.

config = Ameba::Config.load
config.excluded = Set{"spec", "src/server/*.cr"}
Source
excluded=(excluded : Set(String))

Represents a list of paths to exclude from globs. Can have wildcards.

config = Ameba::Config.load
config.excluded = Set{"spec", "src/server/*.cr"}
Source
files

Returns a list of files matching globs and excluded sections.

config = Ameba::Config.load
config.files # => list of default files
config.globs = Set{"**/*.cr", "**/*.ecr"}
config.excluded = Set{"spec"}
config.files # => list of files found by the wildcards
Source
formatter

Returns a formatter to be used while inspecting files. If formatter is not set, it will return default formatter.

config = Ameba::Config.load
config.formatter = custom_formatter
config.formatter
Source
formatter=(name : String | Symbol)

Sets formatter by name.

config = Ameba::Config.load
config.formatter = :progress
Source
formatter=(formatter : Formatter::BaseFormatter)

Returns a formatter to be used while inspecting files. If formatter is not set, it will return default formatter.

config = Ameba::Config.load
config.formatter = custom_formatter
config.formatter
Source
globs

Returns a list of paths (with wildcards) to files. Represents a list of sources to be inspected. If globs are not set, it will return default list of files.

config = Ameba::Config.load
config.globs = Set{"**/*.cr"}
config.globs
Source
globs=(globs : Set(String))

Returns a list of paths (with wildcards) to files. Represents a list of sources to be inspected. If globs are not set, it will return default list of files.

config = Ameba::Config.load
config.globs = Set{"**/*.cr"}
config.globs
Source
root

Returns a root directory to be used by Ameba::Runner.

Source
root=(root : Path)

Returns a root directory to be used by Ameba::Runner.

Source
rules

Returns an array of configured rules.

Source
severity

Returns minimum reported severity.

Source
severity=(severity : Severity)

Returns minimum reported severity.

Source
sources

Returns a list of sources matching globs and excluded sections.

config = Ameba::Config.load
config.sources # => list of default sources
config.globs = Set{"**/*.cr", "**/*.ecr"}
config.excluded = Set{"spec"}
config.sources # => list of sources pointing to files found by the wildcards
Source
stdin_filename

Returns a filename if reading source file from STDIN.

Source
stdin_filename=(stdin_filename : String | Nil)

Returns a filename if reading source file from STDIN.

Source
update_rule(name, *, enabled, excluded = nil)

Updates rule properties.

config = Ameba::Config.load
config.update_rule "MyRuleName", enabled: false
Source
update_rules(names : Enumerable(String), *, enabled, excluded = nil)

Updates rules properties.

config = Ameba::Config.load
config.update_rules %w[Rule1 Rule2], enabled: true

also it allows to update groups of rules:

config.update_rules %w[Group1 Group2], enabled: true
Source
version

Returns an ameba version to be used by Ameba::Runner.

Source
version=(version : SemanticVersion | Nil)

Returns an ameba version to be used by Ameba::Runner.

Source
version=(version : String)

Sets version from string.

config = Ameba::Config.load
config.version = "1.6.0"
Source

Nested types