Functions to validate changelogs. Specifications referred from chlog.changelog-specifications.
See also Speculoos library documentation.
Functions to validate changelogs. Specifications referred from `chlog.changelog-specifications`. See also Speculoos library [documentation](https://github.com/blosavio/speculoos).
(all-changelog-collections-have-predicates? cf)Given changelog file cf, returns true if all collections in the changelog
data are paired with a predicate.
Note: You probably don't need this utility. Don't stress about every collection having a predicate, except for very simple situations.
Given changelog file `cf`, returns `true` if all collections in the changelog data are paired with a predicate. Note: You probably don't need this utility. Don't stress about every collection having a predicate, except for very simple situations.
(elide-datums v)Replace :datum validation entries v with '...' so that the viewing the
results are clearer.
Replace `:datum` validation entries `v` with '...' so that the viewing the results are clearer.
(valid-changelog? cf)Given changelog file cf, returns true if all scalars and all collections
satisfy their corresponding predicates. Otherwise, returns false.
See validate-changelog for a more details validation report.
Example:
(valid-changelog? changelog-pathfilename)
Given changelog file `cf`, returns `true` if all scalars and all collections satisfy their corresponding predicates. Otherwise, returns `false`. See [[validate-changelog]] for a more details validation report. Example: ```clojure (valid-changelog? changelog-pathfilename) ```
(validate-changelog cf)Given changelog file cf, returns a detailed validation report for all
scalars and all collections.
Example:
(validate-changelog changelog-pathfilename)
Use the following pattern to focus on invalid elements:
(only-invalid (validate-changelog ...))
See valid-changelog? for a terse validation summary.
Given changelog file `cf`, returns a detailed validation report for all scalars and all collections. Example: ```clojure (validate-changelog changelog-pathfilename) ``` Use the following pattern to focus on invalid elements: ```clojure (only-invalid (validate-changelog ...)) ``` See [[valid-changelog?]] for a terse validation summary.
(validate-changelog-collections cf)Given changelog file cf, returns invalid collections.
Example:
(validate-changelog-collections changelog-pathfilename)
For large data, use elide-datums like this:
(elide-datums (validate-changelog-collections changelog-pathfilename))
Given changelog file `cf`, returns invalid collections. Example: ```clojure (validate-changelog-collections changelog-pathfilename) ``` For large data, use [[elide-datums]] like this: ```clojure (elide-datums (validate-changelog-collections changelog-pathfilename)) ```
(validate-changelog-scalars cf)Given changelog file cf, returns only invalid scalar validation results. If
all scalars are valid, returns [], i.e., an empty sequential.
Example:
(validate-changelog-scalars changelog-pathfilename)
If the :datum entries are too verbose, use elide-datums with this
pattern:
(elide-datums (validate-changelog-scalars changelog-pathfilename))
Given changelog file `cf`, returns only invalid scalar validation results. If all scalars are valid, returns `[]`, i.e., an empty sequential. Example: ```clojure (validate-changelog-scalars changelog-pathfilename) ``` If the `:datum` entries are too verbose, use [[elide-datums]] with this pattern: ```clojure (elide-datums (validate-changelog-scalars changelog-pathfilename)) ```
(validate-one-version-collections cf idx)Given changelog file cf and index idx to a version, validates that
version's collections.
Note: idx is the index into the sequence of versions, but not necessarily
the version number.
See also validate-one-version-scalars.
Given changelog file `cf` and index `idx` to a version, validates that version's collections. Note: `idx` is the index into the sequence of versions, but not necessarily the version number. See also [[validate-one-version-scalars]].
(validate-one-version-scalars cf idx)Given index changelog file cf and index idx to a version, validates that
version's scalars.
Note: idx is the index into the sequence of versions, but not necessarily
the version number.
See also validate-one-version-collections.
Given index changelog file `cf` and index `idx` to a version, validates that version's scalars. Note: `idx` is the index into the sequence of versions, but not necessarily the version number. See also [[validate-one-version-collections]].
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 |