All notable changes to this project will be documented in this file. This change log follows the conventions of keepachangelog.com.
Release breaks backward compatibility by adding mandatory Misc
column to the reports. See Changed sections for more details.
Misc column no longer depends on the verbosity level and is always
shown. For stdout reports (default format) visibility of the
column can be suppresed via custom formatter (e.g. %s %s %s to
show only first three columns)--formatter option spans 4 columns (Dependency, License name, License type, Misc) and equals to %-35s %-55s %-20s %-40s.--totals formatting assumes that the first two columns delimited
with the same separator; the first separator is used (by default a
single space)--report-format to support stdout
(default tabular report printed to the standard output), json,
json-pretty and csv formats
(#90)==) or arbitrary string equal (===) specifiers
(#132)--pre option is specified
#126-v (or --verbose)
options: errors only -v; info and errors -vv; debug, info and
errors -vvvRelease breaks backward compatibility if you use the tool as a
library in your Clojure code (see Changed section).
Release deprecates some command-line options in favour of the new
ones. Deprecated options will be removed in future releases. Until
removed, backward compatibility is supported for the deprecated
options when used explicitly (see Deprecated section).
--[no-]parallel (default true) to toggle parallel requests to
third-party APIs.--[no-]exit (default true) to toggle explicit System/exit call
upon program completion. Used to avoid exit when calling main in
your Clojure code as opposed to CLI invocation.org.clojars.vrs/cocoapods-acknowledgements-licenses
and org.clojars.vrs/gradle-licenses moved in to the projects code
base. See changes in namespaces pip-license-checker.file and
pip-license-checker.external.1.10.1 to 1.11.1.--[no-]with-totals deprecated in favour of --[no-]totals--[no-]table-headers deprecated in favour of --[no-]headersclj-http specific meta
(#116)[System] status-code message to System::subsystem error messageRelease breaks backward compatibility if you use the tool as a
library in your Clojure code (see Changed section).
--verbose (or -v for short) to make output
verbose. Options adds Misc column for error messages to the
report.
(#105)GITHUB_TOKEN is used as a default value for
--github-token option. Use as a safer alternative in CI/CD
pipelines so that OAuth token is not exposed in the logs as a plain text.--rate-limits requests/milliseconds is used for all external API requests (PyPI, GitHub)--github-token for OAuth tokens to increase GitHub API requests rate-limits
(#109)--rate-limits requests/milliseconds CLI option. NB! Default rate limits are
set to 120 requests per minute. This release may slow down your
Python dependencies check significantly in case large number of
packages
(#101)lein ancient to check outdated depsclojure:openjdk-11-lein-slim-buster Docker base image for a build stepzlib and zlib/libpng (a.k.a. zlib with Acknowledgement) licenses--formatter option to specify a
printf-style
formatter string for report formatting. The formatter is expected to
cover 3 columns of string data, e.g. --formatter '%-35s %-55s %-30s'.edn format for --external-format option to parse
EDN generated by the
lein-licenses plugin.pip-license-checker deps licensesRelease breaks backward compatibility by changing from permissive MIT license to the weak copyleft license of EPL-2.0 or GNU GPLv2 or any later with the GNU Classpath Exception.
csv external file format to specify a package name
column index and a license name column index respectively:
:package-column-index [integer], license-column-index [integer]. To pass options in use:
--external-options '{:package-column-index 0 :license-column-index 1}'
--exclude option regex matching for packages with nil name.--exclude-license option regex matching for packages with nil license name.gradle format for --external-format option to parse JSON generated by
gradle-license-plugin.
The format is supported via a standalone plugin gradle-licenses.--external-format option to specify one of the supported
external file formats: csv (default value), cocoapods.cocoapods external file format (Property list file)
generated by CocoaPods Acknowledgements plugin.
The format is supported via a standalone plugin
cocoapods-acknowledgements-licenses.--external-options option to specify a string of options in
EDN format to be used when parsing external files.
See respective external-format plugin's documenations for available options.--external-csv-headers option removed.
Use --external-options '{:skip-header true}' (present by default) to reproduce the behaviour.-p, -t, -o, -d, -m, -el. Use respective full option names.--exclude-license option for PCRE to remove packages with matching license names.--external option.--external-csv-headers option.StrongCopyleft these are recognised as WeakCopyleft.Release breaks backward compatibility by introducing fine-grained copyleft detection and moving some licenses between permissive and weak copyleft types.
Copyleft has been removed from result output in
favour of more granular copyleft types: WeakCopyleft (weak or
partial copyleft licenses like MPL, LGPL, or GPL with linking
exception), StrongCopyleft (GPL), NetworkCopyleft (AGPL, OSL)--fail option is extended with the new values: WeakCopyleft, StrongCopyleft, NetworkCopyleft.--fail option Copyleft is still suppported and is triggered for
all licenses under newly introduced WeakCopyleft,
StrongCopyleft, NetworkCopyleft types.Permissive to WeakCopyleft: CeCILL-2.1, CeCILL-C, LGPLCopyleft to WeakCopyleft: MPLCopyleft to StrongCopyleft: GPL, IBM Public LicenseCopyleft to NetworkCopyleft: AGPL, OSL--fails-only to print only licenses found for --fail flags (#57)-f or --fail LICENSE_TYPE to return non-zero exit code (1) if specified license type is found. More that one option -f may be specified.-t or --[no-]with-totals to print totals for license types-o or --[no-]totals-only to print only totals for license types, skipping table of requirements-d or --[no-]table-headers to print table headers--pre option to include pre-release and development versions in version resolution--pre option, or no other versions available to satisfy specifiers> and <Can you improve this documentation? These fine people already did:
Vitaly R. Samigullin & Vitaly SamigullinEdit on GitHub
cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |