Package io.github.cdklabs.projen.javascript

Interface LicenseCheckerOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

LicenseCheckerOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.171Z")
@Stability(Experimental)
public interface LicenseCheckerOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Options to configure the license checker.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	LicenseCheckerOptions.Builder	A builder for LicenseCheckerOptions
static class	LicenseCheckerOptions.Jsii$Proxy	An implementation for LicenseCheckerOptions

Method Summary

Modifier and Type	Method	Description
static LicenseCheckerOptions.Builder	builder()
default List<String>	getAllow()	(experimental) List of SPDX license identifiers that are allowed to be used.
default List<String>	getDeny()	(experimental) List of SPDX license identifiers that are prohibited to be used.
default Boolean	getDevelopment()	(experimental) Check development dependencies.
default Boolean	getProduction()	(experimental) Check production dependencies.
default String	getTaskName()	(experimental) The name of the task that is added to check licenses.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAllow

@Stability(Experimental)
@Nullable
default List<String> getAllow()

(experimental) List of SPDX license identifiers that are allowed to be used.

For the license check to pass, all detected licenses MUST be in this list. Only one of allowedLicenses and prohibitedLicenses can be provided and must not be empty.

Default: - no licenses are allowed

getDeny

@Stability(Experimental)
@Nullable
default List<String> getDeny()

(experimental) List of SPDX license identifiers that are prohibited to be used.

For the license check to pass, no detected licenses can be in this list. Only one of allowedLicenses and prohibitedLicenses can be provided and must not be empty.

Default: - no licenses are prohibited

getDevelopment

@Stability(Experimental)
@Nullable
default Boolean getDevelopment()

(experimental) Check development dependencies.

Default: false

getProduction

@Stability(Experimental)
@Nullable
default Boolean getProduction()

(experimental) Check production dependencies.

Default: true

getTaskName

@Stability(Experimental)
@Nullable
default String getTaskName()

(experimental) The name of the task that is added to check licenses.

Default: "check-licenses"

builder

@Stability(Experimental)
static LicenseCheckerOptions.Builder builder()

Returns:

a LicenseCheckerOptions.Builder of LicenseCheckerOptions