NOTICE: AS OF JUNE 2021 THIS LINTER IS OFFICIALLY DEPRECATED!

clj-kondo now includes an optional docstring checker linter, so there's no need for this little linter anymore. Use clj-kondo instead!

docstring-checker

Leiningen Plugin that lints your Clojure project and checks that every public var is documented.

Usage

Add docstring-checker to your :plugins in your project.clj:

:plugins [[docstring-checker "1.1.0"]]

Run the linter:

$ lein docstring-checker

Optionally specify which namespace regex patterns to :include and :exclude in your project.clj. (By default, the linter will check everything in your :source-paths):

:docstring-checker {:include [#"^my-project\.core"]
                    :exclude [#"test"
                              #"^my-project\.secret"]}

The linter will fail if any public vars in namespaces that match the specified patterns are undocumented.

Running Tests

Docstring Checker has a small Leiningen project with a few different profiles in the test-project directory that is used to make sure things are working correctly.

You can run the shell script to test them:

./run-tests.sh

These tests also run on CircleCI whenever a new commit is pushed.

License

Copyright © 2017-2021 Cam Saul

Distributed under the 3-Clause BSD License.