camsaul.lein-docstring-checker

https://github.com/camsaul/lein-docstring-checker.git


    git clone 'https://github.com/camsaul/lein-docstring-checker.git'
      

      

(ql:quickload :camsaul.lein-docstring-checker)

★8

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.0.3"]]

Optionally specify which namespace regex patterns to :include and :exclude in your project.clj:

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

Then run the linter with

$ lein docstring-checker

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

Running Tests

Docstring Checker has a few small Leiningen projects in the test-projects directory that are used to make sure things are working correctly. You can run the shell script to test them:

./run-tests.sh

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

License

Distributed under the 3-Clause BSD License.