README.md

ameba.el

An Emacs interface to Ameba

Ameba is a static code analysis tool for Crystal.

This package allows you to use this tool directly in Emacs.

Supports Ameba of version >= 0.4.2.

Features:

• Allows to run Ameba on the currently visited file
• Allows to run Ameba on the entire project
• Allows to prompt from a directory on which to run Ameba
• Flycheck mode

Installation

ameba and flycheck-ameba packages are available on Melpa.

Usage

Run one of the predefined interactive functions.

See Function Documentation for details.

Function Documentation

(ameba-check-current-file)

Run check on the current file.

(ameba-check-project)

Run check on the current project.

(ameba-check-directory &optional DIRECTORY)

Run check on the DIRECTORY if present or prompt user if not.

(flycheck-ameba-setup)

Setup Flycheck Ameba.