{"repo":"crystal-ameba/ameba","free":true,"listed":false,"github":"https://github.com/crystal-ameba/ameba","clone":"git clone https://github.com/crystal-ameba/ameba.git","description":"A static code analysis tool for Crystal","language":"Crystal","stars":561,"topics":["crystal","linter","ameba","code-analysis","static-analysis","formatter","code-quality"],"license":"MIT","category":"dev-tools","readme_excerpt":"Ameba Code style linter for Crystal (a single-celled animal that catches food and moves about by extending fingerlike projections of protoplasm) - About - Usage - Watch a tutorial - Autocorrection - Explain issues - Describe rules - Installation - As a project dependency - OS X - Docker - From sources - Configuration - Sources - Rules - Inline disabling - Editors \\& integrations - Credits \\& inspirations - Contributors About Ameba is a static code analysis tool for the Crystal language. It enforces a consistent Crystal code style, also catches code smells and wrong code constructs. See also Roadmap. Usage Run ameba binary within your project directory to catch code issues: Watch a tutorial 🎬 Watch the LuckyCast showing how to use Ameba Autocorrection Rules that are marked as [Correctable] in the output can be automatically corrected using --fix flag: Explain issues Ameba allows you to dig deeper into an issue, by showing you details about the issue and the reasoning behind it being reported. For convenience, you can just copy-paste the PATH:line:column string from the report and paste it behind the ameba command to check it out. Describe rules You can use --describe flag to get a detailed description of a rule: Installation As a project dependency Add this to your application's shard.yml : To prioritize runtime performance over compilation time, you can add ameba target to the shard.yml file: And then run: Alternatively, skip adding ameba target and use crystal build command","default_branch":null,"files":null,"tree":[],"storefront":"/r/crystal-ameba","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/crystal-ameba/ameba/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}