io.github.cdklabs.projen.javascript

Class NodeProject

java.lang.Object

software.amazon.jsii.JsiiObject

io.github.cdklabs.projen.Project

io.github.cdklabs.projen.github.GitHubProject

io.github.cdklabs.projen.javascript.NodeProject

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

Direct Known Subclasses:

NextJsProject, ReactProject, TypeScriptProject

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

(experimental) Node.js project.

Nested Class Summary

Nested Classes

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

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addBins(Map<String,String> bins)
void	addBundledDeps(String... deps) (experimental) Defines bundled dependencies.
void	addCompileCommand(String... commands) Deprecated. use `project.compileTask.exec()`
void	addDeps(String... deps) (experimental) Defines normal dependencies.
void	addDevDeps(String... deps) (experimental) Defines development/test dependencies.
void	addFields(Map<String,Object> fields) (experimental) Directly set fields in `package.json`.
void	addKeywords(String... keywords) (experimental) Adds keywords to package.json (deduplicated).
void	addPackageIgnore(String pattern) (experimental) Exclude these files from the bundled package.
void	addPeerDeps(String... deps) (experimental) Defines peer dependencies.
void	addTestCommand(String... commands) Deprecated. use `project.testTask.exec()`
Boolean	getAllowLibraryDependencies() Deprecated. use `package.allowLibraryDependencies`
Boolean	getAntitamper() (experimental) Indicates if workflows have anti-tamper checks.
AutoMerge	getAutoMerge() (experimental) Automatic PR merges.
TaskWorkflow	getBuildWorkflow() (experimental) The PR build GitHub workflow.
String	getBuildWorkflowJobId()
Bundler	getBundler()
String	getEntrypoint() Deprecated. use `package.entrypoint`
List<JobStep>	getInstallWorkflowSteps()
Jest	getJest() (experimental) The Jest configuration (if enabled).
Object	getManifest() Deprecated. use `package.addField(x, y)`
String	getMaxNodeVersion() (experimental) Maximum node version required by this pacakge.
String	getMinNodeVersion() (experimental) Minimum node.js version required by this package.
IgnoreFile	getNpmignore() (experimental) The .npmignore file.
NodePackageManager	getPackageManager() Deprecated. use `package.packageManager`
NodePackage	getPackageValue() (experimental) API for managing the node package.
Publisher	getPublisher() Deprecated. use `release.publisher`.
Release	getRelease() (experimental) Release management.
String	getRunScriptCommand() (experimental) The command to use to run scripts (e.g.
Boolean	hasScript(String name) (experimental) Indicates if a script by the name name is defined.
void	removeScript(String name) (experimental) Removes the npm script (always successful).
String	runTaskCommand(Task task) (experimental) Returns the shell command to execute in order to run a task.
void	setScript(String name, String command) (experimental) Replaces the contents of an npm package.json script.

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, getCompileTask, getComponents, getDefaultTask, getDeps, getFiles, getGitattributes, getGitignore, getInitProject, getLogger, getName, getOutdir, getPackageTask, getParent, getPostCompileTask, getPreCompileTask, getProjectBuild, getProjenCommand, getRoot, getTasks, getTestTask, postSynthesize, preSynthesize, removeTask, synth, tryFindFile, tryFindJsonFile, tryFindObjectFile

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

NodeProject

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

NodeProject

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

NodeProject

@Stability(value=Experimental)
public NodeProject(@NotNull
                                                  NodeProjectOptions options)

Parameters:

options - This parameter is required.

Method Detail

addBins

@Stability(value=Experimental)
public void addBins(@NotNull
                                                   Map<String,String> bins)

Parameters:

bins - This parameter is required.

addBundledDeps

@Stability(value=Experimental)
public void addBundledDeps(@NotNull
                                                          String... deps)

(experimental) Defines bundled dependencies.

Bundled dependencies will be added as normal dependencies as well as to the bundledDependencies section of your package.json.

Parameters:

deps - Names modules to install. This parameter is required.

addCompileCommand

@Stability(value=Deprecated)
 @Deprecated
public void addCompileCommand(@NotNull
                                                                        String... commands)

Deprecated. use `project.compileTask.exec()`

(deprecated) DEPRECATED.

Parameters:

commands - This parameter is required.

addDeps

@Stability(value=Experimental)
public void addDeps(@NotNull
                                                   String... deps)

(experimental) Defines normal dependencies.

Parameters:

deps - Names modules to install. This parameter is required.

addDevDeps

@Stability(value=Experimental)
public void addDevDeps(@NotNull
                                                      String... deps)

(experimental) Defines development/test dependencies.

Parameters:

deps - Names modules to install. This parameter is required.

addFields

@Stability(value=Experimental)
public void addFields(@NotNull
                                                     Map<String,Object> fields)

(experimental) Directly set fields in `package.json`.

Parameters:

fields - The fields to set. This parameter is required.

addKeywords

@Stability(value=Experimental)
public void addKeywords(@NotNull
                                                       String... keywords)

(experimental) Adds keywords to package.json (deduplicated).

Parameters:

keywords - The keywords to add. 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.

Overrides:

addPackageIgnore in class Project

Parameters:

pattern - This parameter is required.

addPeerDeps

@Stability(value=Experimental)
public void addPeerDeps(@NotNull
                                                       String... deps)

(experimental) Defines peer dependencies.

When adding peer dependencies, a devDependency will also be added on the pinned version of the declared peer. This will ensure that you are testing your code against the minimum version required from your consumers.

Parameters:

deps - Names modules to install. This parameter is required.

addTestCommand

@Stability(value=Deprecated)
 @Deprecated
public void addTestCommand(@NotNull
                                                                     String... commands)

Deprecated. use `project.testTask.exec()`

(deprecated) DEPRECATED.

Parameters:

commands - This parameter is required.

hasScript

@Stability(value=Experimental)
 @NotNull
public Boolean hasScript(@NotNull
                                                                  String name)

(experimental) Indicates if a script by the name name is defined.

Parameters:

name - The name of the script. This parameter is required.

removeScript

@Stability(value=Experimental)
public void removeScript(@NotNull
                                                        String name)

(experimental) Removes the npm script (always successful).

Parameters:

name - The name of the script. This parameter is required.

runTaskCommand

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

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

This will typically be npx projen TASK.

Overrides:

runTaskCommand in class Project

Parameters:

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

setScript

@Stability(value=Experimental)
public void setScript(@NotNull
                                                     String name,
                                                     @NotNull
                                                     String command)

(experimental) Replaces the contents of an npm package.json script.

Parameters:

name - The script name. This parameter is required.

command - The command to execute. This parameter is required.

getAllowLibraryDependencies

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public Boolean getAllowLibraryDependencies()

Deprecated. use `package.allowLibraryDependencies`

getAntitamper

@Stability(value=Experimental)
 @NotNull
public Boolean getAntitamper()

(experimental) Indicates if workflows have anti-tamper checks.

getBundler

@Stability(value=Experimental)
 @NotNull
public Bundler getBundler()

getEntrypoint

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public String getEntrypoint()

Deprecated. use `package.entrypoint`

getInstallWorkflowSteps

@Stability(value=Experimental)
 @NotNull
public List<JobStep> getInstallWorkflowSteps()

getManifest

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public Object getManifest()

Deprecated. use `package.addField(x, y)`

getPackageValue

@Stability(value=Experimental)
 @NotNull
public NodePackage getPackageValue()

(experimental) API for managing the node package.

getPackageManager

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
public NodePackageManager getPackageManager()

Deprecated. use `package.packageManager`

(deprecated) The package manager to use.

getRunScriptCommand

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

(experimental) The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager).

