Package io.github.cdklabs.projen.web

Interface NextJsProjectOptions

All Superinterfaces:

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

All Known Implementing Classes:

NextJsProjectOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.341Z")
@Stability(Experimental)
public interface NextJsProjectOptions
extends software.amazon.jsii.JsiiSerializable, NextJsCommonProjectOptions, NodeProjectOptions

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static NextJsProjectOptions.Builder	builder()
default Boolean	getSampleCode()	(experimental) Generate one-time sample in pages/ and public/ if there are no files there.
default String	getSrcdir()	(experimental) Typescript sources directory.

Methods inherited from interface io.github.cdklabs.projen.github.GitHubProjectOptions

getAutoApproveOptions, getAutoMerge, getAutoMergeOptions, getClobber, getDevContainer, getGithub, getGithubOptions, getGitpod, getMergify, getMergifyOptions, getProjectType, getProjenCredentials, getProjenTokenSecret, getReadme, getStale, getStaleOptions, getVscode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface io.github.cdklabs.projen.web.NextJsCommonProjectOptions

getAssetsdir, getTailwind

Methods inherited from interface io.github.cdklabs.projen.javascript.NodePackageOptions

getAllowLibraryDependencies, getAuthorEmail, getAuthorName, getAuthorOrganization, getAuthorUrl, getAutoDetectBin, getBin, getBugsEmail, getBugsUrl, getBundledDeps, getCodeArtifactOptions, getDeps, getDescription, getDevDeps, getEntrypoint, getHomepage, getKeywords, getLicense, getLicensed, getMaxNodeVersion, getMinNodeVersion, getNpmAccess, getNpmProvenance, getNpmRegistry, getNpmRegistryUrl, getNpmTokenSecret, getPackageManager, getPackageName, getPeerDependencyOptions, getPeerDeps, getPnpmVersion, getRepository, getRepositoryDirectory, getScopedPackagesOptions, getScripts, getStability, getYarnBerryOptions

Methods inherited from interface io.github.cdklabs.projen.javascript.NodeProjectOptions

getArtifactsDirectory, getAutoApproveUpgrades, getBuildWorkflow, getBuildWorkflowTriggers, getBundlerOptions, getCheckLicenses, getCodeCov, getCodeCovTokenSecret, getCopyrightOwner, getCopyrightPeriod, getDefaultReleaseBranch, getDependabot, getDependabotOptions, getDepsUpgrade, getDepsUpgradeOptions, getGitignore, getJest, getJestOptions, getMutableBuild, getNpmignore, getNpmignoreEnabled, getNpmIgnoreOptions, getPackageValue, getPrettier, getPrettierOptions, getProjenDevDependency, getProjenrcJs, getProjenrcJsOptions, getProjenVersion, getPullRequestTemplate, getPullRequestTemplateContents, getRelease, getReleaseToNpm, getReleaseWorkflow, getWorkflowBootstrapSteps, getWorkflowGitIdentity, getWorkflowNodeVersion, getWorkflowPackageCache

Methods inherited from interface io.github.cdklabs.projen.ProjectOptions

getCommitGenerated, getGitIgnoreOptions, getGitOptions, getLogging, getName, getOutdir, getParent, getProjenCommand, getProjenrcJson, getProjenrcJsonOptions, getRenovatebot, getRenovatebotOptions

Methods inherited from interface io.github.cdklabs.projen.release.ReleaseProjectOptions

getJsiiReleaseVersion, getMajorVersion, getMinMajorVersion, getNpmDistTag, getPostBuildSteps, getPrerelease, getPublishDryRun, getPublishTasks, getReleasableCommits, getReleaseBranches, getReleaseEveryCommit, getReleaseFailureIssue, getReleaseFailureIssueLabel, getReleaseSchedule, getReleaseTagPrefix, getReleaseTrigger, getReleaseWorkflowName, getReleaseWorkflowSetupSteps, getVersionrcOptions, getWorkflowContainerImage, getWorkflowRunsOn, getWorkflowRunsOnGroup

Method Detail

getSampleCode

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

(experimental) Generate one-time sample in pages/ and public/ if there are no files there.

Default: true

getSrcdir

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

(experimental) Typescript sources directory.

Default: "src"

builder

@Stability(Experimental)
static NextJsProjectOptions.Builder builder()

Returns:

a NextJsProjectOptions.Builder of NextJsProjectOptions