formatting-stack.strategies — formatting-stack 0.5.1

Strategies are concerned with generating a seq of filenames to process (format, lint, or compile).

They are configured to run in a determinate order.

In practice, a strategy is function that receives a seq of filenames, and returns another:

• more filenames may be added; and or
• the passed filenames may be filtered.

A strategy may not return nil.

all-files clj

(all-files & {:keys [files]})

This strategy unconditionally processes all files.

do-not-use-cached-results! clj

(do-not-use-cached-results! & {:keys [files]})

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 .

exclude-cljs clj

(exclude-cljs & {:keys [files]})

This strategy excludes .cljs files; .cljc files are not excluded in any case.

exclusively-cljs clj

(exclusively-cljs & {:keys [files]})

This strategy excludes files not suffixed in .cljs or .cljc

files-with-a-namespace clj

(files-with-a-namespace & {:keys [files]})

This strategy excludes files that don't begin with a (ns ...) form.

git-completely-staged clj

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

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

git-diff-against-default-branch clj

(git-diff-against-default-branch
  &
  {:keys [target-branch impl files blacklist]
   :or {target-branch "master"
        impl (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.

git-not-completely-staged clj

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

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