You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<html><head><metacharset="UTF-8" /><title>Speculoos version 7-SNAPSHOT0</title><linkrel="stylesheet" type="text/css" href="css/default.css" /><linkrel="stylesheet" type="text/css" href="css/highlight.css" /><scripttype="text/javascript" src="js/highlight.min.js"></script><scripttype="text/javascript" src="js/jquery.min.js"></script><scripttype="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><divid="header"><h2>Generated by <ahref="https://github.com/weavejester/codox">Codox</a></h2><h1><ahref="index.html"><spanclass="project-title"><spanclass="project-name">Speculoos</span><spanclass="project-version">version 7-SNAPSHOT0</span></span></a></h1></div><divclass="sidebar primary"><h3class="no-link"><spanclass="inner">Project</span></h3><ulclass="index-link"><liclass="depth-1 current"><ahref="index.html"><divclass="inner">Index</div></a></li></ul><h3class="no-link"><spanclass="inner">Namespaces</span></h3><ul><liclass="depth-1"><divclass="no-link"><divclass="inner"><spanclass="tree"><spanclass="top"></span><spanclass="bottom"></span></span><span>speculoos</span></div></div></li><liclass="depth-2 branch"><ahref="speculoos.core.html"><divclass="inner"><spanclass="tree"><spanclass="top"></span><spanclass="bottom"></span></span><span>core</span></div></a></li><liclass="depth-2 branch"><ahref="speculoos.function-specs.html"><divclass="inner"><spanclass="tree"><spanclass="top"></span><spanclass="bottom"></span></span><span>function-specs</span></div></a></li><liclass="depth-2"><ahref="speculoos.utility.html"><divclass="inner"><spanclass="tree"><spanclass="top"></span><spanclass="bottom"></span></span><span>utility</span></div></a></li></ul><ulclass="index-link"><liclass="depth-1"><ahref="https://github.com/blosavio/speculoos">Project home</a></li></ul></div><divclass="namespace-index" id="content"><h1><spanclass="project-title"><spanclass="project-name">Speculoos</span><spanclass="project-version">version 7-SNAPSHOT0</span></span></h1><h5class="license">Released under the <ahref="https://opensource.org/license/mit">MIT License</a></h5><divclass="doc"><p>A library for validating Clojure data.</p></div><h2>Installation</h2><p>To install, add the following dependency to your project or build file:</p><preclass="deps">[com.sagevisuals/speculoos "version 7-SNAPSHOT0"]</pre><h2>Namespaces</h2><divclass="namespace"><h3><ahref="speculoos.core.html">speculoos.core</a></h3><divclass="doc"><divclass="markdown"><p>This namespace provides functions to validate Clojure data. They operate on any heterogeneous, arbitrarily-nested data structure.</p>
3
+
<html><head><metacharset="UTF-8" /><title>Speculoos version 7</title><linkrel="stylesheet" type="text/css" href="css/default.css" /><linkrel="stylesheet" type="text/css" href="css/highlight.css" /><scripttype="text/javascript" src="js/highlight.min.js"></script><scripttype="text/javascript" src="js/jquery.min.js"></script><scripttype="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><divid="header"><h2>Generated by <ahref="https://github.com/weavejester/codox">Codox</a></h2><h1><ahref="index.html"><spanclass="project-title"><spanclass="project-name">Speculoos</span><spanclass="project-version">version 7</span></span></a></h1></div><divclass="sidebar primary"><h3class="no-link"><spanclass="inner">Project</span></h3><ulclass="index-link"><liclass="depth-1 current"><ahref="index.html"><divclass="inner">Index</div></a></li></ul><h3class="no-link"><spanclass="inner">Namespaces</span></h3><ul><liclass="depth-1"><divclass="no-link"><divclass="inner"><spanclass="tree"><spanclass="top"></span><spanclass="bottom"></span></span><span>speculoos</span></div></div></li><liclass="depth-2 branch"><ahref="speculoos.core.html"><divclass="inner"><spanclass="tree"><spanclass="top"></span><spanclass="bottom"></span></span><span>core</span></div></a></li><liclass="depth-2 branch"><ahref="speculoos.function-specs.html"><divclass="inner"><spanclass="tree"><spanclass="top"></span><spanclass="bottom"></span></span><span>function-specs</span></div></a></li><liclass="depth-2"><ahref="speculoos.utility.html"><divclass="inner"><spanclass="tree"><spanclass="top"></span><spanclass="bottom"></span></span><span>utility</span></div></a></li></ul><ulclass="index-link"><liclass="depth-1"><ahref="https://github.com/blosavio/speculoos">Project home</a></li></ul></div><divclass="namespace-index" id="content"><h1><spanclass="project-title"><spanclass="project-name">Speculoos</span><spanclass="project-version">version 7</span></span></h1><h5class="license">Released under the <ahref="https://opensource.org/license/mit">MIT License</a></h5><divclass="doc"><p>A library for validating Clojure data.</p></div><h2>Installation</h2><p>To install, add the following dependency to your project or build file:</p><preclass="deps">[com.sagevisuals/speculoos "version 7"]</pre><h2>Namespaces</h2><divclass="namespace"><h3><ahref="speculoos.core.html">speculoos.core</a></h3><divclass="doc"><divclass="markdown"><p>This namespace provides functions to validate Clojure data. They operate on any heterogeneous, arbitrarily-nested data structure.</p>
4
4
</div></div><divclass="index"><p>Public variables and functions:</p><ul><li><ahref="speculoos.core.html#var-all-paths">all-paths</a></li><li><ahref="speculoos.core.html#var-clamp">clamp</a></li><li><ahref="speculoos.core.html#var-only-invalid">only-invalid</a></li><li><ahref="speculoos.core.html#var-only-valid">only-valid</a></li><li><ahref="speculoos.core.html#var-ordinal-get">ordinal-get</a></li><li><ahref="speculoos.core.html#var-ordinal-get-in">ordinal-get-in</a></li><li><ahref="speculoos.core.html#var-recover-literal-path">recover-literal-path</a></li><li><ahref="speculoos.core.html#var-reduce-indexed">reduce-indexed</a></li><li><ahref="speculoos.core.html#var-valid-collections.3F">valid-collections?</a></li><li><ahref="speculoos.core.html#var-valid-macro.3F">valid-macro?</a></li><li><ahref="speculoos.core.html#var-valid-scalars.3F">valid-scalars?</a></li><li><ahref="speculoos.core.html#var-valid.3F">valid?</a></li><li><ahref="speculoos.core.html#var-validate">validate</a></li><li><ahref="speculoos.core.html#var-validate-collections">validate-collections</a></li><li><ahref="speculoos.core.html#var-validate-macro-with">validate-macro-with</a></li><li><ahref="speculoos.core.html#var-validate-scalars">validate-scalars</a></li><li><ahref="speculoos.core.html#var-validate-with-path-spec">validate-with-path-spec</a></li></ul></div></div><divclass="namespace"><h3><ahref="speculoos.function-specs.html">speculoos.function-specs</a></h3><divclass="doc"><divclass="markdown"><p>This namespace provides facilities to apply specifications to and validate functions. Roughly speaking, trying to replicate the instrumentation and testing capabilities of <ahref="https://clojure.org/guides/spec#_instrumentation_and_testing">spec.alpha</a> .</p>
5
5
</div></div><divclass="index"><p>Public variables and functions:</p><ul><li><ahref="speculoos.function-specs.html#var-assoc-metadata-f.21">assoc-metadata-f!</a></li><li><ahref="speculoos.function-specs.html#var-dissoc-metadata-f.21">dissoc-metadata-f!</a></li><li><ahref="speculoos.function-specs.html#var-exercise-fn">exercise-fn</a></li><li><ahref="speculoos.function-specs.html#var-inject-specs.21">inject-specs!</a></li><li><ahref="speculoos.function-specs.html#var-instrument">instrument</a></li><li><ahref="speculoos.function-specs.html#var-recognized-spec-keys">recognized-spec-keys</a></li><li><ahref="speculoos.function-specs.html#var-unject-specs.21">unject-specs!</a></li><li><ahref="speculoos.function-specs.html#var-unstrument">unstrument</a></li><li><ahref="speculoos.function-specs.html#var-validate-argument-return-relationship">validate-argument-return-relationship</a></li><li><ahref="speculoos.function-specs.html#var-validate-fn">validate-fn</a></li><li><ahref="speculoos.function-specs.html#var-validate-fn-with">validate-fn-with</a></li><li><ahref="speculoos.function-specs.html#var-validate-higher-order-fn">validate-higher-order-fn</a></li><li><ahref="speculoos.function-specs.html#var-wrapping-fn">wrapping-fn</a></li></ul></div></div><divclass="namespace"><h3><ahref="speculoos.utility.html">speculoos.utility</a></h3><divclass="doc"><divclass="markdown"><p>Utility functions to make using and interacting with Speculoos nicer.</p>
6
6
</div></div><divclass="index"><p>Public variables and functions:</p><ul><li><ahref="speculoos.utility.html#var-*ordinal-offset*">*ordinal-offset*</a></li><li><ahref="speculoos.utility.html#var-*such-that-max-tries*">*such-that-max-tries*</a></li><li><ahref="speculoos.utility.html#var-.3D10th">=10th</a></li><li><ahref="speculoos.utility.html#var-.3D11th">=11th</a></li><li><ahref="speculoos.utility.html#var-.3D12th">=12th</a></li><li><ahref="speculoos.utility.html#var-.3D1st">=1st</a></li><li><ahref="speculoos.utility.html#var-.3D2nd">=2nd</a></li><li><ahref="speculoos.utility.html#var-.3D3rd">=3rd</a></li><li><ahref="speculoos.utility.html#var-.3D4th">=4th</a></li><li><ahref="speculoos.utility.html#var-.3D5th">=5th</a></li><li><ahref="speculoos.utility.html#var-.3D6th">=6th</a></li><li><ahref="speculoos.utility.html#var-.3D7th">=7th</a></li><li><ahref="speculoos.utility.html#var-.3D8th">=8th</a></li><li><ahref="speculoos.utility.html#var-.3D9th">=9th</a></li><li><ahref="speculoos.utility.html#var-all-specs-okay">all-specs-okay</a></li><li><ahref="speculoos.utility.html#var-apathetic">apathetic</a></li><li><ahref="speculoos.utility.html#var-basic-collection-spec-from-data">basic-collection-spec-from-data</a></li><li><ahref="speculoos.utility.html#var-clamp-every">clamp-every</a></li><li><ahref="speculoos.utility.html#var-clamp-in*">clamp-in*</a></li><li><ahref="speculoos.utility.html#var-collections-without-predicates">collections-without-predicates</a></li><li><ahref="speculoos.utility.html#var-data-from-spec">data-from-spec</a></li><li><ahref="speculoos.utility.html#var-defpred">defpred</a></li><li><ahref="speculoos.utility.html#var-exercise">exercise</a></li><li><ahref="speculoos.utility.html#var-in.3F">in?</a></li><li><ahref="speculoos.utility.html#var-inspect-fn">inspect-fn</a></li><li><ahref="speculoos.utility.html#var-lazy-seq.3F">lazy-seq?</a></li><li><ahref="speculoos.utility.html#var-non-predicates">non-predicates</a></li><li><ahref="speculoos.utility.html#var-pred-sym-.3Egen-sym">pred-sym->gen-sym</a></li><li><ahref="speculoos.utility.html#var-predicate-.3Egenerator">predicate->generator</a></li><li><ahref="speculoos.utility.html#var-predicates-without-collections">predicates-without-collections</a></li><li><ahref="speculoos.utility.html#var-predicates-without-scalars">predicates-without-scalars</a></li><li><ahref="speculoos.utility.html#var-scalars-with-predicates">scalars-with-predicates</a></li><li><ahref="speculoos.utility.html#var-scalars-without-predicates">scalars-without-predicates</a></li><li><ahref="speculoos.utility.html#var-seq-regex">seq-regex</a></li><li><ahref="speculoos.utility.html#var-sore-thumb">sore-thumb</a></li><li><ahref="speculoos.utility.html#var-spec-from-data">spec-from-data</a></li><li><ahref="speculoos.utility.html#var-swap-non-predicates">swap-non-predicates</a></li><li><ahref="speculoos.utility.html#var-thoroughly-valid-collections.3F">thoroughly-valid-collections?</a></li><li><ahref="speculoos.utility.html#var-thoroughly-valid-scalars.3F">thoroughly-valid-scalars?</a></li><li><ahref="speculoos.utility.html#var-thoroughly-valid.3F">thoroughly-valid?</a></li><li><ahref="speculoos.utility.html#var-unfindable-generators">unfindable-generators</a></li><li><ahref="speculoos.utility.html#var-validate-predicate-.3Egenerator">validate-predicate->generator</a></li></ul></div></div></div></body></html>
<htmllang="en"><head><linkhref="project.css" rel="stylesheet" type="text/css"><title>Speculoos — check `prettyfy` settings</title><metacharset="utf-8" compile-date="2024-12-02 19:22:55" content="width=device-width, initial-scale=1" name="viewport"></head><body><article><h1>Speculoos <code>prettyfy</code> check</h1><p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p><pre><code>(+ 1 2 3) ;; => 6</code><br><br><code>(map inc [11 22 33]) ;; => (12 23 34)</code><br><br><code>(defn foo [x y] (vector x y (+ x y) (* x y)))</code></pre><h2><code>all-paths</code></h2><p>Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.</p><pre><code>(require '[speculoos.core :refer [all-paths]])</code><br><br><code>(all-paths [42 :foo 22/7])
;; {:datum 22/7, :path [:c], :predicate ratio?, :valid? true}]</code></pre><h2><code>validate-collections</code></h2><p>Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p><pre><code>(require '[speculoos.core :refer [validate-collections]])</code><br><br><code>(validate-collections [11 [22 [33]]]
;; :valid? true})</code></pre><h2><code>valid-scalars?</code> and <code>valid-collections?</code></h2><p>Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p><pre><code>(require '[speculoos.core :refer [valid-scalars? valid-collections?]])</code><br><br><code>(valid-scalars? [42 :foo 22/7]
0 commit comments