Package io.github.cdklabs.projen

Class Projects

java.lang.Object

software.amazon.jsii.JsiiObject

io.github.cdklabs.projen.Projects

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:42.795Z")
@Stability(Experimental)
public class Projects
extends software.amazon.jsii.JsiiObject

(experimental) Programmatic API for projen.

Nested Class Summary

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

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Projects(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Projects(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
static void	createProject(CreateProjectOptions options)	(experimental) Creates a new project with defaults.

Methods inherited from class software.amazon.jsii.JsiiObject

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Projects

protected Projects(software.amazon.jsii.JsiiObjectRef objRef)

Projects

protected Projects(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Method Detail

createProject

@Stability(Experimental)
public static void createProject(@NotNull
                                 CreateProjectOptions options)

(experimental) Creates a new project with defaults.

This function creates the project type in-process (with in VM) and calls .synth() on it (if options.synth is not false).

At the moment, it also generates a .projenrc.js file with the same code that was just executed. In the future, this will also be done by the project type, so we can easily support multiple languages of projenrc.

An environment variable (PROJEN_CREATE_PROJECT=true) is set within the VM so that custom project types can detect whether the current synthesis is the result of a new project creation (and take additional steps accordingly)

Parameters:

options - This parameter is required.