Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/typedclojure/typedclojure

An optional type system for Clojure
https://github.com/typedclojure/typedclojure

Last synced: about 2 months ago
JSON representation

An optional type system for Clojure

Host: GitHub
URL: https://github.com/typedclojure/typedclojure
Owner: typedclojure
License: epl-1.0
Created: 2020-02-20T06:09:28.000Z (over 4 years ago)
Default Branch: main
Last Pushed: 2024-03-28T02:46:25.000Z (6 months ago)
Last Synced: 2024-04-13T23:48:38.942Z (5 months ago)
Language: Clojure
Size: 15.2 MB
Stars: 438
Watchers: 9
Forks: 6
Open Issues: 15
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


  

    

  





  

    

      

    

    

      

    

  



Optional typing in Clojure, as a library.

## Usage Overview

tldr; see the [minimal example project](example-projects/minimal) 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:

```clojure

{:deps {org.typedclojure/typed.clj.runtime {:mvn/version "1.2.1"}}

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

```

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

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

```clojure

(defproject com.my-domain/a-project "1.0.0-SNAPSHOT"

  :dependencies [[org.typedclojure/typed.clj.runtime "1.2.1"]]

  :profiles {:dev {:dependencies [[org.typedclojure/typed.clj.checker "1.2.1"]]}})

```

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](example-projects/minimal) demonstrates how to statically type check Clojure[Script] namespaces

- [minimal-clj](example-projects/minimal-clj) demonstrates how to statically type check (just) Clojure namespaces

- [malli-type-providers](example-projects/malli-type-providers) demonstrates how to statically type check using malli schemas

- [spec1-type-providers](example-projects/spec1-type-providers) demonstrates how to statically type check using spec1 specs

- [zero-deps](example-projects/zero-deps) demonstrates how to type check a library without introducing any runtime dependency on Typed Clojure (only dev-time).

- [symbolic-guide](example-projects/symbolic-guide) shows how to reason about symbolic execution in Typed Clojure.

## Releases and Dependency Information

Latest stable release is 1.2.1.

See modules for specific version coordinates:

### Clojure implementation

* [typed.clj.checker](typed/clj.checker/README.md): The JVM type checker

* [typed.clj.runtime](typed/clj.runtime/README.md): JVM Runtime dependencies

* [typed.clj.analyzer](typed/clj.analyzer/README.md): Analyzer for JVM Clojure

* [typed.clj.spec](typed/clj.spec/README.md): Type-like specs.

* [typed.malli](typed/malli/README.md): Malli integration.

### ClojureScript implementation

* [typed.cljs.analyzer](typed/cljs.analyzer/README.md): Analyzer for JS Clojure

* [typed.cljs.checker](typed/cljs.checker/README.md): The JS type checker

* [typed.cljs.runtime](typed/cljs.runtime/README.md): Runtime dependencies

### Implementation-agnostic

* [typed.cljc.analyzer](typed/cljc.analyzer/README.md): Implementation-agnostic base for Clojure analyzers

### Library Annotations

* [typed.lib.clojure](typed/lib.clojure/README.md): Base type annotations

* [typed.lib.core.async](typed/lib.core.async/README.md): Annotations for core.async

* [typed.lib.spec.alpha](typed/lib.spec.alpha/README.md): Annotations for spec.alpha

## Compatibility

Typed Clojure supports Clojure 1.12.0-beta1 and JDK 1.8+.

## Mailing List and Chat

Use the core.typed [mailing list](https://groups.google.com/forum/?fromgroups#!forum/clojure-core-typed) for Typed Clojure discussion.

[#core-typed on Clojurians Slack](https://clojurians.slack.com/app_redirect?channel=core-typed)

[Archive for #core-typed Slack](https://clojurians.zulipchat.com/#narrow/stream/180378-slack-archive/topic/core-typed)

## Documentation

See [wiki](https://github.com/clojure/core.typed/wiki).

[API Reference](https://api.typedclojure.org/latest/typed.clj.runtime/index.html)

[Ambrose's blog](https://blog.ambrosebs.com)

## Leiningen Plugin

[lein-typed](https://github.com/frenchy64/lein-typed)

## Vim Plugin

[vim-typedclojure](https://github.com/typedclojure/vim-typedclojure)

## Emacs Mode

[typed-clojure-mode](https://github.com/typedclojure/typed-clojure-mode)

## Examples

[core.async Rock-paper-scissors](typed/lib.core.async/test/typed_test/lib/clojure/core/async/rps_async_test.clj)

## Developer Information

- [Typed Clojure Contributor Code of Conduct](CODE_OF_CONDUCT.md)

- [Contributing guidelines](CONTRIBUTING.md)

## 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)

* Oleksandr Yakushev (alexander-yakushev)

* David Miller (dmiller)

## 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:

* YourKit Java Profiler and

* YourKit .NET Profiler.

## 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).