camelot

An OCaml Linter / Style Checker
README

A modular and fully-configurable OCaml Linter / Style Checker for OCaml compiler version >= 4.10.0 < 4.13.0 (temporarily).

Dependencies (handled by opam)

  • ocaml >= v4.10.0 < 4.13.0

  • dune >= 2.5.0

  • compiler-libs.common

  • fswatch (for Build + Watch)

  • ANSITerminal

  • ppx_expect >= 0.13.1 (for testing)

  • yojson >= 1.7.0

  • odoc (for documentation builds)

Note:

This project is dependent on compiler-libs, an inherently unstable library that
changes between OCaml installations.

Installation

To install from the latest opam release, run: opam install camelot

Building From Source

Build:
dune build bin/camelot.exe

Build + Watch:
dune build bin/camelot.exe -w

Writing and running tests

To run tests:
dune test

If any changes you make break code, dune test will flag it and highlight the differences. If there are no issues,
dune will not print anything.

To write tests, see the dune documentation for expect-tests.
If you implement a new rule, you'll have to do the following:

  • Add your test case ( a program that you expect the linter to show a match for) to either a new file or an existing file
    in the examples/ directory.

    • If you create a new file in the examples/ directory, edit the dune file's deps stanza to make it visible to the
      build system. If you create a new programs file in examples/, you'll have to add a new let%expect_test in the style of the ones prior to the
      file test.ml, except with the [%expect {| ... |} ] clause blank.

    • If you added a test program to an existing file, it'll automatically be linted by the appropriate expect_test.

  • Run dune runtest. If your code for linting worked, runtest should
    highlight that there was a difference due to your new rule - run dune promote to accept this difference.
    Only promote if the difference that dune shows is appropriate - if there is a difference in the linted output, verify that your code did not break things,
    fix the issue, and then promote.

  • Reloading test.ml should show that the difference was added to the appropriate expect tests. In a PR, mention this - the reviewer
    should examine the expect test and make sure it makes sense (e.g. that the old prints were not messed up + the new test case appropriately printed).

Camelot flags

-d <lintdir> : Specify the directory in which to lint

-show <student | ta | gradescope | json> : Configure reporting output

  • gradescope outputs the number of violations and nothing more.

  • ta outputs a quick description of violation, and where it occurred (lines/columns).

  • json outputs the same information as ta, but in a json payload that can be utilized by an IDE for syntax highlighting (see IDE section below).

  • student is the most verbose and outputs a quick description of violation, where it occurred (lines/columns), and how to fix it.

-f <filename> : Lints the given file

IDE Support

Camelot has syntax highlighting support for Visual Studio Code using the camelot-vscode extension.

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,

  • ppx_tools/rewriter, for giving us useful starter code and being the building block on which camelot started.

Install
Sources
1.7.1.tar.gz
md5=a68be8ffeb0b3e80930c51649e68a05f
sha512=115a2a1a75e70df4897422685fc1ab33db27187ecf0c1e04e24b6ab7e9550fbec8ee6d06dddb2d4509897d23d17c1c1c0a8aec45fc26bc9a00be89209169a759
Dependencies
odoc
with-doc & >= "1.5.0"
ppx_expect
with-test & >= "v0.13.0"
yojson
>= "1.7.0"
ocaml
>= "4.10.0" & < "4.13"
dune
>= "2.5"
Reverse Dependencies