Liking cljdoc? Tell your friends :D

formatting-stack.background

This file live in a distinct source-paths so it's not affected by the Reloaded workflow, while developing formatting-stack itself.

This file live in a distinct source-paths so it's not affected by the Reloaded workflow,
while developing formatting-stack itself.
raw docstring

formatting-stack.branch-formatter

A set of defaults apt for formatting/linting a git branch (namely, the files that a branch has modified, respective to another).

See also: formatting-stack.defaults, formatting-stack.project-formatter

A set of defaults apt for formatting/linting a git branch
(namely, the files that a branch has modified, respective to another).

See also: `formatting-stack.defaults`, `formatting-stack.project-formatter`
raw docstring

formatting-stack.defaults

A set of defaults apt for frequent usage.

See also: formatting-stack.branch-formatter, formatting-stack.project-formatter

A set of defaults apt for frequent usage.

See also: `formatting-stack.branch-formatter`, `formatting-stack.project-formatter`
raw docstring

formatting-stack.formatters.no-extra-blank-lines

Ensures that no three consecutive newlines happen in a given file.

That can happen naturally, or because of other formatters' intricacies.

Ensures that no three consecutive newlines happen in a given file.

That can happen naturally, or because of other formatters' intricacies.
raw docstring

formatting-stack.formatters.trivial-ns-duplicates

This formatter removes 'trivial' duplicate libspecs from the ns form.

Compensates for some refactor-nrepl.clean-ns intricacies, and also provides .cljs compatibility.

This formatter removes 'trivial' duplicate libspecs from the `ns` form.

Compensates for some `refactor-nrepl.clean-ns` intricacies, and also provides .cljs compatibility.
raw docstring

formatting-stack.kondo-classpath-cache

Holds a cache for the entire classpath, to make better use of the project-wide analysis capabilities.

Only needs to be created once, as the classpath never changes.

Holds a cache for the entire classpath, to make better use of the project-wide analysis capabilities.

Only needs to be created once, as the classpath never changes.
raw docstring

formatting-stack.linters.one-resource-per-ns

This linter ensures that there's exactly once classpath resource per namespace and extension.

Note that generally it's fine to define identically-named Clojure/Script namespaces with different extensions, so that is allowed.

This linter ensures that there's exactly once classpath resource per namespace and extension.

Note that generally it's fine to define identically-named Clojure/Script namespaces with _different_ extensions,
so that is allowed.
raw docstring

formatting-stack.processors.test-runner

A test runner meant to be integrated with VCSs. JVM-only, and only clojure.test is targeted.

This test runner gathers Clojure ns's out of filenames, derives even more testing ns's out of them (via naming variations, project-wide :require analysis, and metadata analysis), and invokes #'clojure.test/run-tests out of that result.

A test runner meant to be integrated with VCSs. JVM-only, and only `clojure.test` is targeted.

This test runner gathers Clojure ns's out of filenames, derives _even more_ testing ns's out of them
(via naming variations, project-wide `:require` analysis, and metadata analysis),
and invokes `#'clojure.test/run-tests` out of that result.
raw docstring

formatting-stack.project-formatter

A set of defaults apt for formatting/linting a whole project.

See also: formatting-stack.branch-formatter, formatting-stack.defaults

A set of defaults apt for formatting/linting a whole project.

See also: `formatting-stack.branch-formatter`, `formatting-stack.defaults`
raw docstring

formatting-stack.reporters.file-writer

Writes the output to a file which can be observed with e.g. watch --color -n 1 cat .formatting-stack-report.

Writes the output to a file which can be observed with e.g. `watch --color -n 1 cat .formatting-stack-report`.
raw docstring

formatting-stack.reporters.pretty-line-printer

Outputs report similar to github.com/xojs/xo

Outputs report similar to github.com/xojs/xo
raw docstring

formatting-stack.reporters.pretty-printer

Prints an optionally colorized, indented, possibly truncated output of the reports.

Prints an optionally colorized, indented, possibly truncated output of the reports.
raw docstring

formatting-stack.strategies

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

Said filenames must satisfy the ::protocols.spec/filename spec, and represent an existing file.

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.

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

Said filenames must satisfy the `::protocols.spec/filename` spec, and represent an existing file.

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 `filter`ed.

A strategy may not return nil.
raw docstring

formatting-stack.strategies.impl.git-diff

Functions for git diff --name-status parsing.

Note that commands such as git status, git ls-files do not share its output format.

Functions for `git diff --name-status` parsing.

Note that commands such as `git status`, `git ls-files` do not share its output format.
raw docstring

formatting-stack.strategies.impl.git-status

Functions for git status parsing. Note that commands such as git diff, git ls-files do not share its output format.

Functions for `git status` parsing. Note that commands such as `git diff`, `git ls-files` do not share its output format.
raw docstring

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

× close