io.github.cdklabs.projen.typescript

Interface TypeScriptProjectOptions

All Superinterfaces:

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

All Known Subinterfaces:

AwsCdkConstructLibraryOptions, AwsCdkTypeScriptAppOptions, Cdk8sTypeScriptAppOptions, ConstructLibraryAwsOptions, ConstructLibraryCdk8sOptions, ConstructLibraryCdktfOptions, ConstructLibraryOptions, JsiiProjectOptions, NextJsTypeScriptProjectOptions, ReactTypeScriptProjectOptions, TypeScriptLibraryProjectOptions

All Known Implementing Classes:

AwsCdkConstructLibraryOptions.Jsii$Proxy, AwsCdkTypeScriptAppOptions.Jsii$Proxy, Cdk8sTypeScriptAppOptions.Jsii$Proxy, ConstructLibraryAwsOptions.Jsii$Proxy, ConstructLibraryCdk8sOptions.Jsii$Proxy, ConstructLibraryCdktfOptions.Jsii$Proxy, ConstructLibraryOptions.Jsii$Proxy, JsiiProjectOptions.Jsii$Proxy, NextJsTypeScriptProjectOptions.Jsii$Proxy, ReactTypeScriptProjectOptions.Jsii$Proxy, TypeScriptLibraryProjectOptions.Jsii$Proxy, TypeScriptProjectOptions.Jsii$Proxy

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static TypeScriptProjectOptions.Builder	builder()
default Boolean	getDisableTsconfig() (experimental) Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler).
default Boolean	getDocgen() (experimental) Docgen by Typedoc.
default String	getDocsDirectory() (experimental) Docs directory.
default String	getEntrypointTypes() (experimental) The .d.ts file that includes the type declarations for this module.
default Boolean	getEslint() (experimental) Setup eslint.
default EslintOptions	getEslintOptions() (experimental) Eslint options.
default String	getLibdir() (experimental) Typescript artifacts output directory.
default Boolean	getPackageValue() (experimental) Defines a `yarn package` command that will produce a tarball and place it under `dist/js`.
default Boolean	getProjenrcTs() (experimental) Use TypeScript for your projenrc file (`.projenrc.ts`).
default ProjenrcOptions	getProjenrcTsOptions() (experimental) Options for .projenrc.ts.
default Boolean	getSampleCode() (experimental) Generate one-time sample in `src/` and `test/` if there are no files there.
default String	getSrcdir() (experimental) Typescript sources directory.
default String	getTestdir() (experimental) Jest tests directory.
default TypescriptConfigOptions	getTsconfig() (experimental) Custom TSConfig.
default TypescriptConfigOptions	getTsconfigDev() (experimental) Custom tsconfig options for the development tsconfig.json file (used for testing).
default String	getTsconfigDevFile() (experimental) The name of the development tsconfig.json file.
default String	getTypescriptVersion() (experimental) TypeScript version to use.

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

getDisableTsconfig

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

(experimental) Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler).

Default: false

getDocgen

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

(experimental) Docgen by Typedoc.

Default: false

getDocsDirectory

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

(experimental) Docs directory.

Default: "docs"

getEntrypointTypes

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

(experimental) The .d.ts file that includes the type declarations for this module.

Default: - .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)

getEslint

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

(experimental) Setup eslint.

Default: true

getEslintOptions

@Stability(value=Experimental)
 @Nullable
default EslintOptions getEslintOptions()

(experimental) Eslint options.

Default: - opinionated default options

getLibdir

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

(experimental) Typescript artifacts output directory.

Default: "lib"

getPackageValue

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

(experimental) Defines a `yarn package` command that will produce a tarball and place it under `dist/js`.

Default: true

getProjenrcTs

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

(experimental) Use TypeScript for your projenrc file (`.projenrc.ts`).

Default: false

getProjenrcTsOptions

@Stability(value=Experimental)
 @Nullable
default ProjenrcOptions getProjenrcTsOptions()

(experimental) Options for .projenrc.ts.

getSampleCode

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

(experimental) Generate one-time sample in `src/` and `test/` if there are no files there.

Default: true

getSrcdir

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

(experimental) Typescript sources directory.

Default: "src"

getTestdir

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

(experimental) Jest tests directory. Tests files should be named `xxx.test.ts`.

If this directory is under srcdir (e.g. src/test, src/__tests__), then tests are going to be compiled into lib/ and executed as javascript. If the test directory is outside of src, then we configure jest to compile the code in-memory.

Default: "test"

getTsconfig

@Stability(value=Experimental)
 @Nullable
default TypescriptConfigOptions getTsconfig()

(experimental) Custom TSConfig.

Default: - default options

getTsconfigDev

@Stability(value=Experimental)
 @Nullable
default TypescriptConfigOptions getTsconfigDev()

(experimental) Custom tsconfig options for the development tsconfig.json file (used for testing).

Default: - use the production tsconfig options

getTsconfigDevFile

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

(experimental) The name of the development tsconfig.json file.

Default: "tsconfig.dev.json"

getTypescriptVersion

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

(experimental) TypeScript version to use.

NOTE: Typescript is not semantically versioned and should remain on the same minor, so we recommend using a ~ dependency (e.g. ~1.2.3).

Default: "latest"

builder

@Stability(value=Experimental)
static TypeScriptProjectOptions.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

Returns:

a TypeScriptProjectOptions.Builder of TypeScriptProjectOptions