io.github.cdklabs.projen

Class Project

java.lang.Object

software.amazon.jsii.JsiiObject

io.github.cdklabs.projen.Project

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

Direct Known Subclasses:

GitHubProject

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-20T00:39:28.418Z")
 @Stability(value=Experimental)
public class Project
extends software.amazon.jsii.JsiiObject

(experimental) Base project.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Project.Builder (experimental) A fluent builder for Project.

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

software.amazon.jsii.JsiiObject.InitializationMode

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_TASK (experimental) The name of the default task (the task executed when `projen` is run without arguments).

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Project(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Project(software.amazon.jsii.JsiiObjectRef objRef)
	Project(ProjectOptions options)

Method Summary

Modifier and Type	Method and Description
void	addExcludeFromCleanup(String... globs) (experimental) Exclude the matching files from pre-synth cleanup.
void	addGitIgnore(String pattern) (experimental) Adds a .gitignore pattern.
void	addPackageIgnore(String _pattern) (experimental) Exclude these files from the bundled package.
Task	addTask(String name) (experimental) Adds a new task to this project.
Task	addTask(String name, TaskOptions props) (experimental) Adds a new task to this project.
void	addTip(String message) Deprecated. - use `project.logger.info(message)` to show messages during synthesis
void	annotateGenerated(String _glob) (experimental) Consider a set of files as "generated".
Task	getBuildTask()
Task	getCompileTask()
List<Component>	getComponents() (experimental) Returns all the components within this project.
Task	getDefaultTask() (experimental) This is the "default" task, the one that executes "projen".
Dependencies	getDeps() (experimental) Project dependencies.
List<FileBase>	getFiles() (experimental) All files in this project.
GitAttributesFile	getGitattributes() (experimental) The .gitattributes file for this repository.
IgnoreFile	getGitignore() (experimental) .gitignore.
InitProject	getInitProject() (experimental) The options used when this project is bootstrapped via `projen new`.
Logger	getLogger() (experimental) Logging utilities.
String	getName() (experimental) Project name.
String	getOutdir() (experimental) Absolute output directory of this project.
Task	getPackageTask()
Project	getParent() (experimental) A parent project.
Task	getPostCompileTask()
Task	getPreCompileTask()
ProjectBuild	getProjectBuild() (experimental) Manages the build process of the project.
String	getProjenCommand() (experimental) The command to use in order to run the projen CLI.
Project	getRoot() (experimental) The root project.
Tasks	getTasks() (experimental) Project tasks.
Task	getTestTask()
void	postSynthesize() (experimental) Called after all components are synthesized.
void	preSynthesize() (experimental) Called before all components are synthesized.
Task	removeTask(String name) (experimental) Removes a task from a project.
String	runTaskCommand(Task task) (experimental) Returns the shell command to execute in order to run a task.
void	synth() (experimental) Synthesize all project files into `outdir`.
FileBase	tryFindFile(String filePath) (experimental) Finds a file at the specified relative path within this project and all its subprojects.
JsonFile	tryFindJsonFile(String filePath) Deprecated. use `tryFindObjectFile`
ObjectFile	tryFindObjectFile(String filePath) (experimental) Finds an object file (like JsonFile, YamlFile, etc.) by name.

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

Field Detail

DEFAULT_TASK

@Stability(value=Experimental)
public static final String DEFAULT_TASK

(experimental) The name of the default task (the task executed when `projen` is run without arguments).

Normally this task should synthesize the project files.

Constructor Detail

Project

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

Project

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

Project

@Stability(value=Experimental)
public Project(@NotNull
                                              ProjectOptions options)

Parameters:

options - This parameter is required.

Method Detail

addExcludeFromCleanup

@Stability(value=Experimental)
public void addExcludeFromCleanup(@NotNull
                                                                 String... globs)

(experimental) Exclude the matching files from pre-synth cleanup.

Can be used when, for example, some source files include the projen marker and we don't want them to be erased during synth.

Parameters:

globs - The glob patterns to match. This parameter is required.

addGitIgnore

@Stability(value=Experimental)
public void addGitIgnore(@NotNull
                                                        String pattern)

(experimental) Adds a .gitignore pattern.

Parameters:

pattern - The glob pattern to ignore. This parameter is required.

addPackageIgnore

@Stability(value=Experimental)
public void addPackageIgnore(@NotNull
                                                            String _pattern)

(experimental) Exclude these files from the bundled package.

Implemented by project types based on the packaging mechanism. For example, NodeProject delegates this to .npmignore.

Parameters:

_pattern - The glob pattern to exclude. This parameter is required.

addTask

@Stability(value=Experimental)
 @NotNull
public Task addTask(@NotNull
                                                             String name,
                                                             @Nullable
                                                             TaskOptions props)

(experimental) Adds a new task to this project.

This will fail if the project already has a task with this name.

Parameters:

name - The task name to add. This parameter is required.

props - Task properties.

addTask

@Stability(value=Experimental)
 @NotNull
public Task addTask(@NotNull
                                                             String name)

(experimental) Adds a new task to this project.

This will fail if the project already has a task with this name.

Parameters:

name - The task name to add. This parameter is required.

addTip

@Stability(value=Deprecated)
 @Deprecated
public void addTip(@NotNull
                                                             String message)

Deprecated. - use `project.logger.info(message)` to show messages during synthesis

(deprecated) Prints a "tip" message during synthesis.

Parameters:

message - The message. This parameter is required.

annotateGenerated

@Stability(value=Experimental)
public void annotateGenerated(@NotNull
                                                             String _glob)

(experimental) Consider a set of files as "generated".

This method is implemented by derived classes and used for example, to add git attributes to tell GitHub that certain files are generated.

Parameters:

_glob - the glob pattern to match (could be a file path). This parameter is required.

postSynthesize

@Stability(value=Experimental)
public void postSynthesize()

(experimental) Called after all components are synthesized.

Order is not guaranteed.

preSynthesize

@Stability(value=Experimental)
public void preSynthesize()

(experimental) Called before all components are synthesized.

removeTask

@Stability(value=Experimental)
 @Nullable
public Task removeTask(@NotNull
                                                                 String name)

(experimental) Removes a task from a project.

Parameters:

name - The name of the task to remove. This parameter is required.

Returns:

The `Task` that was removed, otherwise `undefined`.

runTaskCommand

@Stability(value=Experimental)
 @NotNull
public String runTaskCommand(@NotNull
                                                                      Task task)

(experimental) Returns the shell command to execute in order to run a task.

By default, this is npx projen@<version> <task>

Parameters:

task - The task for which the command is required. This parameter is required.

synth

@Stability(value=Experimental)
public void synth()

(experimental) 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()"

tryFindFile

@Stability(value=Experimental)
 @Nullable
public FileBase tryFindFile(@NotNull
                                                                      String filePath)

(experimental) Finds a file at the specified relative path within this project and all its subprojects.

Parameters:

filePath - The file path. This parameter is required.

Returns:

a `FileBase` or undefined if there is no file in that path

tryFindJsonFile

@Stability(value=Deprecated)
 @Deprecated
 @Nullable
public JsonFile tryFindJsonFile(@NotNull
                                                                                     String filePath)

Deprecated. use `tryFindObjectFile`

(deprecated) Finds a json file by name.

Parameters:

filePath - The file path. This parameter is required.

tryFindObjectFile

@Stability(value=Experimental)
 @Nullable
public ObjectFile tryFindObjectFile(@NotNull
                                                                              String filePath)

(experimental) Finds an object file (like JsonFile, YamlFile, etc.) by name.

Parameters:

filePath - The file path. This parameter is required.

getBuildTask

@Stability(value=Experimental)
 @NotNull
public Task getBuildTask()

getCompileTask

@Stability(value=Experimental)
 @NotNull
public Task getCompileTask()

getComponents

@Stability(value=Experimental)
 @NotNull
public List<Component> getComponents()

(experimental) Returns all the components within this project.

getDefaultTask

@Stability(value=Experimental)
 @NotNull
public Task getDefaultTask()

(experimental) This is the "default" task, the one that executes "projen".

getDeps

@Stability(value=Experimental)
 @NotNull
public Dependencies getDeps()

(experimental) Project dependencies.

getFiles

@Stability(value=Experimental)
 @NotNull
public List<FileBase> getFiles()

(experimental) All files in this project.

getGitattributes

@Stability(value=Experimental)
 @NotNull
public GitAttributesFile getGitattributes()

(experimental) The .gitattributes file for this repository.

getGitignore

@Stability(value=Experimental)
 @NotNull
public IgnoreFile getGitignore()

(experimental) .gitignore.

getLogger

@Stability(value=Experimental)
 @NotNull
public Logger getLogger()

(experimental) Logging utilities.

getName

@Stability(value=Experimental)
 @NotNull
public String getName()

(experimental) Project name.

getOutdir

@Stability(value=Experimental)
 @NotNull
public String getOutdir()

(experimental) Absolute output directory of this project.

getPackageTask

@Stability(value=Experimental)
 @NotNull
public Task getPackageTask()

getPostCompileTask

@Stability(value=Experimental)
 @NotNull
public Task getPostCompileTask()

getPreCompileTask

@Stability(value=Experimental)
 @NotNull
public Task getPreCompileTask()

getProjectBuild

@Stability(value=Experimental)
 @NotNull
public ProjectBuild getProjectBuild()

(experimental) Manages the build process of the project.

getProjenCommand

@Stability(value=Experimental)
 @NotNull
public String getProjenCommand()

(experimental) The command to use in order to run the projen CLI.

getRoot

@Stability(value=Experimental)
 @NotNull
public Project getRoot()

(experimental) The root project.

getTasks

@Stability(value=Experimental)
 @NotNull
public Tasks getTasks()

(experimental) Project tasks.

getTestTask

@Stability(value=Experimental)
 @NotNull
public Task getTestTask()

getInitProject

@Stability(value=Experimental)
 @Nullable
public InitProject getInitProject()

(experimental) The options used when this project is bootstrapped via `projen new`.

It includes the original set of options passed to the CLI and also the JSII FQN of the project type.

getParent

@Stability(value=Experimental)
 @Nullable
public Project getParent()

(experimental) A parent project.

If undefined, this is the root project.