module Ameba

Overview

Ameba's entry module.

To run the linter with default parameters:

Ameba.run

To configure and run it:

config = Ameba::Config.load
config.formatter = formatter
config.files = file_paths

Ameba.run config

Extended Modules

Defined in:

ameba.cr
ameba/glob_utils.cr
ameba/inline_comments.cr
ameba/issue.cr
ameba/reportable.cr
ameba/runner.cr
ameba/severity.cr
ameba/source.cr
ameba/spec/support.cr
ameba/tokenizer.cr

Constant Summary

VERSION = {{ (`shards version \"/home/runner/work/ameba/ameba/src\"`).chomp.stringify }}

Instance Method Summary

Instance Method Detail

def run(config = Config.load) #

Initializes Ameba::Runner and runs it. Can be configured via config parameter.

Examples:

Ameba.run
Ameba.run config

[View source]