Skip to content

Latest commit

 

History

History
73 lines (46 loc) · 3.29 KB

README.md

File metadata and controls

73 lines (46 loc) · 3.29 KB
Raw

spec-alpha2

spec is a Clojure library to describe the structure of data and functions. Specs can be used to validate data, conform (destructure) data, explain invalid data, generate examples that conform to the specs, and automatically use generative testing to test functions.

For more information:

spec.alpha was released with Clojure 1.9 and can be found at https://github.com/clojure/spec.alpha. spec-alpha2 incorporates feedback from spec.alpha as well as work towards several new features. Please note that spec-alpha2 is not 100% API-compatible with spec.alpha (although it is similar).

Namespaces to load:

(require '[clojure.spec-alpha2 :as s]
         '[clojure.spec-alpha2.gen :as gen]
         '[clojure.spec-alpha2.test :as test])

Also see: Differences from spec.alpha

Releases and Dependency Information

Development release:

During development, you can use the git dep to try spec-alpha2:

clj -Sdeps '{:deps {org.clojure/clojure {:mvn/version "1.10.0"}
                    org.clojure/test.check {:mvn/version "0.9.0"} 
                    org.clojure/spec-alpha2 {:git/url "https://github.com/clojure/spec-alpha2.git" 
                                             :sha "<SHA>"}}}'

Where the latest SHA can be found with:

git ls-remote https://github.com/clojure/spec-alpha2.git refs/heads/master

Latest stable release: TBD

deps.edn dependency information:

org.clojure/spec-alpha2 {:mvn/version "TBD"}

Leiningen dependency information:

[org.clojure/spec-alpha2 "TBD"]

Maven dependency information:

<dependency>
  <groupId>org.clojure</groupId>
  <artifactId>spec-alpha2</artifactId>
  <version>TBD</version>
</dependency>

Developer Information

Copyright and License

Copyright (c) Rich Hickey, and contributors, 2018. All rights reserved. The use and distribution terms for this software are covered by the Eclipse Public License 1.0 (http://opensource.org/licenses/eclipse-1.0.php) which can be found in the file epl-v10.html at the root of this distribution. By using this software in any fashion, you are agreeing to be bound bythe terms of this license. You must not remove this notice, or any other, from this software.