clojure-guardrails
Reference for Guardrails library with Malli in Clojure. Use when working with `>defn`, `>defn-`, `>def`, `>fdef` macros, gspec syntax, or function validation. Triggers on guardrails imports, `com.fulcrologic.guardrails.malli`, function specs with `=>` operator, or questions about runtime validation in Clojure.
Installation
Details
Usage
After installing, this skill will be available to your AI coding assistant.
Verify installation:
skills listSkill Instructions
name: clojure-guardrails
description: Reference for Guardrails library with Malli in Clojure. Use when working with >defn, >defn-, >def, >fdef macros, gspec syntax, or function validation. Triggers on guardrails imports, com.fulcrologic.guardrails.malli, function specs with => operator, or questions about runtime validation in Clojure.
Clojure Guardrails (Malli)
Detection
Check if guardrails is in use:
grep -r "guardrails.enabled" deps.edn shadow-cljs.edn 2>/dev/null
Setup
deps.edn:
{:deps {com.fulcrologic/guardrails {:mvn/version "1.2.16"}
metosin/malli {:mvn/version "0.20.0"}}
:aliases {:dev {:jvm-opts ["-Dguardrails.enabled=true"]}}}
See https://clojars.org/com.fulcrologic/guardrails for the latest version.
Enable at runtime: -Dguardrails.enabled=true
Import
(require '[com.fulcrologic.guardrails.malli.core :refer [>defn >defn- >def >fdef | ? =>]])
Core Macros
| Macro | Purpose |
|---|---|
>defn | Define function with inline spec |
>defn- | Private function with spec |
>def | Register malli schema |
>fdef | Declare spec without body |
? | Nilable shorthand [:maybe schema] |
| | "Such that" constraints |
=> | Separates args from return |
Gspec Syntax
[arg-specs* (| arg-preds+)? => ret-spec (| ret-preds+)?]
Basic:
(>defn add [a b]
[:int :int => :int]
(+ a b))
With constraints:
(>defn ranged-rand [start end]
[:int :int | #(< start end)
=> :int | #(>= % start) #(< % end)]
(+ start (long (rand (- end start)))))
Nilable:
(>defn find-user [id]
[:int => (? :map)]
(get users id))
Multi-arity:
(>defn greet
([name]
[:string => :string]
(str "Hello, " name))
([greeting name]
[:string :string => :string]
(str greeting ", " name)))
Variadic:
(>defn sum [x & more]
[:int [:* :int] => :int]
(apply + x more))
Map schemas:
(>defn process-user [user]
[[:map [:name :string] [:age :int]] => :string]
(str (:name user) " is " (:age user)))
Schema Registry
This is an optional feature.
(require '[com.fulcrologic.guardrails.malli.registry :as gr.reg])
;; Register schemas
(>def :user/name :string)
(>def :user/age :int)
(>def :user/record [:map :user/name :user/age])
;; Use in functions
(>defn get-user [id]
[:int => (? :user/record)]
(lookup id))
Detailed Reference
See gspec-syntax.md for complete syntax documentation.
More by Ramblurr
View allHigh-performance JSON and CSV parsing library for Clojure. Use when working with JSON or CSV data and need fast in Clojure, efficient parsing/writing with a clojure.data.json/clojure.data.csv compatible API.
Async programming with channels, go blocks, and CSP in Clojure. Use when working with async operations, channel communication, pub/sub patterns, concurrent pipelines, or CSP-style coordination.
Ring Jetty adapter for running ring-compatible web servers in Clojure. Use when you are working with ring and jetty starting and need to know to configure or interact with a ring jetty
Use this when you have completed some feature implementation and have written passing tests, and you are ready to create a PR.