ameba-custom-rules

Custom Ameba rules enforce project-specific lint standards by implementing Ameba::Rule::Custom modules that inherit from Ameba::Rule::Base. Each rule traverses the Crystal AST, defines a MSG constant, configures a properties block, and provides test(source) overloads to catch domain-specific code smells in large codebases.

An Ameba custom rule requires a module inheriting from Ameba::Rule::Base, a properties block for configuration, a MSG string for violation messages, and test methods accepting Crystal source code or AST nodes. Automatic registration occurs through inheritance and configuration without manual setup.

Yes. Ameba custom rules support spec coverage through test(source) and test(source, node) overloads that validate rule behavior against Crystal AST nodes. This allows you to verify that rules correctly identify code smells before enforcing them across your codebase.

Yes. Writing effective custom Ameba rules requires understanding Crystal's Abstract Syntax Tree structure, as rules traverse and inspect AST nodes to detect violations. The Skill covers AST visitor patterns and node analysis within the rule implementation framework.

Custom Ameba rules register automatically through inheritance from Ameba::Rule::Base and configuration, extending Ameba's existing static analysis pipeline. This allows domain-specific checks to run alongside built-in linting rules in your Crystal project's analysis workflow.