package camelot
Install
Dune Dependency
Authors
Maintainers
Sources
md5=802071069c6f70fa3f104ca0b0357bb9
sha512=4d8bbf0c84c6db522e024c5616b4aedfef89918a660eb78e87c826802f68824777008e26f4d09a1e69c39643c3d6488332c01b2c72f10dd74e7183aef02f2a86
Description
Published: 24 May 2020
README
Camelot
An OCaml Linter / Style Checker for the OCaml compiler version 4.09.0. Make sure you have ocaml version 4.09.0, otherwise the parsetree will be different
Acknowledgements
This project wouldn't have been possible without the following three repos:
sml-style-check from the folks at CMU: for guiding the design of the linter, as well as basically contributing the structure of our project (especially the extendable checker modules :) ),
hlint for a good reference on building a linter,
and ppx_tools/rewriter, for giving us useful starter code and being the building block on which camelot started.
Dependencies
ocaml >= v4.10.0
dune >= 2.5.0
compiler-libs.common
fswatch (for Build + Watch)
ANSITerminal
Note:
This project is dependent on compiler-libs, an inherently unstable library that changes between OCaml installations.
Build and run instructions
Build: dune build bin/camelot.exe
Build + Watch: dune build bin/camelot.exe -w
Run 'tests': dune exec -- bin/camelot.exe <camelot args here>
Camelot flags
-d <lintdir>
: Specify the directory in which to lint
-show <ta | student | gradescope>
: Specify the reporting type - does a student see this output or a ta? If this argument is malformed or not present, the reporting type defaults to student
-f <filename>
: Lints the given file
Dependencies (3)
-
ANSITerminal
>= "0.8"
-
ocaml
>= "4.10.0" & < "4.13"
-
dune
>= "2.5"
Dev Dependencies
None
Used by
None
Conflicts
None