(all-functions)
(all-functions project)
finds all the functions in the project
(all-functions)
finds all the functions in the project (all-functions)
(all-missing)
(all-missing project)
finds functions with missing tests in the project
(all-missing)
finds functions with missing tests in the project (all-missing)
(all-orphaned)
(all-orphaned project)
finds tests with missing functions in the project
(all-orphaned)
finds tests with missing functions in the project (all-orphaned)
(all-tests)
(all-tests project)
finds all unit tests in the project
(all-tests)
finds all unit tests in the project (all-tests)
(all-todos)
(all-todos project)
finds all todos of a particular namespace
(all-todos)
finds all todos of a particular namespace (all-todos)
(arrange)
(arrange ns)
(arrange ns project)
arranges tests so that vars are in correct order
;; arranges tests for current namespace (arrange)
;; arranges tests for specific namespace (arrange 'lucid.unit)
(arrange 'lucid.query.match.fn)
arranges tests so that vars are in correct order ;; arranges tests for current namespace (arrange) ;; arranges tests for specific namespace (arrange 'lucid.unit) (arrange 'lucid.query.match.fn)
(arrange-project)
(arrange-project project)
imports all unit tests in the project as docstrings
;; arranges all the unit tests in order of the functions (arrange-project)
imports all unit tests in the project as docstrings ;; arranges all the unit tests in order of the functions (arrange-project)
(exclude lookup exclusions)
helper function for excluding certain namespaces
(exclude '{lucid.legacy.analyzer :a lucid.legacy :a lucid.aether :b} ["lucid.legacy"]) => '{lucid.aether :b}
helper function for excluding certain namespaces (exclude '{lucid.legacy.analyzer :a lucid.legacy :a lucid.aether :b} ["lucid.legacy"]) => '{lucid.aether :b}
(import)
(import ns)
(import ns project)
(import ns lookup project)
imports unit tests as docstrings
;; import docstrings for the current namespace (import)
;; import docstrings for a given namespace (import 'lucid.unit)
imports unit tests as docstrings ;; import docstrings for the current namespace (import) ;; import docstrings for a given namespace (import 'lucid.unit)
(import-project)
(import-project project)
imports all unit tests int the project as docstrings
;; import docstrings for the entire project (import-project)
imports all unit tests int the project as docstrings ;; import docstrings for the entire project (import-project)
(in-order?)
(in-order? ns)
(in-order? ns project)
checks vars in the test file is in correct order
;; checks ordering for current namespace (in-order?)
;; checks ordering for specific namespace (in-order? 'lucid.unit)
checks vars in the test file is in correct order ;; checks ordering for current namespace (in-order?) ;; checks ordering for specific namespace (in-order? 'lucid.unit)
(missing)
(missing ns)
(missing ns project)
(missing ns lookup project)
checks functions that are missing in a given namespace
;; lists missing tests for current namespace (missing)
;; lists missing tests for specific namespace (missing 'lucid.unit)
checks functions that are missing in a given namespace ;; lists missing tests for current namespace (missing) ;; lists missing tests for specific namespace (missing 'lucid.unit)
(orphaned)
(orphaned ns)
(orphaned ns project)
(orphaned ns lookup project)
finds all unit tests that do not have functions
;; lists orphaned tests for current namespace (orphaned)
;; lists orphaned tests for specific namespace (orphaned 'lucid.unit)
finds all unit tests that do not have functions ;; lists orphaned tests for current namespace (orphaned) ;; lists orphaned tests for specific namespace (orphaned 'lucid.unit)
(project-stats functions {:keys [levels ns] :or {levels 2}})
automatic imports tests when files change
(project-stats (all-missing) {:levels 2 :ns true})
automatic imports tests when files change (project-stats (all-missing) {:levels 2 :ns true})
(purge)
(purge ns)
(purge ns project)
(purge ns lookup project)
purge docstrings and meta from file
;; removes docstrings for the current namespace
(purge)
;; removes docstrings for a given namespace (purge 'lucid.unit)
;; removes docstrings for the entire project (purge :all)
purge docstrings and meta from file ;; removes docstrings for the current namespace (purge) ;; removes docstrings for a given namespace (purge 'lucid.unit) ;; removes docstrings for the entire project (purge :all)
(scaffold)
(scaffold ns)
(scaffold ns project)
builds the unit test scaffolding for the source
;; generates test scaffolding for current namespace (scaffold)
;; generates test scaffolding for specific namespace (scaffold 'lucid.unit)
builds the unit test scaffolding for the source ;; generates test scaffolding for current namespace (scaffold) ;; generates test scaffolding for specific namespace (scaffold 'lucid.unit)
(scaffold-project)
(scaffold-project project)
scaffolds the extire project
;; generates test scaffolding for entire project (scaffold-project)
scaffolds the extire project ;; generates test scaffolding for entire project (scaffold-project)
(stats)
(stats selection)
(stats selection opts)
(stats selection project opts)
automatic imports tests when files change
(stats [:missing :orphaned] {:levels false}) ;; => {:missing {:total {:method 195, :ns 47}}, ;; :orphaned {:total {:method 27, :ns 10}}}
automatic imports tests when files change (stats [:missing :orphaned] {:levels false}) ;; => {:missing {:total {:method 195, :ns 47}}, ;; :orphaned {:total {:method 27, :ns 10}}}
(todos)
(todos ns)
(todos ns lookup project)
finds all todos of a particular namespace
(todos 'lucid.unit-test)
finds all todos of a particular namespace (todos 'lucid.unit-test)
(unwatch)
(unwatch {:keys [root] :as project})
removes the automatic watching and importing of tests
(unwatch)
removes the automatic watching and importing of tests (unwatch)
(watch)
(watch opts {:keys [root test-paths] :as project})
automatic imports tests when files change
(watch)
automatic imports tests when files change (watch)
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close