lice-comb.files
Functionality related to combing files, directories, and ZIP format archives for license information.
Functionality related to combing files, directories, and ZIP format archives for license information.
dir->expressionsclj
(dir->expressions dir)(dir->expressions dir opts)Returns a set of SPDX expressions (Strings) for the given dir (a String or a File, which must refer to a readable directory), or nil if no expressions were found.
The optional opts map has these keys:
include-zips?(boolean, default false) - controls whether zip compressed files found in the directory are recursively included in the scan or not
Returns a set of SPDX expressions (Strings) for the given dir (a String or a File, which must refer to a readable directory), or nil if no expressions were found. The optional `opts` map has these keys: * `include-zips?` (boolean, default false) - controls whether zip compressed files found in the directory are recursively included in the scan or not
dir->expressions-infoclj
(dir->expressions-info dir)(dir->expressions-info dir {:keys [include-zips?] :or {include-zips? false}})Returns an expressions-info map for the given dir (a String or a File, which must refer to a readable directory), or nil if no expressions were found.
The optional opts map has these keys:
include-zips?(boolean, default false) - controls whether zip compressed files found in the directory are recursively included in the scan or not
Note: logs and ignores errors (XML parsing errors, ZIP file errors)
Returns an expressions-info map for the given dir (a String or a File, which must refer to a readable directory), or nil if no expressions were found. The optional `opts` map has these keys: * `include-zips?` (boolean, default false) - controls whether zip compressed files found in the directory are recursively included in the scan or not Note: logs and ignores errors (XML parsing errors, ZIP file errors)
file->expressionsclj
(file->expressions f)(file->expressions f filepath)Returns a set of SPDX expressions (Strings) for the given file (an InputStream or something that can have an io/input-stream opened on it), or nil if no expressions were found.
If an InputStream is provided, it is the caller's responsibility to open and close it, and a filepath associated with the InputStream must be provided as the second parameter (it is optional for other types of input).
Returns a set of SPDX expressions (Strings) for the given file (an InputStream or something that can have an io/input-stream opened on it), or nil if no expressions were found. If an InputStream is provided, it is the caller's responsibility to open and close it, and a filepath associated with the InputStream *must* be provided as the second parameter (it is optional for other types of input).
file->expressions-infoclj
(file->expressions-info f)(file->expressions-info f filepath)Returns an expressions-info map for the given file (an InputStream or something that can have an io/input-stream opened on it), or nil if no expressions were found.
If an InputStream is provided, it is the caller's responsibility to open and close it, and a filepath associated with the InputStream must be provided as the second parameter (it is optional for other types of input).
Returns an expressions-info map for the given file (an InputStream or something that can have an io/input-stream opened on it), or nil if no expressions were found. If an InputStream is provided, it is the caller's responsibility to open and close it, and a filepath associated with the InputStream *must* be provided as the second parameter (it is optional for other types of input).
init!clj
(init!)Initialises this namespace upon first call (and does nothing on subsequent calls), returning nil. Consumers of this namespace are not required to call this fn, as initialisation will occur implicitly anyway; it is provided to allow explicit control of the cost of initialisation to callers who need it.
Initialises this namespace upon first call (and does nothing on subsequent calls), returning nil. Consumers of this namespace are not required to call this fn, as initialisation will occur implicitly anyway; it is provided to allow explicit control of the cost of initialisation to callers who need it.
probable-license-file?clj
(probable-license-file? f)Returns true if the given file-like thing (String, File, ZipEntry) is a probable license file, false otherwise.
Returns true if the given file-like thing (String, File, ZipEntry) is a probable license file, false otherwise.
probable-license-filesclj
(probable-license-files dir)(probable-license-files dir include-hidden-dirs?)Returns all probable license files in the given directory, recursively, as a set of java.io.File objects. dir may be a String or a java.io.File, either of which must refer to a readable directory. By default ignores hidden directories.
Returns all probable license files in the given directory, recursively, as a set of java.io.File objects. dir may be a String or a java.io.File, either of which must refer to a readable directory. By default ignores hidden directories.
zip->expressionsclj
(zip->expressions zip)Returns a set of SPDX expressions (Strings) for the given ZIP file (a String or a File, which must refer to a ZIP-format compressed file), or nil if no expressions were found.
Throws if the file is not a valid ZIP.
Returns a set of SPDX expressions (Strings) for the given ZIP file (a String or a File, which must refer to a ZIP-format compressed file), or nil if no expressions were found. Throws if the file is not a valid ZIP.
zip->expressions-infoclj
(zip->expressions-info zip)Returns an expressions-info map for the given ZIP file (a String or a File, which must refer to a ZIP-format compressed file), or nil if no expressions were found.
Throws if the file is not a valid ZIP.
Returns an expressions-info map for the given ZIP file (a String or a File, which must refer to a ZIP-format compressed file), or nil if no expressions were found. Throws if the file is not a valid ZIP.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close