cljstyle.config
Configuration is provided by a map of keyword settings to values.
Config may be provided by a Clojure file named .cljstyle. 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 `.cljstyle`. 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.
canonical-dirclj
(canonical-dir path)Return the nearest canonical directory for the path. If path resolves to a file, the parent directory is returned.
Return the nearest canonical directory for the path. If path resolves to a file, the parent directory is returned.
default-configclj
Default configuration settings.
Default configuration settings.
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 cljstyle 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 cljstyle 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 cljstyle configuration file.
Name which indicates a cljstyle 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-upclj
(find-up start limit)Search upwards from a starting path, collecting cljstyle configuration files. Returns a sequence of configuration maps read, with shallower paths ordered earlier.
The search will include configuration in the starting path if it is a
directory, and will terminate after limit recursions or once it hits the
filesystem root or a directory the user can't read.
Search upwards from a starting path, collecting cljstyle configuration files. Returns a sequence of configuration maps read, with shallower paths ordered earlier. The search will include configuration in the starting path if it is a directory, and will terminate after `limit` recursions or once it hits the filesystem root or a directory the user can't read.
ignored?clj
(ignored? config ignores file)True if the file should be ignored.
True if the file should be ignored.
legacy-filesclj
A set of legacy files observed during config reading.
A set of legacy files observed during config reading.
legacy?clj
(legacy? config)True if the provided configuration map has legacy properties in it.
True if the provided configuration map has legacy properties in it.
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.
read-config*clj
(read-config* file)A 'raw' version of read-config that just loads the EDN in the file,
checking for syntax errors.
A 'raw' version of `read-config` that just loads the EDN in the file, checking for syntax errors.
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.
translate-legacyclj
(translate-legacy config)Convert a legacy config map into a modern one.
Convert a legacy config map into a modern one.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close