Package io.github.cdklabs.projen.typescript

Class TypeScriptProject

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

io.github.cdklabs.projen.Project

io.github.cdklabs.projen.github.GitHubProject

io.github.cdklabs.projen.javascript.NodeProject

io.github.cdklabs.projen.typescript.TypeScriptProject

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

Direct Known Subclasses:

JsiiProject, TypeScriptAppProject, TypeScriptLibraryProject

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.302Z")
@Stability(Experimental)
public class TypeScriptProject
extends NodeProject

(experimental) TypeScript project.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TypeScriptProject.Builder	(experimental) A fluent builder for TypeScriptProject.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_TS_JEST_TRANFORM_PATTERN

Fields inherited from class io.github.cdklabs.projen.Project

DEFAULT_TASK

Constructor Summary

Constructors

Modifier	Constructor	Description
	TypeScriptProject(TypeScriptProjectOptions options)
protected	TypeScriptProject(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	TypeScriptProject(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
Boolean	getDocgen()
String	getDocsDirectory()
Eslint	getEslint()
String	getLibdir()	(experimental) The directory in which compiled .js files reside.
String	getSrcdir()	(experimental) The directory in which the .ts sources reside.
String	getTestdir()	(experimental) The directory in which tests reside.
TypescriptConfig	getTsconfig()
TypescriptConfig	getTsconfigDev()	(experimental) A typescript configuration file which covers all files (sources, tests, projen).
TypescriptConfig	getTsconfigEslint()
Task	getWatchTask()	(experimental) The "watch" task.

Methods inherited from class io.github.cdklabs.projen.javascript.NodeProject

addBins, addBundledDeps, addCompileCommand, addDeps, addDevDeps, addFields, addKeywords, addPackageIgnore, addPeerDeps, addScripts, addTestCommand, getAllowLibraryDependencies, getArtifactsDirectory, getArtifactsJavascriptDirectory, getAutoMerge, getBuildWorkflow, getBuildWorkflowJobId, getBundler, getEntrypoint, getJest, getManifest, getMaxNodeVersion, getMinNodeVersion, getNodeVersion, getNpmignore, getNpmrc, getPackageManager, getPackageValue, getPrettier, getPublisher, getRelease, getRunScriptCommand, getUpgradeWorkflow, getWorkflowBootstrapSteps, getWorkflowPackageCache, hasScript, removeScript, renderWorkflowSetup, renderWorkflowSetup, runTaskCommand, setScript

Methods inherited from class io.github.cdklabs.projen.github.GitHubProject

annotateGenerated, getAutoApprove, getDevContainer, getGithub, getGitpod, getProjectType, getVscode

Methods inherited from class io.github.cdklabs.projen.Project

addExcludeFromCleanup, addGitIgnore, addTask, addTask, addTip, getBuildTask, getCommitGenerated, getCompileTask, getComponents, getDefaultTask, getDeps, getEjected, getFiles, getGitattributes, getGitignore, getInitProject, getLogger, getName, getOutdir, getPackageTask, getParent, getPostCompileTask, getPreCompileTask, getProjectBuild, getProjenCommand, getRoot, getSubprojects, getTasks, getTestTask, isProject, of, postSynthesize, preSynthesize, removeTask, synth, tryFindFile, tryFindJsonFile, tryFindObjectFile, tryRemoveFile

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

DEFAULT_TS_JEST_TRANFORM_PATTERN

@Stability(Experimental)
public static final String DEFAULT_TS_JEST_TRANFORM_PATTERN

Constructor Detail

TypeScriptProject

protected TypeScriptProject(software.amazon.jsii.JsiiObjectRef objRef)

TypeScriptProject

protected TypeScriptProject(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

TypeScriptProject

@Stability(Experimental)
public TypeScriptProject(@NotNull
                         TypeScriptProjectOptions options)

Parameters:

options - This parameter is required.

Method Detail

getDocsDirectory

@Stability(Experimental)
@NotNull
public String getDocsDirectory()

getLibdir

@Stability(Experimental)
@NotNull
public String getLibdir()

(experimental) The directory in which compiled .js files reside.

getSrcdir

@Stability(Experimental)
@NotNull
public String getSrcdir()

(experimental) The directory in which the .ts sources reside.

getTestdir

@Stability(Experimental)
@NotNull
public String getTestdir()

(experimental) The directory in which tests reside.

getTsconfigDev

@Stability(Experimental)
@NotNull
public TypescriptConfig getTsconfigDev()

(experimental) A typescript configuration file which covers all files (sources, tests, projen).

getWatchTask

@Stability(Experimental)
@NotNull
public Task getWatchTask()

(experimental) The "watch" task.

getDocgen

@Stability(Experimental)
@Nullable
public Boolean getDocgen()

getEslint

@Stability(Experimental)
@Nullable
public Eslint getEslint()

getTsconfig

@Stability(Experimental)
@Nullable
public TypescriptConfig getTsconfig()

getTsconfigEslint

@Stability(Experimental)
@Nullable
public TypescriptConfig getTsconfigEslint()