hara.code — hara/code 3.0.6

analyse clj

(analyse)

(analyse ns)

(analyse ns params)

(analyse ns params project)

(analyse ns params lookup project)

analyse either a source or test file

(analyse 'hara.code) ;;#code{:test {hara.code [analyse .... vars]}} => hara.code.framework.common.Entry

(analyse '#{hara.code} {:return :summary}) ;; {:errors 0, :warnings 0, :items 1, :results 1, :total 16} => map?

arrange clj

(arrange)

(arrange ns)

(arrange ns params)

(arrange ns params project)

(arrange ns params lookup project)

arranges the test corresponding to function order

(arrange {:print {:function false} :write false})

(arrange '[hara.code] {:print {:item true} :write false})

commented clj

(commented)

(commented ns)

(commented ns params)

(commented ns params project)

(commented ns params lookup project)

returns tests that are in comment blocks

(commented)

(commented '[hara.code])

docstrings clj

(docstrings)

(docstrings ns)

(docstrings ns params)

(docstrings ns params project)

(docstrings ns params lookup project)

returns docstrings

(docstrings '#{hara.code.unit} {:return :results}) ;;{:errors 0, :warnings 0, :items 1, :results 1, :total 14} => map?

find-usages clj

(find-usages)

(find-usages ns)

(find-usages ns params)

(find-usages ns params project)

(find-usages ns params lookup project)

find usages of a var

(find-usages '[hara.code] {:var 'hara.code.framework/analyse})

import clj

(import)

(import ns)

(import ns params)

(import ns params project)

(import ns params lookup project)

import docstrings from tests

(import {:write false})

(import {:full true :write false :print {:function false}})

(import '[hara.code.unit] {:print {:summary true :result true :item true} :write false})

in-order? clj

(in-order?)

(in-order? ns)

(in-order? ns params)

(in-order? ns params project)

(in-order? ns params lookup project)

checks if tests are in order

(in-order?)

(in-order? '[hara.code] {:print {:item true}})

incomplete clj

(incomplete)

(incomplete ns)

(incomplete ns params)

(incomplete ns params project)

(incomplete ns params lookup project)

both functions missing tests or tests with todos

(incomplete)

(incomplete '[hara.code] {:print {:item true}})

locate-code clj

(locate-code)

(locate-code ns)

(locate-code ns params)

(locate-code ns params project)

(locate-code ns params lookup project)

locates code base upon query

(locate-code '[hara.code] {:query '[ns | {:first :import}]})

missing clj

(missing)

(missing ns)

(missing ns params)

(missing ns params project)

(missing ns params lookup project)

checks for functions with missing tests

(missing)

(missing '[hara.core] {:print {:result false :summary false} :return :all})

ns-format clj

(ns-format)

(ns-format ns)

(ns-format ns params)

(ns-format ns params project)

(ns-format ns params lookup project)

refactors code based on given :edits

(refactor-code '[hara.code] {:edits []})

ns-rename clj

(ns-rename [old new] {:keys [write print] :as params} lookup project)

moves both src and test files of the package

(project/in-context (refactor '[hara.lib.aether hara.module.deps] {:print {:function true}}))

orphaned clj

(orphaned)

(orphaned ns)

(orphaned ns params)

(orphaned ns params project)

(orphaned ns params lookup project)

tests without corresponding source code

(orphaned)

(orphaned '[hara.code] {:print {:item true}})

pedantic clj

(pedantic)

(pedantic ns)

(pedantic ns params)

(pedantic ns params project)

(pedantic ns params lookup project)

returns tests that may be improved

(pedantic)

(pedantic '[hara.code])

purge clj

(purge)

(purge ns)

(purge ns params)

(purge ns params project)

(purge ns params lookup project)

removes docstrings from source code

(purge {:write false})

(purge {:full true :write false})

(purge '[hara.core.unit] {:return :summary :write false}) ;;{:items 38, :results 32, :deletes 1272, :total 169} => map?

refactor-code clj

(refactor-code)

(refactor-code ns)

(refactor-code ns params)

(refactor-code ns params project)

(refactor-code ns params lookup project)

refactors code based on given :edits

(refactor-code '[hara.code] {:edits []})

scaffold clj

(scaffold)

(scaffold ns)

(scaffold ns params)

(scaffold ns params project)

(scaffold ns params lookup project)

creates a scaffold for a new or existing set of tests

(scaffold {:write false})

(scaffold '[hara.code] {:print {:item true} :write false})

todos clj

(todos)

(todos ns)

(todos ns params)

(todos ns params project)

(todos ns params lookup project)

checks for tests with TODO as docstring

(todos)

(todos '[hara.core] {:print {:result false :summary false} :return :all})

transform-code clj

(transform-code)

(transform-code ns)

(transform-code ns params)

(transform-code ns params project)

(transform-code ns params lookup project)

helper function for any arbitrary transformation of text

(transform-code {:transform #(str % "\n\n\n\nhello world")}) ;; {:deletes 0, :inserts 5, :changed [arrange], :updated false} => map?

(transform-code '#{hara.code.unit} {:print {:summary true :result true :item true :function true} :transform #(str % "\n\n\n\nhello world") :full true})

unchecked clj

(unchecked)

(unchecked ns)

(unchecked ns params)

(unchecked ns params project)

(unchecked ns params lookup project)

returns tests without => checks

(unchecked)

(unchecked '[hara.code])

unclean clj

(unclean)

(unclean ns)

(unclean ns params)

(unclean ns params project)

(unclean ns params lookup project)

finds source code that has top-level comments

(unclean 'hara.code)

(unclean '[hara])

vars clj

(vars)

(vars ns)

(vars ns params)

(vars ns params project)

(vars ns params lookup project)

returns the list of vars in a namespace

(vars 'hara.code)

(vars 'hara.code {:sorted false})

(vars '#{hara.code} {:return #{:errors :summary}}) => (contains-in {:errors any :summary {:errors 0 :warnings 0 :items 1 :results 1 :total number?}})