Liking cljdoc? Tell your friends :D

Development

Dialog uses Clojure's CLI tooling, deps.edn, and tools.build for development.

REPL

To start a basic REPL, use the bin script:

bin/repl

Run Tests

To test-compile the code and find any reflection warnings:

bin/test check

Tests are run with kaocha via a bin script:

# run tests once
bin/test

# watch and rerun tests
bin/test --watch

To compute test coverage with cloverage:

bin/test coverage

Build Jar

For compiling code and building a JAR file, dialog uses tools.build. The various commands can be found in the build.clj file and invoked with the -T:build alias or the bin script:

# clean artifacts
bin/build clean

# create a jar
bin/build jar

# install to local repo
bin/build install

To deploy the project to Clojars, use the deploy build command. This will prompt for your Clojars username and deploy token, or they can be set in the environment as CLOJARS_USERNAME and CLOJARS_PASSWORD, respectively.

# deploy to Clojars
bin/build deploy

Can you improve this documentation?Edit on GitHub

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close