Liking cljdoc? Tell your friends :D

clindex.scanner

Scanner, provides functionality for scanning complete projects for a platform.

Starting from a deps.edn or project.clj project it can download all project dependencies, scan all source files inside local folders or jars and return a map of namespaces with tons of information about them. (See: :scanner/namespace spec)

Its main api consists of :

  • scan-all-projects
  • scan-namespace
  • scan-namespaces
Scanner, provides functionality for scanning complete projects for a platform.

Starting from a deps.edn or project.clj project it can download all project dependencies,
scan all source files inside local folders or jars and return a map of namespaces with tons
of information about them. (See: :scanner/namespace spec)

Its main api consists of :
- `scan-all-projects`
- `scan-namespace`
- `scan-namespaces`
raw docstring

*def-macro-set*clj


*def-private-set*clj


*def-public-set*clj


build-file->project-mapclj


data-readersclj


find-project-in-dirclj

(find-project-in-dir base-dir)

Given a base-dir path returns a project map with :project/name :project/dependencies and :paths (source paths)

Given a `base-dir` path returns a project map with :project/name :project/dependencies and :paths (source paths)
raw docstring

main-project-symbclj


scan-all-projectsclj

(scan-all-projects base-dir opts)

Given a base dir retrieves all projects (including base one) and all its dependencies. Returns a map like {proj-symb {:project/dependencies #{} :project/name proj-symb :project/files #{} :paths []}}

Given a base dir retrieves all projects (including base one) and all its dependencies.
Returns a map like {proj-symb {:project/dependencies #{}
                               :project/name proj-symb
                               :project/files #{}
                               :paths []}}
raw docstring

scan-namespaceclj

(scan-namespace ns-file-path all-projs {:keys [platform] :as opts})

scan-namespacesclj

(scan-namespaces all-projs {:keys [platform] :as opts})

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

× close