https://github.com/clojure/spec-alpha2

Clojure library to describe the structure of data and functions
https://github.com/clojure/spec-alpha2

Last synced: 3 days ago
JSON representation

Clojure library to describe the structure of data and functions

• Host: GitHub
• URL: https://github.com/clojure/spec-alpha2
• Owner: clojure
• License: epl-1.0
• Created: 2018-10-22T14:30:12.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-07-15T17:55:13.000Z (6 months ago)
• Last Synced: 2024-12-29T15:04:23.633Z (10 days ago)
• Language: Clojure
• Homepage:
• Size: 545 KB
• Stars: 305
• Watchers: 65
• Forks: 26
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
alpha.spec

========================================

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:

* Rationale - https://clojure.org/about/spec

* Guide - https://clojure.org/guides/spec (for spec.alpha, note namespaces and other differences below)

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

Namespaces to load:

    (require '[clojure.alpha.spec :as s]

             '[clojure.alpha.spec.gen :as gen]

             '[clojure.alpha.spec.test :as test])

Also see: [Differences from spec.alpha](https://github.com/clojure/spec-alpha2/wiki/Differences-from-spec.alpha)

Releases and Dependency Information

========================================

This library is a work in progress provided to gather feedback during development. Namespaces, apis, etc may change without warning. The HEAD may not always be stable (although it usually is).

During development, you can use the git dep to try alpha.spec:

    clj -Sdeps '{:deps {org.clojure/clojure {:mvn/version "1.10.1"}

                        org.clojure/test.check {:mvn/version "0.9.0"} 

                        org.clojure/alpha.spec {:git/url "https://github.com/clojure/spec-alpha2.git" 

                                                :sha ""}}}'

Where the latest SHA can be found with:

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

When we believe this library is ready for use, we will begin publishing releases to Maven central.

Developer Information

========================================

* [API docs](https://clojure.github.io/spec-alpha2/)

* [GitHub project](https://github.com/clojure/spec-alpha2)

* [Changelog](https://github.com/clojure/spec-alpha2/blob/master/CHANGES.md)

* [Bug Tracker](https://clojure.atlassian.net/browse/CLJ)

* [Continuous Integration](https://github.com/clojure/spec-alpha2/actions/workflows/test.yml)

Copyright and License

========================================

Copyright (c) Rich Hickey, and contributors, 2018-2023. All rights reserved.  The use and distribution terms for this software are covered by the Eclipse Public License 1.0 (https://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.