Uses of Class
io.github.cdklabs.projen.typescript.TypeScriptProject.Builder

Packages that use TypeScriptProject.Builder

Package	Description
io.github.cdklabs.projen.typescript

Uses of TypeScriptProject.Builder in io.github.cdklabs.projen.typescript

Methods in io.github.cdklabs.projen.typescript that return TypeScriptProject.Builder

Modifier and Type	Method	Description
TypeScriptProject.Builder	TypeScriptProject.Builder.allowLibraryDependencies(Boolean allowLibraryDependencies)	(experimental) Allow the project to include peerDependencies and bundledDependencies.
TypeScriptProject.Builder	TypeScriptProject.Builder.artifactsDirectory(String artifactsDirectory)	(experimental) A directory which will contain build artifacts.
TypeScriptProject.Builder	TypeScriptProject.Builder.authorEmail(String authorEmail)	(experimental) Author's e-mail.
TypeScriptProject.Builder	TypeScriptProject.Builder.authorName(String authorName)	(experimental) Author's name.
TypeScriptProject.Builder	TypeScriptProject.Builder.authorOrganization(Boolean authorOrganization)	(experimental) Is the author an organization.
TypeScriptProject.Builder	TypeScriptProject.Builder.authorUrl(String authorUrl)	(experimental) Author's URL / Website.
TypeScriptProject.Builder	TypeScriptProject.Builder.autoApproveOptions(AutoApproveOptions autoApproveOptions)	(experimental) Enable and configure the 'auto approve' workflow.
TypeScriptProject.Builder	TypeScriptProject.Builder.autoApproveUpgrades(Boolean autoApproveUpgrades)	(experimental) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).
TypeScriptProject.Builder	TypeScriptProject.Builder.autoDetectBin(Boolean autoDetectBin)	(experimental) Automatically add all executables under the bin directory to your package.json file under the bin section.
TypeScriptProject.Builder	TypeScriptProject.Builder.autoMerge(Boolean autoMerge)	(experimental) Enable automatic merging on GitHub.
TypeScriptProject.Builder	TypeScriptProject.Builder.autoMergeOptions(AutoMergeOptions autoMergeOptions)	(experimental) Configure options for automatic merging on GitHub.
TypeScriptProject.Builder	TypeScriptProject.Builder.bin(Map<String,String> bin)	(experimental) Binary programs vended with your module.
TypeScriptProject.Builder	TypeScriptProject.Builder.bugsEmail(String bugsEmail)	(experimental) The email address to which issues should be reported.
TypeScriptProject.Builder	TypeScriptProject.Builder.bugsUrl(String bugsUrl)	(experimental) The url to your project's issue tracker.
TypeScriptProject.Builder	TypeScriptProject.Builder.buildWorkflow(Boolean buildWorkflow)	(experimental) Define a GitHub workflow for building PRs.
TypeScriptProject.Builder	TypeScriptProject.Builder.buildWorkflowTriggers(Triggers buildWorkflowTriggers)	(experimental) Build workflow triggers.
TypeScriptProject.Builder	TypeScriptProject.Builder.bundledDeps(List<String> bundledDeps)	(experimental) List of dependencies to bundle into this module.
TypeScriptProject.Builder	TypeScriptProject.Builder.bundlerOptions(BundlerOptions bundlerOptions)	(experimental) Options for Bundler.
TypeScriptProject.Builder	TypeScriptProject.Builder.checkLicenses(LicenseCheckerOptions checkLicenses)	(experimental) Configure which licenses should be deemed acceptable for use by dependencies.
TypeScriptProject.Builder	TypeScriptProject.Builder.clobber(Boolean clobber)	(experimental) Add a clobber task which resets the repo to origin.
TypeScriptProject.Builder	TypeScriptProject.Builder.codeArtifactOptions(CodeArtifactOptions codeArtifactOptions)	(experimental) Options for npm packages using AWS CodeArtifact.
TypeScriptProject.Builder	TypeScriptProject.Builder.codeCov(Boolean codeCov)	(experimental) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v3 A secret is required for private repos.
TypeScriptProject.Builder	TypeScriptProject.Builder.codeCovTokenSecret(String codeCovTokenSecret)	(experimental) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.
TypeScriptProject.Builder	TypeScriptProject.Builder.commitGenerated(Boolean commitGenerated)	(experimental) Whether to commit the managed files by default.
TypeScriptProject.Builder	TypeScriptProject.Builder.copyrightOwner(String copyrightOwner)	(experimental) License copyright owner.
TypeScriptProject.Builder	TypeScriptProject.Builder.copyrightPeriod(String copyrightPeriod)	(experimental) The copyright years to put in the LICENSE file.
static TypeScriptProject.Builder	TypeScriptProject.Builder.create()
TypeScriptProject.Builder	TypeScriptProject.Builder.defaultReleaseBranch(String defaultReleaseBranch)	(experimental) The name of the main release branch.
TypeScriptProject.Builder	TypeScriptProject.Builder.dependabot(Boolean dependabot)	(experimental) Use dependabot to handle dependency upgrades.
TypeScriptProject.Builder	TypeScriptProject.Builder.dependabotOptions(DependabotOptions dependabotOptions)	(experimental) Options for dependabot.
TypeScriptProject.Builder	TypeScriptProject.Builder.deps(List<String> deps)	(experimental) Runtime dependencies of this module.
TypeScriptProject.Builder	TypeScriptProject.Builder.depsUpgrade(Boolean depsUpgrade)	(experimental) Use tasks and github workflows to handle dependency upgrades.
TypeScriptProject.Builder	TypeScriptProject.Builder.depsUpgradeOptions(UpgradeDependenciesOptions depsUpgradeOptions)	(experimental) Options for UpgradeDependencies.
TypeScriptProject.Builder	TypeScriptProject.Builder.description(String description)	(experimental) The description is just a string that helps people understand the purpose of the package.
TypeScriptProject.Builder	TypeScriptProject.Builder.devContainer(Boolean devContainer)	(experimental) Add a VSCode development environment (used for GitHub Codespaces).
TypeScriptProject.Builder	TypeScriptProject.Builder.devDeps(List<String> devDeps)	(experimental) Build dependencies for this module.
TypeScriptProject.Builder	TypeScriptProject.Builder.disableTsconfig(Boolean disableTsconfig)	(experimental) Do not generate a tsconfig.json file (used by jsii projects since tsconfig.json is generated by the jsii compiler).
TypeScriptProject.Builder	TypeScriptProject.Builder.disableTsconfigDev(Boolean disableTsconfigDev)	(experimental) Do not generate a tsconfig.dev.json file.
TypeScriptProject.Builder	TypeScriptProject.Builder.docgen(Boolean docgen)	(experimental) Docgen by Typedoc.
TypeScriptProject.Builder	TypeScriptProject.Builder.docsDirectory(String docsDirectory)	(experimental) Docs directory.
TypeScriptProject.Builder	TypeScriptProject.Builder.entrypoint(String entrypoint)	(experimental) Module entrypoint (main in package.json).
TypeScriptProject.Builder	TypeScriptProject.Builder.entrypointTypes(String entrypointTypes)	(experimental) The .d.ts file that includes the type declarations for this module.
TypeScriptProject.Builder	TypeScriptProject.Builder.eslint(Boolean eslint)	(experimental) Setup eslint.
TypeScriptProject.Builder	TypeScriptProject.Builder.eslintOptions(EslintOptions eslintOptions)	(experimental) Eslint options.
TypeScriptProject.Builder	TypeScriptProject.Builder.github(Boolean github)	(experimental) Enable GitHub integration.
TypeScriptProject.Builder	TypeScriptProject.Builder.githubOptions(GitHubOptions githubOptions)	(experimental) Options for GitHub integration.
TypeScriptProject.Builder	TypeScriptProject.Builder.gitignore(List<String> gitignore)	(experimental) Additional entries to .gitignore.
TypeScriptProject.Builder	TypeScriptProject.Builder.gitIgnoreOptions(IgnoreFileOptions gitIgnoreOptions)	(experimental) Configuration options for .gitignore file.
TypeScriptProject.Builder	TypeScriptProject.Builder.gitOptions(GitOptions gitOptions)	(experimental) Configuration options for git.
TypeScriptProject.Builder	TypeScriptProject.Builder.gitpod(Boolean gitpod)	(experimental) Add a Gitpod development environment.
TypeScriptProject.Builder	TypeScriptProject.Builder.homepage(String homepage)	(experimental) Package's Homepage / Website.
TypeScriptProject.Builder	TypeScriptProject.Builder.jest(Boolean jest)	(experimental) Setup jest unit tests.
TypeScriptProject.Builder	TypeScriptProject.Builder.jestOptions(JestOptions jestOptions)	(experimental) Jest options.
TypeScriptProject.Builder	TypeScriptProject.Builder.jsiiReleaseVersion(String jsiiReleaseVersion)	(experimental) Version requirement of publib which is used to publish modules to npm.
TypeScriptProject.Builder	TypeScriptProject.Builder.keywords(List<String> keywords)	(experimental) Keywords to include in package.json.
TypeScriptProject.Builder	TypeScriptProject.Builder.libdir(String libdir)	(experimental) Typescript artifacts output directory.
TypeScriptProject.Builder	TypeScriptProject.Builder.license(String license)	(experimental) License's SPDX identifier.
TypeScriptProject.Builder	TypeScriptProject.Builder.licensed(Boolean licensed)	(experimental) Indicates if a license should be added.
TypeScriptProject.Builder	TypeScriptProject.Builder.logging(LoggerOptions logging)	(experimental) Configure logging options such as verbosity.
TypeScriptProject.Builder	TypeScriptProject.Builder.majorVersion(Number majorVersion)	(experimental) Major version to release from the default branch.
TypeScriptProject.Builder	TypeScriptProject.Builder.maxNodeVersion(String maxNodeVersion)	(experimental) Minimum node.js version to require via engines (inclusive).
TypeScriptProject.Builder	TypeScriptProject.Builder.mergify(Boolean mergify)	Deprecated. use githubOptions.mergify instead
TypeScriptProject.Builder	TypeScriptProject.Builder.mergifyOptions(MergifyOptions mergifyOptions)	Deprecated. use githubOptions.mergifyOptions instead
TypeScriptProject.Builder	TypeScriptProject.Builder.minMajorVersion(Number minMajorVersion)	(experimental) Minimal Major version to release.
TypeScriptProject.Builder	TypeScriptProject.Builder.minNodeVersion(String minNodeVersion)	(experimental) Minimum Node.js version to require via package.json engines (inclusive).
TypeScriptProject.Builder	TypeScriptProject.Builder.mutableBuild(Boolean mutableBuild)	(experimental) Automatically update files modified during builds to pull-request branches.
TypeScriptProject.Builder	TypeScriptProject.Builder.name(String name)	(experimental) This is the name of your project.
TypeScriptProject.Builder	TypeScriptProject.Builder.npmAccess(NpmAccess npmAccess)	(experimental) Access level of the npm package.
TypeScriptProject.Builder	TypeScriptProject.Builder.npmDistTag(String npmDistTag)	(experimental) The npmDistTag to use when publishing from the default branch.
TypeScriptProject.Builder	TypeScriptProject.Builder.npmignore(List<String> npmignore)	Deprecated. use project.addPackageIgnore
TypeScriptProject.Builder	TypeScriptProject.Builder.npmignoreEnabled(Boolean npmignoreEnabled)	(experimental) Defines an .npmignore file.
TypeScriptProject.Builder	TypeScriptProject.Builder.npmIgnoreOptions(IgnoreFileOptions npmIgnoreOptions)	(experimental) Configuration options for .npmignore file.
TypeScriptProject.Builder	TypeScriptProject.Builder.npmProvenance(Boolean npmProvenance)	(experimental) Should provenance statements be generated when the package is published.
TypeScriptProject.Builder	TypeScriptProject.Builder.npmRegistry(String npmRegistry)	Deprecated. use npmRegistryUrl instead
TypeScriptProject.Builder	TypeScriptProject.Builder.npmRegistryUrl(String npmRegistryUrl)	(experimental) The base URL of the npm package registry.
TypeScriptProject.Builder	TypeScriptProject.Builder.npmTokenSecret(String npmTokenSecret)	(experimental) GitHub secret which contains the NPM token to use when publishing packages.
TypeScriptProject.Builder	TypeScriptProject.Builder.outdir(String outdir)	(experimental) The root directory of the project.
TypeScriptProject.Builder	TypeScriptProject.Builder.packageManager(NodePackageManager packageManager)	(experimental) The Node Package Manager used to execute scripts.
TypeScriptProject.Builder	TypeScriptProject.Builder.packageName(String packageName)	(experimental) The "name" in package.json.
TypeScriptProject.Builder	TypeScriptProject.Builder.packageValue(Boolean packageValue)	(experimental) Defines a package task that will produce an npm tarball under the artifacts directory (e.g.
TypeScriptProject.Builder	TypeScriptProject.Builder.parent(Project parent)	(experimental) The parent project, if this project is part of a bigger project.
TypeScriptProject.Builder	TypeScriptProject.Builder.peerDependencyOptions(PeerDependencyOptions peerDependencyOptions)	(experimental) Options for peerDeps.
TypeScriptProject.Builder	TypeScriptProject.Builder.peerDeps(List<String> peerDeps)	(experimental) Peer dependencies for this module.
TypeScriptProject.Builder	TypeScriptProject.Builder.pnpmVersion(String pnpmVersion)	(experimental) The version of PNPM to use if using PNPM as a package manager.
TypeScriptProject.Builder	TypeScriptProject.Builder.postBuildSteps(List<? extends JobStep> postBuildSteps)	(experimental) Steps to execute after build as part of the release workflow.
TypeScriptProject.Builder	TypeScriptProject.Builder.prerelease(String prerelease)	(experimental) Bump versions from the default branch as pre-releases (e.g.
TypeScriptProject.Builder	TypeScriptProject.Builder.prettier(Boolean prettier)	(experimental) Setup prettier.
TypeScriptProject.Builder	TypeScriptProject.Builder.prettierOptions(PrettierOptions prettierOptions)	(experimental) Prettier options.
TypeScriptProject.Builder	TypeScriptProject.Builder.projectType(ProjectType projectType)	Deprecated. no longer supported at the base project level
TypeScriptProject.Builder	TypeScriptProject.Builder.projenCommand(String projenCommand)	(experimental) The shell command to use in order to run the projen CLI.
TypeScriptProject.Builder	TypeScriptProject.Builder.projenCredentials(GithubCredentials projenCredentials)	(experimental) Choose a method of providing GitHub API access for projen workflows.
TypeScriptProject.Builder	TypeScriptProject.Builder.projenDevDependency(Boolean projenDevDependency)	(experimental) Indicates of "projen" should be installed as a devDependency.
TypeScriptProject.Builder	TypeScriptProject.Builder.projenrcJs(Boolean projenrcJs)	(experimental) Generate (once) .projenrc.js (in JavaScript).
TypeScriptProject.Builder	TypeScriptProject.Builder.projenrcJson(Boolean projenrcJson)	(experimental) Generate (once) .projenrc.json (in JSON).
TypeScriptProject.Builder	TypeScriptProject.Builder.projenrcJsonOptions(ProjenrcJsonOptions projenrcJsonOptions)	(experimental) Options for .projenrc.json.
TypeScriptProject.Builder	TypeScriptProject.Builder.projenrcJsOptions(ProjenrcOptions projenrcJsOptions)	(experimental) Options for .projenrc.js.
TypeScriptProject.Builder	TypeScriptProject.Builder.projenrcTs(Boolean projenrcTs)	(experimental) Use TypeScript for your projenrc file (.projenrc.ts).
TypeScriptProject.Builder	TypeScriptProject.Builder.projenrcTsOptions(ProjenrcOptions projenrcTsOptions)	(experimental) Options for .projenrc.ts.
TypeScriptProject.Builder	TypeScriptProject.Builder.projenTokenSecret(String projenTokenSecret)	Deprecated. use projenCredentials
TypeScriptProject.Builder	TypeScriptProject.Builder.projenVersion(String projenVersion)	(experimental) Version of projen to install.
TypeScriptProject.Builder	TypeScriptProject.Builder.publishDryRun(Boolean publishDryRun)	(experimental) Instead of actually publishing to package managers, just print the publishing command.
TypeScriptProject.Builder	TypeScriptProject.Builder.publishTasks(Boolean publishTasks)	(experimental) Define publishing tasks that can be executed manually as well as workflows.
TypeScriptProject.Builder	TypeScriptProject.Builder.pullRequestTemplate(Boolean pullRequestTemplate)	(experimental) Include a GitHub pull request template.
TypeScriptProject.Builder	TypeScriptProject.Builder.pullRequestTemplateContents(List<String> pullRequestTemplateContents)	(experimental) The contents of the pull request template.
TypeScriptProject.Builder	TypeScriptProject.Builder.readme(SampleReadmeProps readme)	(experimental) The README setup.
TypeScriptProject.Builder	TypeScriptProject.Builder.releasableCommits(ReleasableCommits releasableCommits)	(experimental) Find commits that should be considered releasable Used to decide if a release is required.
TypeScriptProject.Builder	TypeScriptProject.Builder.release(Boolean release)	(experimental) Add release management to this project.
TypeScriptProject.Builder	TypeScriptProject.Builder.releaseBranches(Map<String,? extends BranchOptions> releaseBranches)	(experimental) Defines additional release branches.
TypeScriptProject.Builder	TypeScriptProject.Builder.releaseEveryCommit(Boolean releaseEveryCommit)	Deprecated. Use releaseTrigger: ReleaseTrigger.continuous() instead
TypeScriptProject.Builder	TypeScriptProject.Builder.releaseFailureIssue(Boolean releaseFailureIssue)	(experimental) Create a github issue on every failed publishing task.
TypeScriptProject.Builder	TypeScriptProject.Builder.releaseFailureIssueLabel(String releaseFailureIssueLabel)	(experimental) The label to apply to issues indicating publish failures.
TypeScriptProject.Builder	TypeScriptProject.Builder.releaseSchedule(String releaseSchedule)	Deprecated. Use releaseTrigger: ReleaseTrigger.scheduled() instead
TypeScriptProject.Builder	TypeScriptProject.Builder.releaseTagPrefix(String releaseTagPrefix)	(experimental) Automatically add the given prefix to release tags.
TypeScriptProject.Builder	TypeScriptProject.Builder.releaseToNpm(Boolean releaseToNpm)	(experimental) Automatically release to npm when new versions are introduced.
TypeScriptProject.Builder	TypeScriptProject.Builder.releaseTrigger(ReleaseTrigger releaseTrigger)	(experimental) The release trigger to use.
TypeScriptProject.Builder	TypeScriptProject.Builder.releaseWorkflow(Boolean releaseWorkflow)	Deprecated. see release.
TypeScriptProject.Builder	TypeScriptProject.Builder.releaseWorkflowName(String releaseWorkflowName)	(experimental) The name of the default release workflow.
TypeScriptProject.Builder	TypeScriptProject.Builder.releaseWorkflowSetupSteps(List<? extends JobStep> releaseWorkflowSetupSteps)	(experimental) A set of workflow steps to execute in order to setup the workflow container.
TypeScriptProject.Builder	TypeScriptProject.Builder.renovatebot(Boolean renovatebot)	(experimental) Use renovatebot to handle dependency upgrades.
TypeScriptProject.Builder	TypeScriptProject.Builder.renovatebotOptions(RenovatebotOptions renovatebotOptions)	(experimental) Options for renovatebot.
TypeScriptProject.Builder	TypeScriptProject.Builder.repository(String repository)	(experimental) The repository is the location where the actual code for your package lives.
TypeScriptProject.Builder	TypeScriptProject.Builder.repositoryDirectory(String repositoryDirectory)	(experimental) If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives.
TypeScriptProject.Builder	TypeScriptProject.Builder.sampleCode(Boolean sampleCode)	(experimental) Generate one-time sample in src/ and test/ if there are no files there.
TypeScriptProject.Builder	TypeScriptProject.Builder.scopedPackagesOptions(List<? extends ScopedPackagesOptions> scopedPackagesOptions)	(experimental) Options for privately hosted scoped packages.
TypeScriptProject.Builder	TypeScriptProject.Builder.scripts(Map<String,String> scripts)	Deprecated. use project.addTask() or package.setScript()
TypeScriptProject.Builder	TypeScriptProject.Builder.srcdir(String srcdir)	(experimental) Typescript sources directory.
TypeScriptProject.Builder	TypeScriptProject.Builder.stability(String stability)	(experimental) Package's Stability.
TypeScriptProject.Builder	TypeScriptProject.Builder.stale(Boolean stale)	(experimental) Auto-close of stale issues and pull request.
TypeScriptProject.Builder	TypeScriptProject.Builder.staleOptions(StaleOptions staleOptions)	(experimental) Auto-close stale issues and pull requests.
TypeScriptProject.Builder	TypeScriptProject.Builder.testdir(String testdir)	(experimental) Jest tests directory.
TypeScriptProject.Builder	TypeScriptProject.Builder.tsconfig(TypescriptConfigOptions tsconfig)	(experimental) Custom TSConfig.
TypeScriptProject.Builder	TypeScriptProject.Builder.tsconfigDev(TypescriptConfigOptions tsconfigDev)	(experimental) Custom tsconfig options for the development tsconfig.json file (used for testing).
TypeScriptProject.Builder	TypeScriptProject.Builder.tsconfigDevFile(String tsconfigDevFile)	(experimental) The name of the development tsconfig.json file.
TypeScriptProject.Builder	TypeScriptProject.Builder.tsJestOptions(TsJestOptions tsJestOptions)	(experimental) Options for ts-jest.
TypeScriptProject.Builder	TypeScriptProject.Builder.typescriptVersion(String typescriptVersion)	(experimental) TypeScript version to use.
TypeScriptProject.Builder	TypeScriptProject.Builder.versionrcOptions(Map<String,? extends Object> versionrcOptions)	(experimental) Custom configuration used when creating changelog with standard-version package.
TypeScriptProject.Builder	TypeScriptProject.Builder.vscode(Boolean vscode)	(experimental) Enable VSCode integration.
TypeScriptProject.Builder	TypeScriptProject.Builder.workflowBootstrapSteps(List<? extends JobStep> workflowBootstrapSteps)	(experimental) Workflow steps to use in order to bootstrap this repo.
TypeScriptProject.Builder	TypeScriptProject.Builder.workflowContainerImage(String workflowContainerImage)	(experimental) Container image to use for GitHub workflows.
TypeScriptProject.Builder	TypeScriptProject.Builder.workflowGitIdentity(GitIdentity workflowGitIdentity)	(experimental) The git identity to use in workflows.
TypeScriptProject.Builder	TypeScriptProject.Builder.workflowNodeVersion(String workflowNodeVersion)	(experimental) The node version to use in GitHub workflows.
TypeScriptProject.Builder	TypeScriptProject.Builder.workflowPackageCache(Boolean workflowPackageCache)	(experimental) Enable Node.js package cache in GitHub workflows.
TypeScriptProject.Builder	TypeScriptProject.Builder.workflowRunsOn(List<String> workflowRunsOn)	(experimental) Github Runner selection labels.
TypeScriptProject.Builder	TypeScriptProject.Builder.workflowRunsOnGroup(GroupRunnerOptions workflowRunsOnGroup)	(experimental) Github Runner Group selection options.
TypeScriptProject.Builder	TypeScriptProject.Builder.yarnBerryOptions(YarnBerryOptions yarnBerryOptions)	(experimental) Options for Yarn Berry.