angler

is a pluggable linter for Carp.

Install

git clone git@github.com:carpentry-org/angler
cd angler
carp -b main.carp
# to install
sudo install -m 755 out/angler /usr/local/bin/

Usage

angler FILE [FILE...]

Each finding is printed on its own line, prefixed with the file path:

$ angler examples/messy.carp
examples/messy.carp:1:1: [non-kebab-case-defn] defn name 'FooBar' has uppercase letters; Carp convention is kebab-case
  at: (defn FooBar [] 1)
examples/messy.carp:2:1: [form-with-do] (let ... (do ...)) can be (let-do ... ...)
  at: (let [a 1] (do a a))
examples/messy.carp:3:1: [lonely-do] (do x) is just x
  at: (do x)

Non-zero exit means something went wrong.

Using it as a library

angler.carp is also loadable from Carp code if you want to call the linter programmatically. The two public entry points are Lint.lint-source, which parses and lints a &String, and Lint.lint, which lints a pre-parsed &(Array (Box Form)).

(load "git@github.com:carpentry-org/angler@0.1.0")

(match (Lint.lint-source "(do x)")
  (Result.Success diags)
    (for [i 0 (Array.length &diags)]
      (IO.println &(Diagnostic.str (Array.unsafe-nth &diags i))))
  (Result.Error e)
    (IO.errorln &(Parser.format-error &e)))

---

Have fun!