Liking cljdoc? Tell your friends :D

Optional typing in Clojure, as a library.

Usage Overview

tldr; see the minimal example project for Typed Clojure[Script] setup.

Typed Clojure is separated into modules. You'll want the full type checker at development time, and the runtime dependencies in production.

In Clojure CLI's deps.edn, this will look something like this:

{:deps {org.typedclojure/typed.clj.runtime {:mvn/version "1.0.26"}}
 :aliases {:dev {:extra-deps {org.typedclojure/typed.clj.checker {:mvn/version "1.0.26"}}}}}

You can then start a dev repl with clj -A:dev.

In Leiningen's project.clj, it will look something like this:

(defproject com.my-domain/a-project "1.0.0-SNAPSHOT"
  :dependencies [[org.typedclojure/typed.clj.runtime "1.0.26"]]
  :profiles {:dev {:dependencies [[org.typedclojure/typed.clj.checker "1.0.26"]]}})

Then, lein repl will automatically activate the :dev profile. Verify the type checker is not included in uberjars with lein with-profile uberjar deps :tree.

For ClojureScript support, use org.typedclojure/typed.cljs.runtime and org.typedclojure/typed.cljs.checker.

Example projects

  • minimal demonstrating how to statically type check Clojure[Script] namespaces
  • minimal-clj demonstrating how to statically type check (just) Clojure namespaces
  • malli-type-providers demonstrating how to statically type check using malli schemas
  • spec1-type-providers demonstrating how to statically type check using spec1 specs

Releases and Dependency Information

Latest stable release is 1.0.26.

See modules for specific version coordinates:

Clojure implementation

ClojureScript implementation

Implementation-agnostic

Library Annotations

Compatibility

Typed Clojure supports Clojure 1.11.0 and JDK 1.8+.

Mailing List and Chat

Use the core.typed mailing list for Typed Clojure discussion.

#core-typed on Clojurians Slack (most active, for short announcements and questions)

Archive for #core-typed Slack

#typedclojure on ZulipChat (for longer discussions due to threading and unlimited history)

Documentation

See wiki.

API Reference

Ambrose's blog

Leiningen Plugin

lein-typed

Vim Plugin

vim-typedclojure

Emacs Mode

typed-clojure-mode

Examples

core.async Rock-paper-scissors

Developer Information

Contributors

Thanks to the following people for contributing to core.typed:

  • Stephen Compall (S11001001)
  • Andrew Brehaut (brehaut)
  • Christopher Spencer (cspencer)
  • Reid McKenzie (arrdem)
  • Di Xu (xudifsd)
  • Nicola Mometto (Bronsa)
  • Chas Emerick (cemerick)
  • Jake Goulding (shepmaster)
  • Andy Fingerhut
  • Aravind K N (arav93)
  • Allen Rohner (arohner)
  • Minori Yamashita (ympbyc)
  • Kyle Kingsbury (aphyr)
  • Nathan Sorenson
  • Tobias Kortkamp (t6)
  • Alejandro Gomez (dialelo)
  • Piotr Jarzemski (kazuhiro)

Sponsors

Thanks to the following companies for their active sponsorship of Typed Clojure's development via OpenCollective.

YourKit

YourKit is kindly supporting core.typed and other open source projects with its full-featured Java Profiler. YourKit, LLC is the creator of innovative and intelligent tools for profiling Java and .NET applications. Take a look at YourKit's leading software products:

License

Copyright © Ambrose Bonnaire-Sergeant, Rich Hickey & contributors.

Licensed under the EPL (see the file epl-v10.html).

tools.analyzer

Copyright © Nicola Mometto, Rich Hickey & contributors.

Licensed under the EPL (see the file epl-v10.html).

tools.analyzer.jvm

Copyright © Nicola Mometto, Rich Hickey & contributors.

Licensed under the EPL (see the file epl-v10.html).

tools.analyzer.js

Copyright © Nicola Mometto, Rich Hickey & contributors.

Licensed under the EPL (see the file epl-v10.html).

Can you improve this documentation?Edit on GitHub

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

× close