{"repo":"jfmengels/elm-review","free":true,"listed":false,"github":"https://github.com/jfmengels/elm-review","clone":"git clone https://github.com/jfmengels/elm-review.git","description":"Analyzes Elm projects, to help find mistakes before your users find them.","language":"Elm","stars":283,"topics":["elm-review","elm","elm-lang","static-code-analysis","code-quality","quality","linter"],"license":null,"category":"dev-tools","readme_excerpt":"elm-review elm-review analyzes Elm projects, to help find mistakes before your users find them. What does elm-review do? elm-review analyzes your source code, trying to recognize code that is known to cause problems. All the rules describing problematic code are written in Elm, and elm-review does not come with built-in rules; instead users are encouraged to write rules themselves and publish them as Elm packages, for everyone to benefit. Search the package registry to find what's out there! Encouraging users to write rules also makes it easy to add custom rules that only apply to your project. Such as rules that: - enforce that e.g. image paths only live in an Images module, which other modules can reference. - make everyone use a common Button component, instead of creating their own. - help users of a library you made, to avoid making mistakes that your API could not prevent them from doing. Beware how and why you introduce rules in your project though. Often a good API, that guides users to correct solutions, is the best way to go, so instead of writing a rule, maybe there is an API that can be improved? But if a rule seems like the best solution, remember to discuss it with your team. It's easy to mix up patterns that are objectively bad, with patterns that you personally find problematic, and forbidding patterns that other people find useful can be very disruptive. Try it out The easiest way to run elm-review , if you have Node.js and npm installed, is to use the elm-re","default_branch":null,"files":null,"tree":[],"storefront":"/r/jfmengels","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/jfmengels/elm-review/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."}