Ameba - ameba 1.7.0

# 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

- Ameba

##
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
ameba/version.cr

##
Constant Summary

VERSION = `detect_version`

##
Instance Method Summary

- #run(config = Config.load)

  Initializes `Ameba::Runner` and runs it.

- #version : Version

  Returns the version object of Ameba.

##
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)

def version : Version #

Returns the version object of Ameba.