Liking cljdoc? Tell your friends :D

cljfmt.config

Configuration is provided by a map of keyword settings to values.

Config may be provided by a Clojure file named .cljfmt. These files files may be sprinkled about the file tree; each file applies configuration to the subtree rooted in the directory the file resides in, with deeper files merging and overriding their parents.

Configuration is provided by a map of keyword settings to values.

Config may be provided by a Clojure file named `.cljfmt`. These files files
may be sprinkled about the file tree; each file applies configuration to the
subtree rooted in the directory the file resides in, with deeper files
merging and overriding their parents.
raw docstring

default-configclj

source

default-indentsclj

Default indentation rules included with the library.

Default indentation rules included with the library.
sourceraw docstring

dir-configclj

(dir-config dir)

Return the map of cljfmt configuration from the file in the given directory, if it exists and is readable. Returns nil if the configuration is not present or is invalid.

Return the map of cljfmt configuration from the file in the given directory,
if it exists and is readable. Returns nil if the configuration is not present
or is invalid.
sourceraw docstring

directory?clj

(directory? file)

True if the given File represents a directory.

True if the given `File` represents a directory.
sourceraw docstring

file-nameclj

Name which indicates a cljfmt configuration file.

Name which indicates a cljfmt configuration file.
sourceraw docstring

find-parentsclj

(find-parents dir limit)

Search upwards from the given directory, collecting cljfmt configuration files. Returns a sequence of configuration maps read, with shallower paths ordered earlier.

The search will terminate after limit recursions or once it hits the filesystem root or a directory not owned by the user.

Search upwards from the given directory, collecting cljfmt configuration
files. Returns a sequence of configuration maps read, with shallower paths
ordered earlier.

The search will terminate after `limit` recursions or once it hits the
filesystem root or a directory not owned by the user.
sourceraw docstring

ignored?clj

(ignored? config file)

True if the file should be ignored.

True if the file should be ignored.
sourceraw docstring

merge-settingsclj

(merge-settings)
(merge-settings a)
(merge-settings a b)
(merge-settings a b & more)

Merge configuration maps together.

Merge configuration maps together.
sourceraw docstring

owner?clj

(owner? file)

True if the given File is owned by the current user.

True if the given `File` is owned by the current user.
sourceraw docstring

read-configclj

(read-config file)

Read a configuration file. Throws an exception if the read fails or the contents are not valid configuration settings.

Read a configuration file. Throws an exception if the read fails or the
contents are not valid configuration settings.
sourceraw docstring

readable-file?clj

(readable-file? file)

True if the given File is a regular file the process can read.

True if the given `File` is a regular file the process can read.
sourceraw docstring

source-file?clj

(source-file? config file)

True if the file is a recognized source file.

True if the file is a recognized source file.
sourceraw docstring

source-pathclj

(source-path config)

Return the path a given configuration map was read from.

Return the path a given configuration map was read from.
sourceraw docstring

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

× close