Package io.github.cdklabs.projen.cdk

Interface JsiiProjectOptions

    • Method Detail

      • getAuthor

        @Stability(Experimental)
@NotNull
String getAuthor()
        (experimental) The name of the library author.

        Default: $GIT_USER_NAME

      • getAuthorAddress

        @Stability(Experimental)
@NotNull
String getAuthorAddress()
        (experimental) Email or URL of the library author.

        Default: $GIT_USER_EMAIL

      • getRepositoryUrl

        @Stability(Experimental)
@NotNull
String getRepositoryUrl()
        (experimental) Git repository URL.

        Default: $GIT_REMOTE

      • getCompat

        @Stability(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(Experimental)
@Nullable
default String getCompatIgnore()
        (experimental) Name of the ignore file for API compatibility tests.

        Default: ".compatignore"

      • getCompressAssembly

        @Stability(Experimental)
@Nullable
default Boolean getCompressAssembly()
        (experimental) Emit a compressed version of the assembly.

        Default: false

      • getDocgenFilePath

        @Stability(Experimental)
@Nullable
default String getDocgenFilePath()
        (experimental) File path for generated docs.

        Default: "API.md"

      • getExcludeTypescript

        @Stability(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.

      • getJsiiVersion

        @Stability(Experimental)
@Nullable
default String getJsiiVersion()
        (experimental) Version of the jsii compiler to use.

        Set to "*" if you want to manually manage the version of jsii in your project by managing updates to package.json on your own.

        NOTE: The jsii compiler releases since 5.0.0 are not semantically versioned and should remain on the same minor, so we recommend using a ~ dependency (e.g. ~5.0.0).

        Default: "1.x"

      • getPublishToGo

        @Stability(Experimental)
@Nullable
default JsiiGoTarget getPublishToGo()
        (experimental) Publish Go bindings to a git repository.

        Default: - no publishing

      • getPublishToMaven

        @Stability(Experimental)
@Nullable
default JsiiJavaTarget getPublishToMaven()
        (experimental) Publish to maven.

        Default: - no publishing

      • getPublishToNuget

        @Stability(Experimental)
@Nullable
default JsiiDotNetTarget getPublishToNuget()
        (experimental) Publish to NuGet.

        Default: - no publishing

      • getPublishToPypi

        @Stability(Experimental)
@Nullable
default JsiiPythonTarget getPublishToPypi()
        (experimental) Publish to pypi.

        Default: - no publishing

      • getRootdir

        @Stability(Experimental)
@Nullable
default String getRootdir()
        Default: "."