0.4.31 - document PROCEDURE

build.clj

@@ -3,7 +3,7 @@
             [deps-deploy.deps-deploy :as dd]))
 
 (def lib 'org.clojars.some/depo)
-(def version "0.4.30")
+(def version "0.4.31")
 (def jar-file (format "target/%s-%s.jar" (name lib) version))
 (def class-dir "target/classes")
 (def url "https://github.com/somecho/depo")

src/depo/core.clj

@@ -40,7 +40,7 @@
 (def CONFIGURATION
   {:command "depo"
    :description "Manage dependencies for Clojure projects easily"
-   :version "0.4.30"
+   :version "0.4.31"
    :opts [{:as "path to configuration file"
            :default nil
            :option "file"

src/depo/schema.clj

@@ -1,15 +1,25 @@
 (ns depo.schema
   (:require [malli.core :as m]))
 
-(def PROCEDURE [:map
-                [:zloc [:vector :any]]
-                [:dep-exists :boolean]
-                [:identifier :symbol]
-                [:argument :string]
-                [:project-type [:enum :lein :shadow :default]]
-                [:deps-type [:enum :map :vector]]
-                [:dep-data :any]
-                [:operation [:enum :add :remove :update]]])
+(def PROCEDURE
+  "A malli schema describing a map containing the following keys
+  - `:zloc` - a rewrite-clj zipper object of the dependencies
+  - `:dep-exists` - boolean - whether the dependency given exists in the config
+  - `:identifier` -  symbol - created by `depo.utils/create-identifier`
+  - `:argument` - string - the CLI argument
+  - `:project-type` - keyword - `:lein`, `:shadow` or `:default`
+  - `:deps-type` - keyword - `:map` or `:vector`
+  - `:dep-data` - the value returned from `depo.zoperations/get-dependency-data`
+  - `:operation` - keyword -`:add`, `:remove` or `:update`"
+  [:map
+   [:zloc [:vector :any]]
+   [:dep-exists :boolean]
+   [:identifier :symbol]
+   [:argument :string]
+   [:project-type [:enum :lein :shadow :default]]
+   [:deps-type [:enum :map :vector]]
+   [:dep-data :any]
+   [:operation [:enum :add :remove :update]]])
 
 (defn valid-id?
   "Returns `true` if the groupID or artifactID are valid IDs.