Shard Detail

ameba v0.2.0

A static code analysis tool for Crystal
crystal linter linter-plugin

Install & Use

Add the following code to your project's shard.yml under:

dependencies to use in production
- OR -
development_dependencies to use in development

  github: crystal-ameba/ameba
  version: 0.2.0



Code style linter for Crystal

(a single-celled animal that catches food and moves about by extending fingerlike projections of protoplasm)


Ameba is a tool for enforcing a consistent Crystal code style, for catching code smells and wrong code constructions. Ameba's rules traverse AST and report bad parts of your code.

Is still under construction, compatibility may be broken 🚧


Add this to your application's shard.yml:

    github: veelenga/ameba

That will compile and install ameba binary onto your system.

Or just compile it from sources make install.


Run ameba binary within your project directory to catch code issues:

$ ameba
Inspecting 52 files.


PredicateName: Favour method name 'node?' over 'is_node?'

LiteralInCondition: Literal value found in conditional

UnlessElse: Favour if over unless with else

Finished in 10.53 milliseconds

52 inspected, 3 failures.


It is possible to configure or even disable specific rules using YAML configuration file. By default Ameba is looking for .ameba.yml in a project root directory. Copy and adjust existed example.

Write a new Rule

Adding a new rule is as simple as inheriting from Rule::Base struct and implementing your logic to detect a problem:

struct DebuggerStatement < Rule::Base
  # This is a required method to be implemented by the rule.
  # Source will be passed here. If rule finds an issue in this source,
  # it reports an error: 
  #   source.error rule, line_number, message
  def test(source)
    # This line deletegates verification to a particular AST visitor. self, source

  # This method is called once the visitor finds a required node.
  def test(source, node : Crystal::Call)
    # It reports an error, if there is `debugger` method call
    # without arguments and a receiver. That's it, somebody forgot
    # to remove a debugger statement.
    return unless == "debugger" && node.args.empty? && node.obj.nil?

    source.error self, node.location,
      "Possible forgotten debugger statement detected"


  • veelenga Vitalii Elenhaupt - creator, maintainer