Package software.aws.awsprototypingsdk.nxmonorepo

Class NxMonorepoProject

  • All Implemented Interfaces:
    software.amazon.jsii.JsiiSerializable
    @Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-02-01T23:43:15.995Z")
@Stability(Stable)
public class NxMonorepoProject
extends io.github.cdklabs.projen.typescript.TypeScriptProject
    This project type will bootstrap a NX based monorepo with support for polygot builds, build caching, dependency graph visualization and much more.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  NxMonorepoProject.Builder
      A fluent builder for NxMonorepoProject.

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

        software.amazon.jsii.JsiiObject.InitializationMode

    • Field Summary

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

        DEFAULT_TASK

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addImplicitDependency​(io.github.cdklabs.projen.Project dependent, io.github.cdklabs.projen.Project dependee)
      Create an implicit dependency between two Project's.
      void addWorkspacePackages​(@NotNull String... packageGlobs)
      Add one or more additional package globs to the workspace.
      List<io.github.cdklabs.projen.Project> getSubProjects()  
      void synth()
      Synthesize all project files into `outdir`.

      • Methods inherited from class io.github.cdklabs.projen.typescript.TypeScriptProject

        getDocgen, getDocsDirectory, getEslint, getLibdir, getSrcdir, getTestdir, getTsconfig, getTsconfigDev, getTsconfigEslint, getWatchTask

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

        addBins, addBundledDeps, addCompileCommand, addDeps, addDevDeps, addFields, addKeywords, addPackageIgnore, addPeerDeps, addTestCommand, getAllowLibraryDependencies, getArtifactsDirectory, getArtifactsJavascriptDirectory, getAutoMerge, getBuildWorkflow, getBuildWorkflowJobId, getBundler, getEntrypoint, getJest, getManifest, getMaxNodeVersion, getMinNodeVersion, getNodeVersion, getNpmignore, getPackageManager, getPackageValue, getPrettier, getPublisher, getRelease, getRunScriptCommand, getUpgradeWorkflow, getWorkflowBootstrapSteps, 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, getTasks, getTestTask, postSynthesize, preSynthesize, removeTask, tryFindFile, tryFindJsonFile, tryFindObjectFile, tryRemoveFile

      • Methods inherited from class software.amazon.jsii.JsiiObject

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

      • Methods inherited from interface software.amazon.jsii.JsiiSerializable

        $jsii$toJson

    • Constructor Detail

      • NxMonorepoProject

        protected NxMonorepoProject​(software.amazon.jsii.JsiiObjectRef objRef)

      • NxMonorepoProject

        protected NxMonorepoProject​(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

      • NxMonorepoProject

        @Stability(Stable)
public NxMonorepoProject​(@NotNull
                         NxMonorepoProjectOptions options)
        Parameters:
        options - This parameter is required.

    • Method Detail

      • addImplicitDependency

        @Stability(Stable)
public void addImplicitDependency​(@NotNull
                                  io.github.cdklabs.projen.Project dependent,
                                  @NotNull
                                  io.github.cdklabs.projen.Project dependee)
        Create an implicit dependency between two Project's.

        This is typically used in polygot repos where a Typescript project wants a build dependency on a Python project as an example.

        Parameters:
        dependent - project you want to have the dependency. This parameter is required.
        dependee - project you wish to depend on. This parameter is required.

      • addWorkspacePackages

        @Stability(Stable)
public void addWorkspacePackages​(@NotNull
                                 @NotNull String... packageGlobs)
        Add one or more additional package globs to the workspace.

        Parameters:
        packageGlobs - paths to the package to include in the workspace (for example packages/my-package). This parameter is required.

      • synth

        @Stability(Stable)
public void synth()
        Synthesize all project files into `outdir`.

        1. Call "this.preSynthesize()"
        2. Delete all generated files
        3. Synthesize all sub-projects
        4. Synthesize all components of this project
        5. Call "postSynthesize()" for all components of this project
        6. Call "this.postSynthesize()"
        Overrides:
        synth in class io.github.cdklabs.projen.Project

      • getSubProjects

        @Stability(Stable)
@NotNull
public List<io.github.cdklabs.projen.Project> getSubProjects()