Liking cljdoc? Tell your friends :D

noahtheduke.splint.runner

Handles parsing and linting all of given files.

Handles parsing and linting all of given files.
raw docstring

build-result-mapclj

(build-result-map ctx files)
source

check-all-rules-of-typeclj

(check-all-rules-of-type ctx rules form)

For each rule: if the rule is enabled, call check-rule. If check-rule returns a non-nil result, add or append it to the accumulator. Otherwise, return the accumulator.

For each rule: if the rule is enabled, call `check-rule`.
If `check-rule` returns a non-nil result, add or append it to the accumulator.
Otherwise, return the accumulator.
sourceraw docstring

check-and-recurclj

(check-and-recur ctx rules-by-type filename parent-form form)

Check a given form and then map recur over each of the form's children.

Check a given form and then map recur over each of the form's children.
sourceraw docstring

check-files!clj

(check-files! ctx rules-by-type files)

Call into the relevant check-path-X function, depending on the given config.

Call into the relevant `check-path-X` function, depending on the given config.
sourceraw docstring

check-files-parallelclj

(check-files-parallel ctx rules-by-type files)
source

check-files-serialclj

(check-files-serial ctx rules-by-type files)
source

check-formclj

(check-form ctx rules form)

Checks a given form against the appropriate rules then calls on-match to build the diagnostic and store it in ctx.

Checks a given form against the appropriate rules then calls `on-match` to build the
diagnostic and store it in `ctx`.
sourceraw docstring

check-patternclj

(check-pattern ctx rule pattern form)

Call :pattern on the form and if it hits, call :on-match on it.

Only attach parent-form to the metadata after :pattern is true, cuz parent-form can be potentially massive.

This has implications for pattern writing, where predicates can't rely on that metadata to exist.

Call `:pattern` on the form and if it hits, call `:on-match` on it.

Only attach `parent-form` to the metadata after `:pattern` is true, cuz
`parent-form` can be potentially massive.

This has implications for pattern writing, where predicates can't rely
on that metadata to exist.
sourceraw docstring

check-ruleclj

(check-rule ctx rule form)

Rules either have :pattern or :patterns defined, never both. To avoid iteration and seq manipulation costs, handle them separately.

Use reduced to early exit when checking multiple patterns as we don't want to create multiple diagnostics for a single form and rule.

Rules either have `:pattern` or `:patterns` defined, never both.
To avoid iteration and seq manipulation costs, handle them separately.

Use `reduced` to early exit when checking multiple patterns as we don't
want to create multiple diagnostics for a single form and rule.
sourceraw docstring

exception->ex-infoclj

(exception->ex-info ex data)
source

get-extensionclj

(get-extension file)
source

parse-and-check-fileclj

(parse-and-check-file ctx
                      rules-by-type
                      {:keys [ext file contents] :as file-obj})

Parse the given file and then check each form.

Parse the given file and then check each form.
sourceraw docstring

pre-filter-rulesclj

(pre-filter-rules ctx rules-by-type)

Fully remove disabled rules or rules that don't apply to the current filetype.

Fully remove disabled rules or rules that don't apply to the current filetype.
sourceraw docstring

prepare-contextclj

(prepare-context rules config)
source

prepare-rulesclj

(prepare-rules config rules)
source

resolve-files-from-pathsclj

(resolve-files-from-paths ctx paths)
source

right-ext?clj

(right-ext? ext rule)
source

right-path?clj

(right-path? ctx rule)
source

runclj

(run args)

Convert command line args to usable options, pass to runner, print output.

Convert command line args to usable options, pass to runner, print output.
sourceraw docstring

run-implclj

(run-impl paths config)
(run-impl paths config rules)

Actually perform check

Actually perform check
sourceraw docstring

runner-error->diagnosticclj

(runner-error->diagnostic ex)
source

slurp-fileclj

(slurp-file file-obj)
source

support-clojure-version?clj

(support-clojure-version? config rule)
source

update-rulesclj

(update-rules rules-by-type form)
source

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

× close