@Stability(value=Experimental) public static final class ReactTypeScriptProjectOptions.Builder extends Object implements software.amazon.jsii.Builder<ReactTypeScriptProjectOptions>
ReactTypeScriptProjectOptions| Constructor and Description |
|---|
Builder() |
@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder disableTsconfig(Boolean disableTsconfig)
TypeScriptProjectOptions.getDisableTsconfig()disableTsconfig - Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler).this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder docgen(Boolean docgen)
TypeScriptProjectOptions.getDocgen()docgen - Docgen by Typedoc.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder docsDirectory(String docsDirectory)
TypeScriptProjectOptions.getDocsDirectory()docsDirectory - Docs directory.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder entrypointTypes(String entrypointTypes)
TypeScriptProjectOptions.getEntrypointTypes()entrypointTypes - The .d.ts file that includes the type declarations for this module.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder eslint(Boolean eslint)
TypeScriptProjectOptions.getEslint()eslint - Setup eslint.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder eslintOptions(EslintOptions eslintOptions)
TypeScriptProjectOptions.getEslintOptions()eslintOptions - Eslint options.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder libdir(String libdir)
TypeScriptProjectOptions.getLibdir()libdir - Typescript artifacts output directory.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder packageValue(Boolean packageValue)
TypeScriptProjectOptions.getPackageValue()packageValue - Defines a `yarn package` command that will produce a tarball and place it under `dist/js`.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder projenrcTs(Boolean projenrcTs)
TypeScriptProjectOptions.getProjenrcTs()projenrcTs - Use TypeScript for your projenrc file (`.projenrc.ts`).this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder projenrcTsOptions(ProjenrcOptions projenrcTsOptions)
TypeScriptProjectOptions.getProjenrcTsOptions()projenrcTsOptions - Options for .projenrc.ts.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder sampleCode(Boolean sampleCode)
TypeScriptProjectOptions.getSampleCode()sampleCode - Generate one-time sample in `src/` and `test/` if there are no files there.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder srcdir(String srcdir)
TypeScriptProjectOptions.getSrcdir()srcdir - Typescript sources directory.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder testdir(String testdir)
TypeScriptProjectOptions.getTestdir()testdir - 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.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder tsconfig(TypescriptConfigOptions tsconfig)
TypeScriptProjectOptions.getTsconfig()tsconfig - Custom TSConfig.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder tsconfigDev(TypescriptConfigOptions tsconfigDev)
TypeScriptProjectOptions.getTsconfigDev()tsconfigDev - Custom tsconfig options for the development tsconfig.json file (used for testing).this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder tsconfigDevFile(String tsconfigDevFile)
TypeScriptProjectOptions.getTsconfigDevFile()tsconfigDevFile - The name of the development tsconfig.json file.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder typescriptVersion(String typescriptVersion)
TypeScriptProjectOptions.getTypescriptVersion()typescriptVersion - 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).this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder defaultReleaseBranch(String defaultReleaseBranch)
NodeProjectOptions.getDefaultReleaseBranch()defaultReleaseBranch - The name of the main release branch. This parameter is required.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder autoApproveProjenUpgrades(Boolean autoApproveProjenUpgrades)
NodeProjectOptions.getAutoApproveProjenUpgrades()autoApproveProjenUpgrades - Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).
Throw if set to true but autoApproveOptions are not defined.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder autoApproveUpgrades(Boolean autoApproveUpgrades)
NodeProjectOptions.getAutoApproveUpgrades()autoApproveUpgrades - Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).
Throw if set to true but autoApproveOptions are not defined.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder buildWorkflow(Boolean buildWorkflow)
NodeProjectOptions.getBuildWorkflow()buildWorkflow - Define a GitHub workflow for building PRs.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder bundlerOptions(BundlerOptions bundlerOptions)
NodeProjectOptions.getBundlerOptions()bundlerOptions - Options for `Bundler`.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder codeCov(Boolean codeCov)
NodeProjectOptions.getCodeCov()codeCov - Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v1 A secret is required for private repos. Configured with @codeCovTokenSecret.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder codeCovTokenSecret(String codeCovTokenSecret)
NodeProjectOptions.getCodeCovTokenSecret()codeCovTokenSecret - Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder copyrightOwner(String copyrightOwner)
NodeProjectOptions.getCopyrightOwner()copyrightOwner - License copyright owner.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder copyrightPeriod(String copyrightPeriod)
NodeProjectOptions.getCopyrightPeriod()copyrightPeriod - The copyright years to put in the LICENSE file.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder dependabot(Boolean dependabot)
NodeProjectOptions.getDependabot()dependabot - Use dependabot to handle dependency upgrades.
Cannot be used in conjunction with depsUpgrade.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder dependabotOptions(DependabotOptions dependabotOptions)
NodeProjectOptions.getDependabotOptions()dependabotOptions - Options for dependabot.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder depsUpgrade(Boolean depsUpgrade)
NodeProjectOptions.getDepsUpgrade()depsUpgrade - Use github workflows to handle dependency upgrades.
Cannot be used in conjunction with dependabot.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder depsUpgradeOptions(UpgradeDependenciesOptions depsUpgradeOptions)
NodeProjectOptions.getDepsUpgradeOptions()depsUpgradeOptions - Options for depsUpgrade.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder gitignore(List<String> gitignore)
NodeProjectOptions.getGitignore()gitignore - Additional entries to .gitignore.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder jest(Boolean jest)
NodeProjectOptions.getJest()jest - Setup jest unit tests.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder jestOptions(JestOptions jestOptions)
NodeProjectOptions.getJestOptions()jestOptions - Jest options.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder mutableBuild(Boolean mutableBuild)
NodeProjectOptions.getMutableBuild()mutableBuild - Automatically update files modified during builds to pull-request branches.
This means
that any files synthesized by projen or e.g. test snapshots will always be up-to-date
before a PR is merged.
Implies that PR builds do not have anti-tamper checks.
this@Stability(value=Deprecated) @Deprecated public ReactTypeScriptProjectOptions.Builder npmignore(List<String> npmignore)
NodeProjectOptions.getNpmignore()npmignore - Additional entries to .npmignore.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder npmignoreEnabled(Boolean npmignoreEnabled)
NodeProjectOptions.getNpmignoreEnabled()npmignoreEnabled - Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder projenDevDependency(Boolean projenDevDependency)
NodeProjectOptions.getProjenDevDependency()projenDevDependency - Indicates of "projen" should be installed as a devDependency.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder projenrcJs(Boolean projenrcJs)
NodeProjectOptions.getProjenrcJs()projenrcJs - Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder projenrcJsOptions(ProjenrcOptions projenrcJsOptions)
NodeProjectOptions.getProjenrcJsOptions()projenrcJsOptions - Options for .projenrc.js.this@Stability(value=Deprecated) @Deprecated public ReactTypeScriptProjectOptions.Builder projenUpgradeAutoMerge(Boolean projenUpgradeAutoMerge)
NodeProjectOptions.getProjenUpgradeAutoMerge()projenUpgradeAutoMerge - Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).
Throw if set to true but autoApproveOptions are not defined.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder projenUpgradeSchedule(List<String> projenUpgradeSchedule)
NodeProjectOptions.getProjenUpgradeSchedule()projenUpgradeSchedule - Customize the projenUpgrade schedule in cron expression.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder projenUpgradeSecret(String projenUpgradeSecret)
NodeProjectOptions.getProjenUpgradeSecret()projenUpgradeSecret - Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).
This setting is a GitHub secret name which contains a GitHub Access Token
with repo and workflow permissions.
This token is used to submit the upgrade pull request, which will likely include workflow updates.
To create a personal access token see https://github.com/settings/tokens
this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder projenVersion(String projenVersion)
NodeProjectOptions.getProjenVersion()projenVersion - Version of projen to install.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder pullRequestTemplate(Boolean pullRequestTemplate)
NodeProjectOptions.getPullRequestTemplate()pullRequestTemplate - Include a GitHub pull request template.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder pullRequestTemplateContents(List<String> pullRequestTemplateContents)
NodeProjectOptions.getPullRequestTemplateContents()pullRequestTemplateContents - The contents of the pull request template.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder release(Boolean release)
NodeProjectOptions.getRelease()release - Add release management to this project.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder releaseToNpm(Boolean releaseToNpm)
NodeProjectOptions.getReleaseToNpm()releaseToNpm - Automatically release to npm when new versions are introduced.this@Stability(value=Deprecated) @Deprecated public ReactTypeScriptProjectOptions.Builder releaseWorkflow(Boolean releaseWorkflow)
NodeProjectOptions.getReleaseWorkflow()releaseWorkflow - DEPRECATED: renamed to `release`.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder workflowBootstrapSteps(List<? extends Object> workflowBootstrapSteps)
NodeProjectOptions.getWorkflowBootstrapSteps()workflowBootstrapSteps - Workflow steps to use in order to bootstrap this repo.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder workflowGitIdentity(GitIdentity workflowGitIdentity)
NodeProjectOptions.getWorkflowGitIdentity()workflowGitIdentity - The git identity to use in workflows.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder workflowNodeVersion(String workflowNodeVersion)
NodeProjectOptions.getWorkflowNodeVersion()workflowNodeVersion - The node version to use in GitHub workflows.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder autoApproveOptions(AutoApproveOptions autoApproveOptions)
GitHubProjectOptions.getAutoApproveOptions()autoApproveOptions - Enable and configure the 'auto approve' workflow.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder autoMergeOptions(AutoMergeOptions autoMergeOptions)
GitHubProjectOptions.getAutoMergeOptions()autoMergeOptions - Configure options for automatic merging on GitHub.
Has no effect if
github.mergify is set to false.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder clobber(Boolean clobber)
GitHubProjectOptions.getClobber()clobber - Add a `clobber` task which resets the repo to origin.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder devContainer(Boolean devContainer)
GitHubProjectOptions.getDevContainer()devContainer - Add a VSCode development environment (used for GitHub Codespaces).this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder github(Boolean github)
GitHubProjectOptions.getGithub()github - Enable GitHub integration.
Enabled by default for root projects. Disabled for non-root projects.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder githubOptions(GitHubOptions githubOptions)
GitHubProjectOptions.getGithubOptions()githubOptions - Options for GitHub integration.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder gitpod(Boolean gitpod)
GitHubProjectOptions.getGitpod()gitpod - Add a Gitpod development environment.this@Stability(value=Deprecated) @Deprecated public ReactTypeScriptProjectOptions.Builder mergify(Boolean mergify)
GitHubProjectOptions.getMergify()mergify - Whether mergify should be enabled on this repository or not.this@Stability(value=Deprecated) @Deprecated public ReactTypeScriptProjectOptions.Builder mergifyOptions(MergifyOptions mergifyOptions)
GitHubProjectOptions.getMergifyOptions()mergifyOptions - Options for mergify.this@Stability(value=Deprecated) @Deprecated public ReactTypeScriptProjectOptions.Builder projectType(ProjectType projectType)
GitHubProjectOptions.getProjectType()projectType - Which type of project this is (library/app).this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder readme(SampleReadmeProps readme)
GitHubProjectOptions.getReadme()readme - The README setup.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder stale(Boolean stale)
GitHubProjectOptions.getStale()stale - Auto-close of stale issues and pull request.
See staleOptions for options.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder staleOptions(StaleOptions staleOptions)
GitHubProjectOptions.getStaleOptions()staleOptions - Auto-close stale issues and pull requests.
To disable set stale to false.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder vscode(Boolean vscode)
GitHubProjectOptions.getVscode()vscode - Enable VSCode integration.
Enabled by default for root projects. Disabled for non-root projects.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder name(String name)
ProjectOptions.getName()name - This is the name of your project. This parameter is required.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder logging(LoggerOptions logging)
ProjectOptions.getLogging()logging - Configure logging options such as verbosity.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder outdir(String outdir)
ProjectOptions.getOutdir()outdir - The root directory of the project.
Relative to this directory, all files are synthesized.
If this project has a parent, this directory is relative to the parent directory and it cannot be the same as the parent or any of it's other sub-projects.
this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder parent(Project parent)
ProjectOptions.getParent()parent - The parent project, if this project is part of a bigger project.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder projenCommand(String projenCommand)
ProjectOptions.getProjenCommand()projenCommand - The shell command to use in order to run the projen CLI.
Can be used to customize in special environments.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder projenrcJson(Boolean projenrcJson)
ProjectOptions.getProjenrcJson()projenrcJson - Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder projenrcJsonOptions(ProjenrcOptions projenrcJsonOptions)
ProjectOptions.getProjenrcJsonOptions()projenrcJsonOptions - Options for .projenrc.json.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder allowLibraryDependencies(Boolean allowLibraryDependencies)
NodePackageOptions.getAllowLibraryDependencies()allowLibraryDependencies - Allow the project to include `peerDependencies` and `bundledDependencies`.
This is normally only allowed for libraries. For apps, there's no meaning
for specifying these.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder authorEmail(String authorEmail)
NodePackageOptions.getAuthorEmail()authorEmail - Author's e-mail.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder authorName(String authorName)
NodePackageOptions.getAuthorName()authorName - Author's name.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder authorOrganization(Boolean authorOrganization)
NodePackageOptions.getAuthorOrganization()authorOrganization - Author's Organization.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder authorUrl(String authorUrl)
NodePackageOptions.getAuthorUrl()authorUrl - Author's URL / Website.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder autoDetectBin(Boolean autoDetectBin)
NodePackageOptions.getAutoDetectBin()autoDetectBin - Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder bin(Map<String,String> bin)
NodePackageOptions.getBin()bin - Binary programs vended with your module.
You can use this option to add/customize how binaries are represented in
your package.json, but unless autoDetectBin is false, every
executable file under bin will automatically be added to this section.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder bundledDeps(List<String> bundledDeps)
NodePackageOptions.getBundledDeps()bundledDeps - List of dependencies to bundle into this module.
These modules will be
added both to the dependencies section and bundledDependencies section of
your package.json.
The recommendation is to only specify the module name here (e.g.
express). This will behave similar to yarn add or npm install in the
sense that it will add the module as a dependency to your package.json
file with the latest version (^). You can specify semver requirements in
the same syntax passed to npm i or yarn add (e.g. express@^2) and
this will be what you package.json will eventually include.
this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder codeArtifactOptions(CodeArtifactOptions codeArtifactOptions)
NodePackageOptions.getCodeArtifactOptions()codeArtifactOptions - Options for publishing npm package to AWS CodeArtifact.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder deps(List<String> deps)
NodePackageOptions.getDeps()deps - Runtime dependencies of this module.
The recommendation is to only specify the module name here (e.g.
express). This will behave similar to yarn add or npm install in the
sense that it will add the module as a dependency to your package.json
file with the latest version (^). You can specify semver requirements in
the same syntax passed to npm i or yarn add (e.g. express@^2) and
this will be what you package.json will eventually include.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder description(String description)
NodePackageOptions.getDescription()description - The description is just a string that helps people understand the purpose of the package.
It can be used when searching for packages in a package manager as well.
See https://classic.yarnpkg.com/en/docs/package-json/#toc-descriptionthis@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder devDeps(List<String> devDeps)
NodePackageOptions.getDevDeps()devDeps - Build dependencies for this module.
These dependencies will only be
available in your build environment but will not be fetched when this
module is consumed.
The recommendation is to only specify the module name here (e.g.
express). This will behave similar to yarn add or npm install in the
sense that it will add the module as a dependency to your package.json
file with the latest version (^). You can specify semver requirements in
the same syntax passed to npm i or yarn add (e.g. express@^2) and
this will be what you package.json will eventually include.
this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder entrypoint(String entrypoint)
NodePackageOptions.getEntrypoint()entrypoint - Module entrypoint (`main` in `package.json`).
Set to an empty string to not include main in your package.jsonthis@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder homepage(String homepage)
NodePackageOptions.getHomepage()homepage - Package's Homepage / Website.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder keywords(List<String> keywords)
NodePackageOptions.getKeywords()keywords - Keywords to include in `package.json`.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder license(String license)
NodePackageOptions.getLicense()license - License's SPDX identifier.
See https://github.com/projen/projen/tree/main/license-text for a list of supported licenses.
Use the licensed option if you want to no license to be specified.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder licensed(Boolean licensed)
NodePackageOptions.getLicensed()licensed - Indicates if a license should be added.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder maxNodeVersion(String maxNodeVersion)
NodePackageOptions.getMaxNodeVersion()maxNodeVersion - Minimum node.js version to require via `engines` (inclusive).this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder minNodeVersion(String minNodeVersion)
NodePackageOptions.getMinNodeVersion()minNodeVersion - Minimum Node.js version to require via package.json `engines` (inclusive).this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder npmAccess(NpmAccess npmAccess)
NodePackageOptions.getNpmAccess()npmAccess - Access level of the npm package.this@Stability(value=Deprecated) @Deprecated public ReactTypeScriptProjectOptions.Builder npmRegistry(String npmRegistry)
NodePackageOptions.getNpmRegistry()npmRegistry - The host name of the npm registry to publish to.
Cannot be set together with npmRegistryUrl.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder npmRegistryUrl(String npmRegistryUrl)
NodePackageOptions.getNpmRegistryUrl()npmRegistryUrl - The base URL of the npm package registry.
Must be a URL (e.g. start with "https://" or "http://")this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder npmTokenSecret(String npmTokenSecret)
NodePackageOptions.getNpmTokenSecret()npmTokenSecret - GitHub secret which contains the NPM token to use when publishing packages.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder packageManager(NodePackageManager packageManager)
NodePackageOptions.getPackageManager()packageManager - The Node Package Manager used to execute scripts.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder packageName(String packageName)
NodePackageOptions.getPackageName()packageName - The "name" in package.json.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder peerDependencyOptions(PeerDependencyOptions peerDependencyOptions)
NodePackageOptions.getPeerDependencyOptions()peerDependencyOptions - Options for `peerDeps`.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder peerDeps(List<String> peerDeps)
NodePackageOptions.getPeerDeps()peerDeps - Peer dependencies for this module.
Dependencies listed here are required to
be installed (and satisfied) by the consumer of this library. Using peer
dependencies allows you to ensure that only a single module of a certain
library exists in the node_modules tree of your consumers.
Note that prior to npm@7, peer dependencies are not automatically installed, which means that adding peer dependencies to a library will be a breaking change for your customers.
Unless peerDependencyOptions.pinnedDevDependency is disabled (it is
enabled by default), projen will automatically add a dev dependency with a
pinned version for each peer dependency. This will ensure that you build &
test your module against the lowest peer version required.
this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder repository(String repository)
NodePackageOptions.getRepository()repository - The repository is the location where the actual code for your package lives.
See https://classic.yarnpkg.com/en/docs/package-json/#toc-repositorythis@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder repositoryDirectory(String repositoryDirectory)
NodePackageOptions.getRepositoryDirectory()repositoryDirectory - 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.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder scripts(Map<String,String> scripts)
NodePackageOptions.getScripts()scripts - npm scripts to include.
If a script has the same name as a standard script,
the standard script will be overwritten.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder stability(String stability)
NodePackageOptions.getStability()stability - Package's Stability.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder antitamper(Boolean antitamper)
ReleaseProjectOptions.getAntitamper()antitamper - Checks that after build there are no modified files on git.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder artifactsDirectory(String artifactsDirectory)
ReleaseProjectOptions.getArtifactsDirectory()artifactsDirectory - A directory which will contain artifacts to be published to npm.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder jsiiReleaseVersion(String jsiiReleaseVersion)
ReleaseProjectOptions.getJsiiReleaseVersion()jsiiReleaseVersion - Version requirement of `jsii-release` which is used to publish modules to npm.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder majorVersion(Number majorVersion)
ReleaseProjectOptions.getMajorVersion()majorVersion - Major version to release from the default branch.
If this is specified, we bump the latest version of this major version line.
If not specified, we bump the global latest version.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder npmDistTag(String npmDistTag)
ReleaseProjectOptions.getNpmDistTag()npmDistTag - The npmDistTag to use when publishing from the default branch.
To set the npm dist-tag for release branches, set the npmDistTag property
for each branch.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder postBuildSteps(List<? extends JobStep> postBuildSteps)
ReleaseProjectOptions.getPostBuildSteps()postBuildSteps - Steps to execute after build as part of the release workflow.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder prerelease(String prerelease)
ReleaseProjectOptions.getPrerelease()prerelease - Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre").this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder publishTasks(Boolean publishTasks)
ReleaseProjectOptions.getPublishTasks()publishTasks - Define publishing tasks that can be executed manually as well as workflows.
Normally, publishing only happens within automated workflows. Enable this
in order to create a publishing task for each publishing activity.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder releaseBranches(Map<String,? extends BranchOptions> releaseBranches)
ReleaseProjectOptions.getReleaseBranches()releaseBranches - Defines additional release branches.
A workflow will be created for each
release branch which will publish releases from commits in this branch.
Each release branch must be assigned a major version number which is used
to enforce that versions published from that branch always use that major
version. If multiple branches are used, the majorVersion field must also
be provided for the default branch.this@Stability(value=Deprecated) @Deprecated public ReactTypeScriptProjectOptions.Builder releaseEveryCommit(Boolean releaseEveryCommit)
ReleaseProjectOptions.getReleaseEveryCommit()releaseEveryCommit - Automatically release new versions every commit to one of branches in `releaseBranches`.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder releaseFailureIssue(Boolean releaseFailureIssue)
ReleaseProjectOptions.getReleaseFailureIssue()releaseFailureIssue - Create a github issue on every failed publishing task.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder releaseFailureIssueLabel(String releaseFailureIssueLabel)
ReleaseProjectOptions.getReleaseFailureIssueLabel()releaseFailureIssueLabel - The label to apply to issues indicating publish failures.
Only applies if releaseFailureIssue is true.this@Stability(value=Deprecated) @Deprecated public ReactTypeScriptProjectOptions.Builder releaseSchedule(String releaseSchedule)
ReleaseProjectOptions.getReleaseSchedule()releaseSchedule - CRON schedule to trigger new releases.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder releaseTagPrefix(String releaseTagPrefix)
ReleaseProjectOptions.getReleaseTagPrefix()releaseTagPrefix - Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers.
Note: this prefix is used to detect the latest tagged version
when bumping, so if you change this on a project with an existing version
history, you may need to manually tag your latest release
with the new prefix.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder releaseTrigger(ReleaseTrigger releaseTrigger)
ReleaseProjectOptions.getReleaseTrigger()releaseTrigger - The release trigger to use.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder releaseWorkflowName(String releaseWorkflowName)
ReleaseProjectOptions.getReleaseWorkflowName()releaseWorkflowName - The name of the default release workflow.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder releaseWorkflowSetupSteps(List<? extends JobStep> releaseWorkflowSetupSteps)
ReleaseProjectOptions.getReleaseWorkflowSetupSteps()releaseWorkflowSetupSteps - A set of workflow steps to execute in order to setup the workflow container.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder versionrcOptions(Map<String,? extends Object> versionrcOptions)
ReleaseProjectOptions.getVersionrcOptions()versionrcOptions - Custom configuration used when creating changelog with standard-version package.
Given values either append to default configuration or overwrite values in it.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder workflowContainerImage(String workflowContainerImage)
ReleaseProjectOptions.getWorkflowContainerImage()workflowContainerImage - Container image to use for GitHub workflows.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder workflowRunsOn(List<String> workflowRunsOn)
ReleaseProjectOptions.getWorkflowRunsOn()workflowRunsOn - Github Runner selection labels.this@Stability(value=Experimental) public ReactTypeScriptProjectOptions.Builder rewire(Map<String,? extends Object> rewire)
ReactRewireOptions.getRewire()rewire - Rewire webpack configuration.
Use this property to override webpack configuration properties provided
by create-react-app, without needing to eject.
This property will create a config-overrides.js file in your root directory,
which will contain the desired rewiring code.
To override the configuration, you can provide simple key value pairs. Keys take the form of js code directives that traverse to the desired property. Values should be JSON serializable objects.
For example, the following config:
rewire: { "module.unknownContextCritical": false }
Will translate to the following config-overrides.js file:
module.exports = function override(config, env) {
config.module.unknownContextCritical = false;
}
this@Stability(value=Experimental) public ReactTypeScriptProjectOptions build()
build in interface software.amazon.jsii.Builder<ReactTypeScriptProjectOptions>ReactTypeScriptProjectOptionsNullPointerException - if any required attribute was not providedCopyright © 2021. All rights reserved.