org.ysb33r.gradle.jsecosystem.models

Interface JseSourceSet

All Superinterfaces:

org.gradle.api.Named

public interface JseSourceSet
extends org.gradle.api.Named

Describes an application or library development model.

Since:

5.1

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.Named

org.gradle.api.Named.Namer

Method Summary

Modifier and Type	Method and Description
org.gradle.api.provider.Provider<org.gradle.api.file.Directory>	getOutputDir() Output directory for the source set.
org.gradle.api.provider.Provider<org.gradle.api.file.Directory>	getSrcDir() Provide for the root directory of the source set,
org.gradle.api.provider.Provider<java.util.Set<java.lang.String>>	getTrustedPackages() Which packages are trusted byt his source set to perform things like post-install scripts.
void	lifecycle(java.lang.String name, java.lang.Class<? extends JseLifecycleManager> clazz) Associates a life cycle with the source set.
void	readOutputPathFromTsConfig() Reads the output path from tsconfig.json.
void	readProjectVersionFromPackageJson() Forces the project's version to be read from the package.json file's version field.
void	setOutputPath(java.lang.Object relativePath) Sets an optional output directory.
void	setSrcDir(java.lang.Object dir) Sets the source directory.
void	trustedPackages(java.lang.Iterable<java.lang.String> pkgs) Which packages are trusted byt his source set to perform things like post-install scripts.
void	trustedPackages(org.gradle.api.provider.Provider<java.util.List<java.lang.String>> pkgs) Which packages are trusted byt his source set to perform things like post-install scripts.
default void	trustedPackages(java.lang.String... pkgs) Which packages are trusted byt his source set to perform things like post-install scripts.

Methods inherited from interface org.gradle.api.Named

getName

Method Detail

getSrcDir

org.gradle.api.provider.Provider<org.gradle.api.file.Directory> getSrcDir()

Provide for the root directory of the source set,

Returns:

Directory provider.

setSrcDir

void setSrcDir(java.lang.Object dir)

Sets the source directory.

Parameters:

dir - Directory can be anything convertible using Project.file(java.lang.Object).

setOutputPath

void setOutputPath(java.lang.Object relativePath)

Sets an optional output directory.

Parameters:

relativePath - Relative path to the source directory. Anything that is convertible to a string is accepted.

readOutputPathFromTsConfig

void readOutputPathFromTsConfig()

Reads the output path from tsconfig.json.

If the file does not exist or does not have an outDir field, then the source set will behave as if the output directory has not been set.

getOutputDir

org.gradle.api.provider.Provider<org.gradle.api.file.Directory> getOutputDir()

Output directory for the source set.

Returns:

Directory provider. Can be empty.

lifecycle

void lifecycle(java.lang.String name,
               java.lang.Class<? extends JseLifecycleManager> clazz)

Associates a life cycle with the source set.

This method can only be called once and should be done during the initial creation of the source set.

Parameters:

name - Name of life cycle.

clazz - Life cycle manager class.

readProjectVersionFromPackageJson

void readProjectVersionFromPackageJson()

Forces the project's version to be read from the package.json file's version field.

If applying this, only apply it to one source set within a project.

If the package.json file does not exist, then package-json-undefined will be returned as a version.

getTrustedPackages

org.gradle.api.provider.Provider<java.util.Set<java.lang.String>> getTrustedPackages()

Which packages are trusted byt his source set to perform things like post-install scripts.

Returns:

Provider to a set of packages that can be trusted. Always present, but can be empty.

Since:

5.2

trustedPackages

default void trustedPackages(java.lang.String... pkgs)

Which packages are trusted byt his source set to perform things like post-install scripts.

Parameters:

pkgs - Package names including scopes.

Since:

5.2

trustedPackages

void trustedPackages(java.lang.Iterable<java.lang.String> pkgs)

Which packages are trusted byt his source set to perform things like post-install scripts.

Parameters:

pkgs - Package names including scopes.

Since:

5.2

trustedPackages

void trustedPackages(org.gradle.api.provider.Provider<java.util.List<java.lang.String>> pkgs)

Which packages are trusted byt his source set to perform things like post-install scripts.

Parameters:

pkgs - Package names including scopes.

Since:

5.2