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.
default-indentsclj
Default indentation rules included with the library.
Default indentation rules included with the library.
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.
directory?clj
(directory? file)True if the given File represents a directory.
True if the given `File` represents a directory.
file-nameclj
Name which indicates a cljfmt configuration file.
Name which indicates a cljfmt configuration file.
file?clj
(file? file)True if the given File represents a regular file.
True if the given `File` represents a regular file.
find-parentsclj
(find-parents start limit)Search upwards from the given directory, collecting cljfmt configuration files. Returns a sequence of configuration maps read, with shallower paths ordered earlier.
Note that the search begins with the parent of the starting file, so will
not include the configuration in start if it is a directory. The search
will terminate after limit recursions or once it hits the filesystem root
or a directory the user can't read.
Search upwards from the given directory, collecting cljfmt configuration files. Returns a sequence of configuration maps read, with shallower paths ordered earlier. Note that the search begins with the _parent_ of the starting file, so will not include the configuration in `start` if it is a directory. The search will terminate after `limit` recursions or once it hits the filesystem root or a directory the user can't read.
ignored?clj
(ignored? config file)True if the file should be ignored.
True if the file should be ignored.
merge-settingsclj
(merge-settings)(merge-settings a)(merge-settings a b)(merge-settings a b & more)Merge configuration maps together.
Merge configuration maps together.
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.
readable?clj
(readable? file)True if the process can read the given File.
True if the process can read the given `File`.
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.
source-pathsclj
(source-paths config)Return the sequence of paths the configuration map was merged from.
Return the sequence of paths the configuration map was merged from.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close