Package io.github.cdklabs.projen.javascript

Class LicenseChecker.Builder

java.lang.Object

io.github.cdklabs.projen.javascript.LicenseChecker.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<LicenseChecker>

Enclosing class:

LicenseChecker

@Stability(Experimental)
public static final class LicenseChecker.Builder
extends Object
implements software.amazon.jsii.Builder<LicenseChecker>

(experimental) A fluent builder for LicenseChecker.

Method Summary

Modifier and Type	Method	Description
LicenseChecker.Builder	allow(List<String> allow)	(experimental) List of SPDX license identifiers that are allowed to be used.
LicenseChecker	build()
static LicenseChecker.Builder	create(software.constructs.Construct scope)
LicenseChecker.Builder	deny(List<String> deny)	(experimental) List of SPDX license identifiers that are prohibited to be used.
LicenseChecker.Builder	development(Boolean development)	(experimental) Check development dependencies.
LicenseChecker.Builder	production(Boolean production)	(experimental) Check production dependencies.
LicenseChecker.Builder	taskName(String taskName)	(experimental) The name of the task that is added to check licenses.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(Experimental)
public static LicenseChecker.Builder create(software.constructs.Construct scope)

Parameters:

scope - This parameter is required.

Returns:

a new instance of LicenseChecker.Builder.

allow

@Stability(Experimental)
public LicenseChecker.Builder allow(List<String> allow)

(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

Parameters:

allow - List of SPDX license identifiers that are allowed to be used. This parameter is required.

Returns:

this

deny

@Stability(Experimental)
public LicenseChecker.Builder deny(List<String> deny)

(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

Parameters:

deny - List of SPDX license identifiers that are prohibited to be used. This parameter is required.

Returns:

this

development

@Stability(Experimental)
public LicenseChecker.Builder development(Boolean development)

(experimental) Check development dependencies.

Default: false

Parameters:

development - Check development dependencies. This parameter is required.

Returns:

this

production

@Stability(Experimental)
public LicenseChecker.Builder production(Boolean production)

(experimental) Check production dependencies.

Default: true

Parameters:

production - Check production dependencies. This parameter is required.

Returns:

this

taskName

@Stability(Experimental)
public LicenseChecker.Builder taskName(String taskName)

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

Default: "check-licenses"

Parameters:

taskName - The name of the task that is added to check licenses. This parameter is required.

Returns:

this

build

@Stability(Experimental)
public LicenseChecker build()

Specified by:

build in interface software.amazon.jsii.Builder<LicenseChecker>

Returns:

a newly built instance of LicenseChecker.