org.ysb33r.gradle.jse.pnpm.configuration

Interface PnpmAuditConfiguration

public interface PnpmAuditConfiguration

Describes options for configuration pnpm audit.

Since:

5.3

Method Summary

Modifier and Type	Method and Description
void	copyFrom(PnpmAuditConfiguration other) Copy configuration from another instance
void	copyFrom(org.gradle.api.provider.Provider<PnpmAuditConfiguration> other) Copy configuration from another instance
org.gradle.api.provider.Provider<java.util.List<java.lang.String>>	getAuditArgs() A list of command-line parameters that can be passed to pnpm audit.
org.gradle.api.provider.Provider<org.ysb33r.gradle.jse.pnpm.configuration.PnpmAuditLevel>	getAuditLevel() Gets the configured audit level.
org.gradle.api.provider.Provider<java.lang.Boolean>	getIgnoreRegistryErrors() Whether to ignore registry errors.
org.gradle.api.provider.Provider<java.lang.Boolean>	getIgnoreUnfixable() Whether to ignore unfixable issues.
org.gradle.api.provider.Provider<java.lang.Boolean>	getIncludeOptional() Whether to include optional dependencies in audit.
org.gradle.api.provider.Provider<java.lang.Boolean>	getProdOnly() Whether to only audit production dependencies.
void	setAuditLevel(java.lang.Object level) Sets the pnpm Audit level.
void	setAuditLevel(org.ysb33r.gradle.jse.pnpm.configuration.PnpmAuditLevel level) Sets the pnpm Audit level.
void	setIgnoreRegistryErrors(boolean flag) Whether to ignore registry errors.
void	setIgnoreUnfixable(boolean flag) Whether to ignore unfixable issues.
void	setIncludeOptional(boolean flag) Whether to include optional dependencies in audit.
void	setProdOnly(boolean flag) Whether to only audit production dependencies.

Method Detail

getAuditLevel

@Internal
org.gradle.api.provider.Provider<org.ysb33r.gradle.jse.pnpm.configuration.PnpmAuditLevel> getAuditLevel()

Gets the configured audit level.

Returns:

Configured audit level. Can be empty if not configured.

setAuditLevel

void setAuditLevel(org.ysb33r.gradle.jse.pnpm.configuration.PnpmAuditLevel level)

Sets the pnpm Audit level.

Parameters:

level - The level to set.

setAuditLevel

void setAuditLevel(java.lang.Object level)

Sets the pnpm Audit level.

Parameters:

level - The level to set. This can be anything convertible to a string that matches one of the pnpm audit levels. String will be converted to the correct case.

getProdOnly

@Internal
org.gradle.api.provider.Provider<java.lang.Boolean> getProdOnly()

Whether to only audit production dependencies.

Returns:

Provider that will return true if only production dependencies are to be audited.

setProdOnly

void setProdOnly(boolean flag)

Whether to only audit production dependencies. Defaults to dev and prod if not set.

Parameters:

flag - true to ignore dev dependencies.

getIncludeOptional

@Internal
org.gradle.api.provider.Provider<java.lang.Boolean> getIncludeOptional()

Whether to include optional dependencies in audit. Default is not to include optional dependencies.

Returns:

Provider that will return true if optional dependencies are to be included.

setIncludeOptional

void setIncludeOptional(boolean flag)

Whether to include optional dependencies in audit. Default is not to include optional dependencies.

Parameters:

flag - true to ignore optional dependencies.

getIgnoreRegistryErrors

@Internal
org.gradle.api.provider.Provider<java.lang.Boolean> getIgnoreRegistryErrors()

Whether to ignore registry errors. The default is to ignore errors.

Returns:

Provider that will return true if registry errors are to be ignored.

setIgnoreRegistryErrors

void setIgnoreRegistryErrors(boolean flag)

Whether to ignore registry errors. Default is to ignore errors.

Parameters:

flag - true to ignore registry errors.

getIgnoreUnfixable

@Internal
org.gradle.api.provider.Provider<java.lang.Boolean> getIgnoreUnfixable()

Whether to ignore unfixable issues. Default behaviour is to not ignore unfixable issues.

Returns:

Provider that will return true if unfixable issues are to be ignored.

setIgnoreUnfixable

void setIgnoreUnfixable(boolean flag)

Whether to ignore unfixable issues. Default behaviour is to not ignore unfixable issues.

Parameters:

flag - true to ignore unfixable issues.

copyFrom

void copyFrom(PnpmAuditConfiguration other)

Copy configuration from another instance

Parameters:

other - Another instance.

copyFrom

void copyFrom(org.gradle.api.provider.Provider<PnpmAuditConfiguration> other)

Copy configuration from another instance

Parameters:

other - Provider to another instance.

getAuditArgs

@Input
 @Optional
org.gradle.api.provider.Provider<java.util.List<java.lang.String>> getAuditArgs()

A list of command-line parameters that can be passed to pnpm audit.

Returns:

Provider to a list of arguments. Never null. Provider might resolve to empty list.