Liking cljdoc? Tell your friends :D

lucid.core.code


all-source-varsclj

(all-source-vars file)
(all-source-vars file {:keys [ns]})

Finds all the defn, defmulti and defmacro forms in code

(all-source-vars "src/lucid/core/code.clj") => '[analyse-file-fn analyse-file join-nodes source-namespace all-source-vars all-test-vars]

Finds all the `defn`, `defmulti` and `defmacro` forms in code

(all-source-vars "src/lucid/core/code.clj")
=> '[analyse-file-fn 
     analyse-file 
     join-nodes
     source-namespace
     all-source-vars 
    all-test-vars]
raw docstring

all-test-varsclj

(all-test-vars file)
(all-test-vars file {:keys [full]})

Finds all comment, fact and facts forms in code

(all-test-vars "test/lucid/core/code_test.clj") => (contains '#{analyse-file join-nodes source-namespace all-source-vars all-test-vars})

Finds all `comment`, `fact` and `facts` forms in code

(all-test-vars "test/lucid/core/code_test.clj")
=> (contains '#{analyse-file join-nodes
                source-namespace
                all-source-vars all-test-vars})
raw docstring

analyse-fileclj

(analyse-file path)
(analyse-file type path)

analyses a source or test file for information

(analyse-file "src/lucid/core/code.clj") => (contains-in {'lucid.core.code {'analyse-file {:source {:code string?, :line {:row number? :col number? :end-row number? :end-col number?}, :path "src/lucid/core/code.clj"}}}})

(analyse-file "test/lucid/core/code_test.clj") => (contains-in {'lucid.core.code {'analyse-file {:test {:code vector? :line {:row number? :col number? :end-row number? :end-col number?} :path "test/lucid/core/code_test.clj"}, :meta {:added "1.2"}, :intro "analyses a source or test file for information"}}})

analyses a source or test file for information

(analyse-file "src/lucid/core/code.clj")
=> (contains-in
    {'lucid.core.code
     {'analyse-file
      {:source {:code string?,
                :line {:row number?
                       :col number?
                       :end-row number?
                       :end-col number?},
                :path "src/lucid/core/code.clj"}}}})

(analyse-file "test/lucid/core/code_test.clj")
=> (contains-in
    {'lucid.core.code
    {'analyse-file
      {:test {:code vector?
              :line {:row number?
                       :col number?
                       :end-row number?
                       :end-col number?}
              :path "test/lucid/core/code_test.clj"},
       :meta {:added "1.2"},
       :intro "analyses a source or test file for information"}}})
raw docstring

analyse-file-fnclj

(analyse-file-fn path time)
(analyse-file-fn type path time)

helper function to be memoized to order to support analyse-fn

(analyse-file-fn "src/lucid/core/code.clj" :<last-modified-time>)

helper function to be memoized to order to support `analyse-fn`

(analyse-file-fn "src/lucid/core/code.clj" :<last-modified-time>)
raw docstring

analyse-file-fn*clj


join-nodesclj

(join-nodes docs)

joins nodes together from a test

(-> (analyse-file "test/lucid/core/code_test.clj") (get-in ['lucid.core.code 'analyse-file :test :code]) (join-nodes)) => string?

joins nodes together from a test

(-> (analyse-file "test/lucid/core/code_test.clj")
    (get-in ['lucid.core.code 'analyse-file :test :code])
    (join-nodes))
=> string?
raw docstring

source-namespaceclj

(source-namespace ns)

look up the source file, corresponding to the namespace

(source-namespace 'lucid.unit) => 'lucid.unit

(source-namespace 'lucid.unit-test) => 'lucid.unit

look up the source file, corresponding to the namespace

(source-namespace 'lucid.unit)
=> 'lucid.unit

(source-namespace 'lucid.unit-test)
=> 'lucid.unit
raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close