Liking cljdoc? Tell your friends :D

License Codecov Build Deploy Clojars

clj-fsm

Finite state machine (FSM) for Clojure(Script).

STATUS: Pre-alpha, in design and prototyping phase.

Quick Start Guide

Add the following dependency in your project:

;; project.clj or build.boot
[clj-fsm "RELEASE"]

;; deps.edn
{:deps {clj-fsm {:mvn/version "RELEASE"}}}

Examples

You can see full examples here.

Development

# Run nREPL & connect from your IDE
$ make repl
nREPL server started on port 7888 on host localhost - nrepl://localhost:7888

Testing

# Run Clojure tests
$ make test-clj


# Run ClojureScript tests
$ make test-cljs


# Run Clojure & ClojureScript tests
$ make test

Deploy

# commit all changes then
# create a new git tag (available types `minor`, `major`)
$ make patch

# push a new git tag to Github then wait for GitHub Actions
# start to deploy the new version to clojars
$ git push origin --tags

Available commands

$ make help
help                           Show help
repl                           Run nREPL
clean                          Clean
lint                           Run linter
test-clj                       Run Clojure tests
test-cljs                      Run ClojureScript tests
test                           Run all tests
build                          Build jar
init                           Init first version
patch                          Increment patch version
minor                          Increment minor version
major                          Increment major version
deploy                         Deploy to clojars

Changelog

TBD

Can you improve this documentation?Edit on GitHub

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

× close