getAutoMerge

@Stability(value=Experimental)
 @Nullable
public AutoMerge getAutoMerge()

(experimental) Automatic PR merges.

getBuildWorkflow

@Stability(value=Experimental)
 @Nullable
public TaskWorkflow getBuildWorkflow()

(experimental) The PR build GitHub workflow.

undefined if buildWorkflow is disabled.

getBuildWorkflowJobId

@Stability(value=Experimental)
 @Nullable
public String getBuildWorkflowJobId()

getJest

@Stability(value=Experimental)
 @Nullable
public Jest getJest()

(experimental) The Jest configuration (if enabled).

getMaxNodeVersion

@Stability(value=Experimental)
 @Nullable
public String getMaxNodeVersion()

(experimental) Maximum node version required by this pacakge.

getMinNodeVersion

@Stability(value=Experimental)
 @Nullable
public String getMinNodeVersion()

(experimental) Minimum node.js version required by this package.

getNpmignore

@Stability(value=Experimental)
 @Nullable
public IgnoreFile getNpmignore()

(experimental) The .npmignore file.

getPublisher

@Stability(value=Deprecated)
 @Deprecated
 @Nullable
public Publisher getPublisher()

Deprecated. use `release.publisher`.

(deprecated) Package publisher.

This will be undefined if the project does not have a release workflow.

getRelease

@Stability(value=Experimental)
 @Nullable
public Release getRelease()

(experimental) Release management.