File system and environment edge: globbing source files, reading them,
resolving #include, and remembering namespace timings, run times and
parsed namespace infos between runs. Everything here
hands plain data to the pure core.
File system and environment edge: globbing source files, reading them, resolving `#include`, and remembering namespace timings, run times and parsed namespace infos between runs. Everything here hands plain data to the pure core.
(clojure-files dirs)Relative paths of the .clj and .cljc files under dirs, sorted and
without duplicates. Missing directories are skipped.
Relative paths of the .clj and .cljc files under `dirs`, sorted and without duplicates. Missing directories are skipped.
(edn-safe? v)True when v prints as EDN that reads back equal, so it can be cached.
True when `v` prints as EDN that reads back equal, so it can be cached.
(ensure-cache-dir! dir)Create the cache directory dir if it is missing, with a .gitignore
of * so version control skips it, as pytest does for its cache. An
existing directory is left alone, so its .gitignore is never touched.
Create the cache directory `dir` if it is missing, with a `.gitignore` of `*` so version control skips it, as pytest does for its cache. An existing directory is left alone, so its `.gitignore` is never touched.
(environment)Environment the config reader may consult: env vars, system properties, host and user names, CPU count, and whether this is babashka.
Environment the config reader may consult: env vars, system properties, host and user names, CPU count, and whether this is babashka.
Where the last runs' wall times are kept, per mode
(volley.runtime/record-run).
Where the last runs' wall times are kept, per mode (`volley.runtime/record-run`).
(include-resolver config-file)An #include resolver for volley.config/read-config: paths are
relative to the including file's directory (the top-level file is
config-file), as Aero's default resolver does. Returns nil for a
missing file.
An `#include` resolver for `volley.config/read-config`: paths are relative to the including file's directory (the top-level file is `config-file`), as Aero's default resolver does. Returns nil for a missing file.
(mtime-snapshot dirs files keep?)Modification times, {relative-path millis}, of the files under dirs
plus the existing files, for volley.watch/changes. Directories whose
name starts with a dot are not entered. keep? takes a path and decides
whether to include a file (volley.watch/watched-file?).
Modification times, `{relative-path millis}`, of the files under `dirs`
plus the existing `files`, for `volley.watch/changes`. Directories whose
name starts with a dot are not entered. `keep?` takes a path and decides
whether to include a file (`volley.watch/watched-file?`).Where the namespace infos of the last run's files are kept.
Where the namespace infos of the last run's files are kept.
(read-file path)File contents as a string, or nil when it cannot be read.
File contents as a string, or nil when it cannot be read.
(read-history)What write-history! saved, {:in-process-ms [ms ...] :workers-ms [ms ...] :workers-streak n}, any key possibly absent; empty when absent or
unreadable.
What `write-history!` saved, `{:in-process-ms [ms ...] :workers-ms [ms
...] :workers-streak n}`, any key possibly absent; empty when absent or
unreadable.(read-ns-info-cache)What write-ns-info-cache! saved, {:parser key :files {path entry}}
(volley.ns-cache); empty when absent or unreadable.
What `write-ns-info-cache!` saved, `{:parser key :files {path entry}}`
(`volley.ns-cache`); empty when absent or unreadable.(read-timings)Durations saved by the last run, {ns-sym millis}; empty when absent or
unreadable.
Durations saved by the last run, `{ns-sym millis}`; empty when absent or
unreadable.(run-info)Where and when a run starts, for its JUnit report: :cwd, and
:timestamp, now as an ISO local date-time to the second, as
kaocha-junit-xml writes its timestamps.
Where and when a run starts, for its JUnit report: `:cwd`, and `:timestamp`, now as an ISO local date-time to the second, as kaocha-junit-xml writes its timestamps.
(sha256 text)Hex SHA-256 of text's UTF-8 bytes.
Hex SHA-256 of `text`'s UTF-8 bytes.
Where per-namespace durations are kept between runs.
Where per-namespace durations are kept between runs.
(write-cache-file! path text)Write text to the cache file path, creating its directory with
ensure-cache-dir!. The text goes to a temporary file beside it that
then replaces path in one move, so a run reading the file, or one
killed while writing it, never sees part of it. Failure to write is not
an error.
Write `text` to the cache file `path`, creating its directory with `ensure-cache-dir!`. The text goes to a temporary file beside it that then replaces `path` in one move, so a run reading the file, or one killed while writing it, never sees part of it. Failure to write is not an error.
(write-file! path text)Write text to path, creating its directory. Returns nil, or the
error message when it could not be written.
Write `text` to `path`, creating its directory. Returns nil, or the error message when it could not be written.
(write-history! history)Save history for the next run. Failure to write is not an error.
Save `history` for the next run. Failure to write is not an error.
(write-ns-info-cache! cache)Save cache for the next run. Failure to write is not an error.
Save `cache` for the next run. Failure to write is not an error.
(write-timings! timings)Save timings for the next run. Failure to write is not an error.
Save `timings` for the next run. Failure to write is not an error.
cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |