Liking cljdoc? Tell your friends :D

formatting-stack.strategies


all-filesclj

(all-files)

This strategy unconditionally processes all files. Requires the tree binary to be installed.

This strategy unconditionally processes all files. Requires the `tree` binary to be installed.
raw docstring

do-not-use-cached-results!clj

(do-not-use-cached-results!)

Normally, subsequent 'members' (formatters, linters, compilers) using identical strategies will cache the results of those strategies. That is apt for formatters that do safe modifications, but not for more dangerous formatters.

By adding this empty strategy, it is signaled that the member using it should not use a cached result.

You can find a detailed explanation/example in https://git.io/fh7E0 .

Normally, subsequent 'members' (formatters, linters, compilers) using identical strategies will cache the results of those strategies.
That is apt for formatters that do safe modifications, but not for more dangerous formatters.

By adding this empty strategy, it is signaled that the member using it should not use a cached result.

You can find a detailed explanation/example in https://git.io/fh7E0 .
raw docstring

git-completely-stagedclj

(git-completely-staged
  &
  {:keys [files] :or {files (impl/file-entries "git" "status" "--porcelain")}})

This strategy processes the new or modified files that are completely staged with git.

This strategy processes the new or modified files that are _completely_ staged with git.
raw docstring

git-diff-against-default-branchclj

(git-diff-against-default-branch
  &
  {:keys [target-branch files blacklist]
   :or {target-branch "master"
        files (impl/file-entries "git" "diff" "--name-only" target-branch)
        blacklist (git-not-completely-staged)}})

This strategy processes all files that this branch has modified. The diff is compared against the :target-branch option.

This strategy processes all files that this branch has modified.
The diff is compared against the `:target-branch` option.
raw docstring

git-not-completely-stagedclj

(git-not-completely-staged
  &
  {:keys [files] :or {files (impl/file-entries "git" "status" "--porcelain")}})

This strategy processes all files that are not completely staged with git. Untracked files are also included.

This strategy processes all files that are not _completely_ staged with git. Untracked files are also included.
raw docstring

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

× close