clojure-lib-template

A template for creating a Clojure library.

Features

• Modern Clojure library project structure following best practices
• Built-in GitHub Actions workflows for CI/CD with publishing to Clojars
• Comprehensive development tooling setup (linting, formatting, deps versions, testing)
• Preconfigured build and deployment to Clojars using Slim
• Includes common development tasks via Babashka Tasks
• MIT License by default

Usage

1. Create a new Clojure library using Clojure CLI:

   clojure -Ttools install-latest :lib io.github.seancorfield/deps-new :as new
   clojure -Sdeps '{:override-deps {org.clojure/clojure {:mvn/version "1.12.0"}}}' -Tnew create :template io.github.abogoyavlensky/clojure-lib-template :name io.github.myusername/myproject

   Or alternatively using neil:

   brew install babashka/brew/neil
   neil new io.github.abogoyavlensky/clojure-lib-template io.github.myusername/myproject

2. Update the project configuration:

   • Edit library build details in deps.edn
   • Edit documentation in README.md

3. Start development:

   # Show all available tasks
   bb tasks
   # Run all checks
   bb check
   # Install library locally
   bb install  
   # Deploy snapshot to Clojars
   bb deploy-snapshot
   # Deploy to Clojars
   bb deploy-release

Project structure

The template generates a standard Clojure library project with the following structure:

├── .clj-kondo/            # Clojure linting configuration
├── .github/               # GitHub Actions workflows and configurations
├── dev/                   # Development configuration directory
│   └── user.clj           # User-specific development configuration
├── src/                   # Source code directory
│   └── {{name}}           # Main namespace directory
│       └── core.clj       # Main namespace file
├── test/                  # Test files directory
│   └── {{name}}           # Test namespace directory
│       └── core_test.clj  # Test namespace file
├── .cljfmt.edn            # Formatting configuration
├── .gitignore             # Git ignore rules
├── .mise.toml             # mise-en-place configuration with system tools versions
├── bb.edn                 # Babashka tasks configuration
├── deps.edn               # Clojure dependencies and aliases
├── LICENSE                # License file
├── CHANGELOG.md           # Changelog file
└── README.md              # Project documentation

Development

Requirements

To work with this template, you need:

1. mise (recommended) or manual installation of:
   • Java
   • Clojure
   • Babashka

Getting Started

All management tasks:

bb tasks
The following tasks are available:

test    Run tests for the template config
new     Create a new project
release Create and push a new git tag based on provided version

After you updated the template and ran tests bb test, you can create a new project to check if everything works as expected:

bb new

The new project will be created in the tmpl directory at the root.

Release

Once you are ready to release a new version of the template, bump version in deps.edn:

:aliases -> :build -> :exec-args -> :version -> "0.1.1

and then run the following command:

bb release 

A new git tag based on latest version will be created and pushed to the repository.

License

MIT License Copyright (c) 2025 Andrey Bogoyavlenskiy