io.github.cdklabs.projen.cdk

Interface JsiiProjectOptions

All Superinterfaces:

GitHubProjectOptions, software.amazon.jsii.JsiiSerializable, NodePackageOptions, NodeProjectOptions, ProjectOptions, ReleaseProjectOptions, TypeScriptProjectOptions

All Known Subinterfaces:

AwsCdkConstructLibraryOptions, ConstructLibraryAwsOptions, ConstructLibraryCdk8sOptions, ConstructLibraryCdktfOptions, ConstructLibraryOptions

All Known Implementing Classes:

AwsCdkConstructLibraryOptions.Jsii$Proxy, ConstructLibraryAwsOptions.Jsii$Proxy, ConstructLibraryCdk8sOptions.Jsii$Proxy, ConstructLibraryCdktfOptions.Jsii$Proxy, ConstructLibraryOptions.Jsii$Proxy, JsiiProjectOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-20T00:39:28.648Z")
 @Stability(value=Experimental)
public interface JsiiProjectOptions
extends software.amazon.jsii.JsiiSerializable, TypeScriptProjectOptions

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static JsiiProjectOptions.Builder	builder()
String	getAuthor() (experimental) The name of the library author.
String	getAuthorAddress() (experimental) Email or URL of the library author.
default Boolean	getCompat() (experimental) Automatically run API compatibility test against the latest version published to npm after compilation.
default String	getCompatIgnore() (experimental) Name of the ignore file for API compatibility tests.
default JsiiDotNetTarget	getDotnet() Deprecated. use `publishToNuget`
default List<String>	getExcludeTypescript() (experimental) Accepts a list of glob patterns.
default JsiiGoTarget	getPublishToGo() (experimental) Publish Go bindings to a git repository.
default JsiiJavaTarget	getPublishToMaven() (experimental) Publish to maven.
default JsiiDotNetTarget	getPublishToNuget() (experimental) Publish to NuGet.
default JsiiPythonTarget	getPublishToPypi() (experimental) Publish to pypi.
default JsiiPythonTarget	getPython() Deprecated. use `publishToPyPi`
String	getRepositoryUrl() (experimental) Git repository URL.
default String	getRootdir() Default: "."

Methods inherited from interface io.github.cdklabs.projen.typescript.TypeScriptProjectOptions

getDisableTsconfig, getDocgen, getDocsDirectory, getEntrypointTypes, getEslint, getEslintOptions, getLibdir, getPackageValue, getProjenrcTs, getProjenrcTsOptions, getSampleCode, getSrcdir, getTestdir, getTsconfig, getTsconfigDev, getTsconfigDevFile, getTypescriptVersion

Methods inherited from interface io.github.cdklabs.projen.javascript.NodeProjectOptions

getAutoApproveProjenUpgrades, getAutoApproveUpgrades, getBuildWorkflow, getBundlerOptions, getCodeCov, getCodeCovTokenSecret, getCopyrightOwner, getCopyrightPeriod, getDefaultReleaseBranch, getDependabot, getDependabotOptions, getDepsUpgrade, getDepsUpgradeOptions, getGitignore, getJest, getJestOptions, getMutableBuild, getNpmignore, getNpmignoreEnabled, getProjenDevDependency, getProjenrcJs, getProjenrcJsOptions, getProjenUpgradeAutoMerge, getProjenUpgradeSchedule, getProjenUpgradeSecret, getProjenVersion, getPullRequestTemplate, getPullRequestTemplateContents, getRelease, getReleaseToNpm, getReleaseWorkflow, getWorkflowBootstrapSteps, getWorkflowGitIdentity, getWorkflowNodeVersion

Methods inherited from interface io.github.cdklabs.projen.github.GitHubProjectOptions

getAutoApproveOptions, getAutoMergeOptions, getClobber, getDevContainer, getGithub, getGithubOptions, getGitpod, getMergify, getMergifyOptions, getProjectType, getReadme, getStale, getStaleOptions, getVscode

Methods inherited from interface io.github.cdklabs.projen.ProjectOptions

getLogging, getName, getOutdir, getParent, getProjenCommand, getProjenrcJson, getProjenrcJsonOptions

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface io.github.cdklabs.projen.javascript.NodePackageOptions

