library
=======

Checks libraries that are configured in the project.

.. contents::

Configuration options
---------------------

name
~~~~

The name of the library. This is a :doc:`/ref/targets/string` target.

In IntelliJ, this will be checked against the libraries that are configured as dependency in the module.
This can be checked by opening the :guilabel:`Project Structure | Modules` view and selecting the
:guilabel:`Dependencies` tab.

Example of kinds of names of libraries:

.. code-block::

    Maven: org.json:json:20160212
    Gradle: org.junit.jupiter:junit-jupiter-api:5.6.0
    bcpg-jdk15on-1.61

Due to this naming, it is often desired to use the :ref:`string_contains` or :ref:`string_matches`
properties of the string target instead of the literal :ref:`string_is` matching.

minVersion
~~~~~~~~~~

Will restrict matching to libraries that have a version that is the same or higher than this
configured value.

The format is freeform and an attempt will be made to compare it with the version of the
library, which is either extracted from the jar name/path or a ``Implementation-Version``
entry in the jar's manifest.

maxVersion
~~~~~~~~~~

Will restrict matching to libraries that have a version that is the same or lower than this
configured value.

The format is freeform and an attempt will be made to compare it with the version of the
library, which is either extracted from the jar name/path or a ``Implementation-Version``
entry in the jar's manifest.