Mascot is a style-checker for OCaml
sources. It provides checks in various categories: code, documentation, interface, metrics, and typography. The goal of the tool is to allow a (team of) developer(s) to enforce style properties over a source codebase for greater coherency and style uniformity. The tool is highly customizable, allowing one to choose the checks to perform, as well as exceptions to those checks in given files. Moreover, a plugin system allows the developer to add its own checks, and output modes.
Bundled output modes range from bare text to CheckStyle
- and JDepend
-compatible XML file in order to allow integration with Jenkins
Mascot is released under the GPL v3.
It is copyright (c) 2010-2012 Xavier Clerc.
In order to improve the project, I am primarily looking for testers and bug reporters
. Pointing errors in documentation and indicating where it should be enhanced is also very helpful. Of course, aside from bugs, you can also use the tracker to request new features.
repository is http://mascot.x9c.fr
(read-only, useful to always get the last version).