getAllowLibraryDependencies, getAuthorEmail, getAuthorName, getAuthorOrganization, getAuthorUrl, getAutoDetectBin, getBin, getBundledDeps, getCodeArtifactOptions, getDeps, getDescription, getDevDeps, getEntrypoint, getHomepage, getKeywords, getLicense, getLicensed, getMaxNodeVersion, getMinNodeVersion, getNpmAccess, getNpmRegistry, getNpmRegistryUrl, getNpmTokenSecret, getPackageManager, getPackageName, getPeerDependencyOptions, getPeerDeps, getRepository, getRepositoryDirectory, getScripts, getStability

Methods inherited from interface io.github.cdklabs.projen.release.ReleaseProjectOptions

getAntitamper, getArtifactsDirectory, getJsiiReleaseVersion, getMajorVersion, getNpmDistTag, getPostBuildSteps, getPrerelease, getPublishTasks, getReleaseBranches, getReleaseEveryCommit, getReleaseFailureIssue, getReleaseFailureIssueLabel, getReleaseSchedule, getReleaseTagPrefix, getReleaseTrigger, getReleaseWorkflowName, getReleaseWorkflowSetupSteps, getVersionrcOptions, getWorkflowContainerImage, getWorkflowRunsOn

Method Detail

getAuthor

@Stability(value=Experimental)
 @NotNull
String getAuthor()

(experimental) The name of the library author.

Default: $GIT_USER_NAME

getAuthorAddress

@Stability(value=Experimental)
 @NotNull
String getAuthorAddress()

(experimental) Email or URL of the library author.

Default: $GIT_USER_EMAIL

getRepositoryUrl

@Stability(value=Experimental)
 @NotNull
String getRepositoryUrl()

(experimental) Git repository URL.

Default: $GIT_REMOTE

getCompat

@Stability(value=Experimental)
 @Nullable
default Boolean getCompat()

(experimental) Automatically run API compatibility test against the latest version published to npm after compilation.

• You can manually run compatibility tests using yarn compat if this feature is disabled.
• You can ignore compatibility failures by adding lines to a ".compatignore" file.

Default: false

getCompatIgnore

@Stability(value=Experimental)
 @Nullable
default String getCompatIgnore()

(experimental) Name of the ignore file for API compatibility tests.

Default: ".compatignore"

getDotnet

@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default JsiiDotNetTarget getDotnet()

Deprecated. use `publishToNuget`

getExcludeTypescript

@Stability(value=Experimental)
 @Nullable
default List<String> getExcludeTypescript()

(experimental) Accepts a list of glob patterns.

Files matching any of those patterns will be excluded from the TypeScript compiler input.

By default, jsii will include all *.ts files (except .d.ts files) in the TypeScript compiler input. This can be problematic for example when the package's build or test procedure generates .ts files that cannot be compiled with jsii's compiler settings.

getPublishToGo

@Stability(value=Experimental)
 @Nullable
default JsiiGoTarget getPublishToGo()

(experimental) Publish Go bindings to a git repository.

Default: - no publishing

getPublishToMaven

@Stability(value=Experimental)
 @Nullable
default JsiiJavaTarget getPublishToMaven()

(experimental) Publish to maven.

Default: - no publishing

getPublishToNuget

@Stability(value=Experimental)
 @Nullable
default JsiiDotNetTarget getPublishToNuget()

(experimental) Publish to NuGet.

Default: - no publishing

getPublishToPypi

@Stability(value=Experimental)
 @Nullable
default JsiiPythonTarget getPublishToPypi()

(experimental) Publish to pypi.

Default: - no publishing

getPython

@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default JsiiPythonTarget getPython()

Deprecated. use `publishToPyPi`

getRootdir

@Stability(value=Experimental)
 @Nullable
default String getRootdir()

Default: "."

builder

@Stability(value=Experimental)
static JsiiProjectOptions.Builder builder()

Specified by:

builder in interface GitHubProjectOptions

Specified by:

builder in interface NodePackageOptions

Specified by:

builder in interface NodeProjectOptions

Specified by:

builder in interface ProjectOptions

Specified by:

builder in interface ReleaseProjectOptions

Specified by:

builder in interface TypeScriptProjectOptions

Returns:

a JsiiProjectOptions.Builder of JsiiProjectOptions