Uses of Class
io.github.cdklabs.projen.javascript.NodeProject.Builder

Packages that use NodeProject.Builder

Package	Description
io.github.cdklabs.projen.javascript

Uses of NodeProject.Builder in io.github.cdklabs.projen.javascript

Methods in io.github.cdklabs.projen.javascript that return NodeProject.Builder

Modifier and Type	Method and Description
NodeProject.Builder	NodeProject.Builder.allowLibraryDependencies(Boolean allowLibraryDependencies) (experimental) Allow the project to include `peerDependencies` and `bundledDependencies`.
NodeProject.Builder	NodeProject.Builder.antitamper(Boolean antitamper) (experimental) Checks that after build there are no modified files on git.
NodeProject.Builder	NodeProject.Builder.artifactsDirectory(String artifactsDirectory) (experimental) A directory which will contain artifacts to be published to npm.
NodeProject.Builder	NodeProject.Builder.authorEmail(String authorEmail) (experimental) Author's e-mail.
NodeProject.Builder	NodeProject.Builder.authorName(String authorName) (experimental) Author's name.
NodeProject.Builder	NodeProject.Builder.authorOrganization(Boolean authorOrganization) (experimental) Author's Organization.
NodeProject.Builder	NodeProject.Builder.authorUrl(String authorUrl) (experimental) Author's URL / Website.
NodeProject.Builder	NodeProject.Builder.autoApproveOptions(AutoApproveOptions autoApproveOptions) (experimental) Enable and configure the 'auto approve' workflow.
NodeProject.Builder	NodeProject.Builder.autoApproveProjenUpgrades(Boolean autoApproveProjenUpgrades) (experimental) Automatically approve projen upgrade PRs, allowing them to be merged by mergify (if configued).
NodeProject.Builder	NodeProject.Builder.autoApproveUpgrades(Boolean autoApproveUpgrades) (experimental) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued).
NodeProject.Builder	NodeProject.Builder.autoDetectBin(Boolean autoDetectBin) (experimental) Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.
NodeProject.Builder	NodeProject.Builder.autoMergeOptions(AutoMergeOptions autoMergeOptions) (experimental) Configure options for automatic merging on GitHub.
NodeProject.Builder	NodeProject.Builder.bin(Map<String,String> bin) (experimental) Binary programs vended with your module.
NodeProject.Builder	NodeProject.Builder.buildWorkflow(Boolean buildWorkflow) (experimental) Define a GitHub workflow for building PRs.
NodeProject.Builder	NodeProject.Builder.bundledDeps(List<String> bundledDeps) (experimental) List of dependencies to bundle into this module.
NodeProject.Builder	NodeProject.Builder.bundlerOptions(BundlerOptions bundlerOptions) (experimental) Options for `Bundler`.
NodeProject.Builder	NodeProject.Builder.clobber(Boolean clobber) (experimental) Add a `clobber` task which resets the repo to origin.
NodeProject.Builder	NodeProject.Builder.codeArtifactOptions(CodeArtifactOptions codeArtifactOptions) (experimental) Options for publishing npm package to AWS CodeArtifact.
NodeProject.Builder	NodeProject.Builder.codeCov(Boolean codeCov) (experimental) 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.
NodeProject.Builder	NodeProject.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.
NodeProject.Builder	NodeProject.Builder.copyrightOwner(String copyrightOwner) (experimental) License copyright owner.
NodeProject.Builder	NodeProject.Builder.copyrightPeriod(String copyrightPeriod) (experimental) The copyright years to put in the LICENSE file.
static NodeProject.Builder	NodeProject.Builder.create()
NodeProject.Builder	NodeProject.Builder.defaultReleaseBranch(String defaultReleaseBranch) (experimental) The name of the main release branch.
NodeProject.Builder	NodeProject.Builder.dependabot(Boolean dependabot) (experimental) Use dependabot to handle dependency upgrades.
NodeProject.Builder	NodeProject.Builder.dependabotOptions(DependabotOptions dependabotOptions) (experimental) Options for dependabot.
NodeProject.Builder	NodeProject.Builder.deps(List<String> deps) (experimental) Runtime dependencies of this module.
NodeProject.Builder	NodeProject.Builder.depsUpgrade(Boolean depsUpgrade) (experimental) Use github workflows to handle dependency upgrades.
NodeProject.Builder	NodeProject.Builder.depsUpgradeOptions(UpgradeDependenciesOptions depsUpgradeOptions) (experimental) Options for depsUpgrade.
NodeProject.Builder	NodeProject.Builder.description(String description) (experimental) The description is just a string that helps people understand the purpose of the package.
NodeProject.Builder	NodeProject.Builder.devContainer(Boolean devContainer) (experimental) Add a VSCode development environment (used for GitHub Codespaces).
NodeProject.Builder	NodeProject.Builder.devDeps(List<String> devDeps) (experimental) Build dependencies for this module.
NodeProject.Builder	NodeProject.Builder.entrypoint(String entrypoint) (experimental) Module entrypoint (`main` in `package.json`).
NodeProject.Builder	NodeProject.Builder.github(Boolean github) (experimental) Enable GitHub integration.
NodeProject.Builder	NodeProject.Builder.githubOptions(GitHubOptions githubOptions) (experimental) Options for GitHub integration.
NodeProject.Builder	NodeProject.Builder.gitignore(List<String> gitignore) (experimental) Additional entries to .gitignore.
NodeProject.Builder	NodeProject.Builder.gitpod(Boolean gitpod) (experimental) Add a Gitpod development environment.
NodeProject.Builder	NodeProject.Builder.homepage(String homepage) (experimental) Package's Homepage / Website.
NodeProject.Builder	NodeProject.Builder.jest(Boolean jest) (experimental) Setup jest unit tests.
NodeProject.Builder	NodeProject.Builder.jestOptions(JestOptions jestOptions) (experimental) Jest options.
NodeProject.Builder	NodeProject.Builder.jsiiReleaseVersion(String jsiiReleaseVersion) (experimental) Version requirement of `jsii-release` which is used to publish modules to npm.
NodeProject.Builder	NodeProject.Builder.keywords(List<String> keywords) (experimental) Keywords to include in `package.json`.
NodeProject.Builder	NodeProject.Builder.license(String license) (experimental) License's SPDX identifier.
NodeProject.Builder	NodeProject.Builder.licensed(Boolean licensed) (experimental) Indicates if a license should be added.
NodeProject.Builder	NodeProject.Builder.logging(LoggerOptions logging) (experimental) Configure logging options such as verbosity.
NodeProject.Builder	NodeProject.Builder.majorVersion(Number majorVersion) (experimental) Major version to release from the default branch.
NodeProject.Builder	NodeProject.Builder.maxNodeVersion(String maxNodeVersion) (experimental) Minimum node.js version to require via `engines` (inclusive).
NodeProject.Builder	NodeProject.Builder.mergify(Boolean mergify) Deprecated. use `githubOptions.mergify` instead
NodeProject.Builder	NodeProject.Builder.mergifyOptions(MergifyOptions mergifyOptions) Deprecated. use `githubOptions.mergifyOptions` instead
NodeProject.Builder	NodeProject.Builder.minNodeVersion(String minNodeVersion) (experimental) Minimum Node.js version to require via package.json `engines` (inclusive).
NodeProject.Builder	NodeProject.Builder.mutableBuild(Boolean mutableBuild) (experimental) Automatically update files modified during builds to pull-request branches.
NodeProject.Builder	NodeProject.Builder.name(String name) (experimental) This is the name of your project.
NodeProject.Builder	NodeProject.Builder.npmAccess(NpmAccess npmAccess) (experimental) Access level of the npm package.
NodeProject.Builder	NodeProject.Builder.npmDistTag(String npmDistTag) (experimental) The npmDistTag to use when publishing from the default branch.
NodeProject.Builder	NodeProject.Builder.npmignore(List<String> npmignore) Deprecated. - use `project.addPackageIgnore`
NodeProject.Builder	NodeProject.Builder.npmignoreEnabled(Boolean npmignoreEnabled) (experimental) Defines an .npmignore file.
NodeProject.Builder	NodeProject.Builder.npmRegistry(String npmRegistry) Deprecated. use `npmRegistryUrl` instead
NodeProject.Builder	NodeProject.Builder.npmRegistryUrl(String npmRegistryUrl) (experimental) The base URL of the npm package registry.
NodeProject.Builder	NodeProject.Builder.npmTokenSecret(String npmTokenSecret) (experimental) GitHub secret which contains the NPM token to use when publishing packages.
NodeProject.Builder	NodeProject.Builder.outdir(String outdir) (experimental) The root directory of the project.
NodeProject.Builder	NodeProject.Builder.packageManager(NodePackageManager packageManager) (experimental) The Node Package Manager used to execute scripts.
NodeProject.Builder	NodeProject.Builder.packageName(String packageName) (experimental) The "name" in package.json.
NodeProject.Builder	NodeProject.Builder.parent(Project parent) (experimental) The parent project, if this project is part of a bigger project.
NodeProject.Builder	NodeProject.Builder.peerDependencyOptions(PeerDependencyOptions peerDependencyOptions) (experimental) Options for `peerDeps`.
NodeProject.Builder	NodeProject.Builder.peerDeps(List<String> peerDeps) (experimental) Peer dependencies for this module.
NodeProject.Builder	NodeProject.Builder.postBuildSteps(List<? extends JobStep> postBuildSteps) (experimental) Steps to execute after build as part of the release workflow.
NodeProject.Builder	NodeProject.Builder.prerelease(String prerelease) (experimental) Bump versions from the default branch as pre-releases (e.g.
NodeProject.Builder	NodeProject.Builder.projectType(ProjectType projectType) Deprecated. no longer supported at the base project level
NodeProject.Builder	NodeProject.Builder.projenCommand(String projenCommand) (experimental) The shell command to use in order to run the projen CLI.
NodeProject.Builder	NodeProject.Builder.projenDevDependency(Boolean projenDevDependency) (experimental) Indicates of "projen" should be installed as a devDependency.
NodeProject.Builder	NodeProject.Builder.projenrcJs(Boolean projenrcJs) (experimental) Generate (once) .projenrc.js (in JavaScript).
NodeProject.Builder	NodeProject.Builder.projenrcJson(Boolean projenrcJson) (experimental) Generate (once) .projenrc.json (in JSON).
NodeProject.Builder	NodeProject.Builder.projenrcJsonOptions(ProjenrcOptions projenrcJsonOptions) (experimental) Options for .projenrc.json.
NodeProject.Builder	NodeProject.Builder.projenrcJsOptions(ProjenrcOptions projenrcJsOptions) (experimental) Options for .projenrc.js.
NodeProject.Builder	NodeProject.Builder.projenUpgradeAutoMerge(Boolean projenUpgradeAutoMerge) Deprecated. use `autoApproveProjenUpgrades`.
NodeProject.Builder	NodeProject.Builder.projenUpgradeSchedule(List<String> projenUpgradeSchedule) (experimental) Customize the projenUpgrade schedule in cron expression.
NodeProject.Builder	NodeProject.Builder.projenUpgradeSecret(String projenUpgradeSecret) (experimental) Periodically submits a pull request for projen upgrades (executes `yarn projen:upgrade`).
NodeProject.Builder	NodeProject.Builder.projenVersion(String projenVersion) (experimental) Version of projen to install.
NodeProject.Builder	NodeProject.Builder.publishTasks(Boolean publishTasks) (experimental) Define publishing tasks that can be executed manually as well as workflows.
NodeProject.Builder	NodeProject.Builder.pullRequestTemplate(Boolean pullRequestTemplate) (experimental) Include a GitHub pull request template.
NodeProject.Builder	NodeProject.Builder.pullRequestTemplateContents(List<String> pullRequestTemplateContents) (experimental) The contents of the pull request template.
NodeProject.Builder	NodeProject.Builder.readme(SampleReadmeProps readme) (experimental) The README setup.
NodeProject.Builder	NodeProject.Builder.release(Boolean release) (experimental) Add release management to this project.
NodeProject.Builder	NodeProject.Builder.releaseBranches(Map<String,? extends BranchOptions> releaseBranches) (experimental) Defines additional release branches.
NodeProject.Builder	NodeProject.Builder.releaseEveryCommit(Boolean releaseEveryCommit) Deprecated. Use `releaseTrigger: ReleaseTrigger.continuous()` instead
NodeProject.Builder	NodeProject.Builder.releaseFailureIssue(Boolean releaseFailureIssue) (experimental) Create a github issue on every failed publishing task.
NodeProject.Builder	NodeProject.Builder.releaseFailureIssueLabel(String releaseFailureIssueLabel) (experimental) The label to apply to issues indicating publish failures.
NodeProject.Builder	NodeProject.Builder.releaseSchedule(String releaseSchedule) Deprecated. Use `releaseTrigger: ReleaseTrigger.scheduled()` instead
NodeProject.Builder	NodeProject.Builder.releaseTagPrefix(String releaseTagPrefix) (experimental) Automatically add the given prefix to release tags.
NodeProject.Builder	NodeProject.Builder.releaseToNpm(Boolean releaseToNpm) (experimental) Automatically release to npm when new versions are introduced.
NodeProject.Builder	NodeProject.Builder.releaseTrigger(ReleaseTrigger releaseTrigger) (experimental) The release trigger to use.
NodeProject.Builder	NodeProject.Builder.releaseWorkflow(Boolean releaseWorkflow) Deprecated. see `release`.
NodeProject.Builder	NodeProject.Builder.releaseWorkflowName(String releaseWorkflowName) (experimental) The name of the default release workflow.
NodeProject.Builder	NodeProject.Builder.releaseWorkflowSetupSteps(List<? extends JobStep> releaseWorkflowSetupSteps) (experimental) A set of workflow steps to execute in order to setup the workflow container.
NodeProject.Builder	NodeProject.Builder.repository(String repository) (experimental) The repository is the location where the actual code for your package lives.
NodeProject.Builder	NodeProject.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.
NodeProject.Builder	NodeProject.Builder.scripts(Map<String,String> scripts) (experimental) npm scripts to include.
NodeProject.Builder	NodeProject.Builder.stability(String stability) (experimental) Package's Stability.
NodeProject.Builder	NodeProject.Builder.stale(Boolean stale) (experimental) Auto-close of stale issues and pull request.
NodeProject.Builder	NodeProject.Builder.staleOptions(StaleOptions staleOptions) (experimental) Auto-close stale issues and pull requests.
NodeProject.Builder	NodeProject.Builder.versionrcOptions(Map<String,? extends Object> versionrcOptions) (experimental) Custom configuration used when creating changelog with standard-version package.
NodeProject.Builder	NodeProject.Builder.vscode(Boolean vscode) (experimental) Enable VSCode integration.
NodeProject.Builder	NodeProject.Builder.workflowBootstrapSteps(List<? extends Object> workflowBootstrapSteps) (experimental) Workflow steps to use in order to bootstrap this repo.
NodeProject.Builder	NodeProject.Builder.workflowContainerImage(String workflowContainerImage) (experimental) Container image to use for GitHub workflows.
NodeProject.Builder	NodeProject.Builder.workflowGitIdentity(GitIdentity workflowGitIdentity) (experimental) The git identity to use in workflows.
NodeProject.Builder	NodeProject.Builder.workflowNodeVersion(String workflowNodeVersion) (experimental) The node version to use in GitHub workflows.
NodeProject.Builder	NodeProject.Builder.workflowRunsOn(List<String> workflowRunsOn) (experimental) Github Runner selection labels.