io.github.cdklabs.projen

Class IgnoreFile

java.lang.Object

software.amazon.jsii.JsiiObject

io.github.cdklabs.projen.Component

io.github.cdklabs.projen.FileBase

io.github.cdklabs.projen.IgnoreFile

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-20T00:39:28.406Z")
 @Stability(value=Experimental)
public class IgnoreFile
extends FileBase

Nested Class Summary

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.FileBase

PROJEN_MARKER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IgnoreFile(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	IgnoreFile(software.amazon.jsii.JsiiObjectRef objRef)
	IgnoreFile(Project project, String filePath)

Method Summary

Modifier and Type	Method and Description
void	addPatterns(String... patterns) (experimental) Add ignore patterns.
void	exclude(String... patterns) (experimental) Ignore the files that match these patterns.
void	include(String... patterns) (experimental) Always include the specified file patterns.
void	removePatterns(String... patterns) (experimental) Removes patterns previously added from the ignore file.
protected String	synthesizeContent(IResolver resolver) (experimental) Implemented by derived classes and returns the contents of the file to emit.

Methods inherited from class io.github.cdklabs.projen.FileBase

getAbsolutePath, getExecutable, getPath, getReadonly, setExecutable, setReadonly, synthesize

Methods inherited from class io.github.cdklabs.projen.Component

getProject, postSynthesize, preSynthesize

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

IgnoreFile

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

IgnoreFile

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

IgnoreFile

@Stability(value=Experimental)
public IgnoreFile(@NotNull
                                                 Project project,
                                                 @NotNull
                                                 String filePath)

Parameters:

project - This parameter is required.

filePath - This parameter is required.

Method Detail

addPatterns

@Stability(value=Experimental)
public void addPatterns(@NotNull
                                                       String... patterns)

(experimental) Add ignore patterns.

Files that match this pattern will be ignored. If the pattern starts with a negation mark !, files that match will not be ignored.

Comment lines (start with #) are ignored.

Parameters:

patterns - Ignore patterns. This parameter is required.

exclude

@Stability(value=Experimental)
public void exclude(@NotNull
                                                   String... patterns)

(experimental) Ignore the files that match these patterns.

Parameters:

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

include

@Stability(value=Experimental)
public void include(@NotNull
                                                   String... patterns)

(experimental) Always include the specified file patterns.

Parameters:

patterns - Patterns to include in git commits. This parameter is required.

removePatterns

@Stability(value=Experimental)
public void removePatterns(@NotNull
                                                          String... patterns)

(experimental) Removes patterns previously added from the ignore file.

If addPattern() is called after this, the pattern will be added again.

Parameters:

patterns - patters to remove. This parameter is required.

synthesizeContent

@Stability(value=Experimental)
 @Nullable
protected String synthesizeContent(@NotNull
                                                                             IResolver resolver)

(experimental) Implemented by derived classes and returns the contents of the file to emit.

Specified by:

synthesizeContent in class FileBase

Parameters:

resolver - This parameter is required.

Returns:

the content to synthesize or undefined to skip the file