io.github.cdklabs.projen.javascript

Class NodePackage

java.lang.Object

software.amazon.jsii.JsiiObject

io.github.cdklabs.projen.Component

io.github.cdklabs.projen.javascript.NodePackage

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

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

(experimental) Represents the npm `package.json` file.

Nested Class Summary

Nested Classes

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

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

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NodePackage(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	NodePackage(software.amazon.jsii.JsiiObjectRef objRef)
	NodePackage(Project project)
	NodePackage(Project project, NodePackageOptions options)

Method Summary

Modifier and Type	Method and Description
void	addBin(Map<String,String> bins)
void	addBundledDeps(String... deps) (experimental) Defines bundled dependencies.
void	addDeps(String... deps) (experimental) Defines normal dependencies.
void	addDevDeps(String... deps) (experimental) Defines development/test dependencies.
void	addEngine(String engine, String version) (experimental) Adds an `engines` requirement to your package.
void	addField(String name, Object value) (experimental) Directly set fields in `package.json`.
void	addKeywords(String... keywords) (experimental) Adds keywords to package.json (deduplicated).
void	addPeerDeps(String... deps) (experimental) Defines peer dependencies.
void	addVersion(String version) (experimental) Sets the package version.
Boolean	getAllowLibraryDependencies() (experimental) Allow project to take library dependencies.
CodeArtifactOptions	getCodeArtifactOptions() (experimental) Options for publishing npm package to AWS CodeArtifact.
String	getEntrypoint() (experimental) The module's entrypoint (e.g.
String	getInstallAndUpdateLockfileCommand() (experimental) Renders `yarn install` or `npm install` with lockfile update (not frozen).
String	getInstallCommand() (experimental) Returns the command to execute in order to install all dependencies (always frozen).
String	getLicense() (experimental) The SPDX license of this module.
String	getLockFile() (experimental) The name of the lock file.
Object	getManifest() Deprecated. use `addField(x, y)`
String	getMaxNodeVersion() (experimental) Maximum node version required by this pacakge.
String	getMinNodeVersion() (experimental) Minimum node.js version required by this package.
NpmAccess	getNpmAccess() (experimental) npm package access level.
String	getNpmRegistry() (experimental) The npm registry host (e.g.
String	getNpmRegistryUrl() (experimental) npm registry (e.g.
String	getNpmTokenSecret() (experimental) GitHub secret which contains the NPM token to use when publishing packages.
NodePackageManager	getPackageManager() (experimental) The package manager to use.
String	getPackageName() (experimental) The name of the npm package.
String	getProjenCommand() (experimental) The command which executes "projen".
Boolean	hasScript(String name) Deprecated. Use `project.tasks.tryFind(name)`
void	postSynthesize() (experimental) Called after synthesis.
void	preSynthesize() (experimental) Called before synthesis.
void	removeScript(String name) (experimental) Removes the npm script (always successful).
String	renderUpgradePackagesCommand(List<String> exclude) (experimental) Render a package manager specific command to upgrade all requested dependencies.
String	renderUpgradePackagesCommand(List<String> exclude, List<String> include) (experimental) Render a package manager specific command to upgrade all requested dependencies.
void	setScript(String name, String command) (experimental) Override the contents of an npm package.json script.

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

getProject, synthesize

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

NodePackage

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

NodePackage

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

NodePackage

@Stability(value=Experimental)
public NodePackage(@NotNull
                                                  Project project,
                                                  @Nullable
                                                  NodePackageOptions options)

Parameters:

project - This parameter is required.

options -

NodePackage

@Stability(value=Experimental)
public NodePackage(@NotNull
                                                  Project project)

Parameters:

project - This parameter is required.

Method Detail

addBin

@Stability(value=Experimental)
public void addBin(@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.

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.

addEngine

@Stability(value=Experimental)
public void addEngine(@NotNull
                                                     String engine,
                                                     @NotNull
                                                     String version)

(experimental) Adds an `engines` requirement to your package.

Parameters:

engine - The engine (e.g. `node`). This parameter is required.

version - The semantic version requirement (e.g. `^10`). This parameter is required.

addField

@Stability(value=Experimental)
public void addField(@NotNull
                                                    String name,
                                                    @NotNull
                                                    Object value)

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

Parameters:

name - field name. This parameter is required.

value - field value. 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.

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.

addVersion

@Stability(value=Experimental)
public void addVersion(@NotNull
                                                      String version)

(experimental) Sets the package version.

Parameters:

version - Package version. This parameter is required.

hasScript

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

Deprecated. Use `project.tasks.tryFind(name)`

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

Parameters:

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

postSynthesize

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

(experimental) Called after synthesis.

Order is not guaranteed.

Overrides:

postSynthesize in class Component

preSynthesize

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

(experimental) Called before synthesis.

Overrides:

preSynthesize in class Component

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.

renderUpgradePackagesCommand

@Stability(value=Experimental)
 @NotNull
public String renderUpgradePackagesCommand(@NotNull
                                                                                    List<String> exclude,
                                                                                    @Nullable
                                                                                    List<String> include)

(experimental) Render a package manager specific command to upgrade all requested dependencies.

Parameters:

exclude - This parameter is required.

include -

renderUpgradePackagesCommand

@Stability(value=Experimental)
 @NotNull
public String renderUpgradePackagesCommand(@NotNull
                                                                                    List<String> exclude)

(experimental) Render a package manager specific command to upgrade all requested dependencies.

Parameters:

exclude - This parameter is required.

setScript

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

(experimental) Override 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=Experimental)
 @NotNull
public Boolean getAllowLibraryDependencies()

(experimental) Allow project to take library dependencies.

getEntrypoint

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

(experimental) The module's entrypoint (e.g. `lib/index.js`).

getInstallAndUpdateLockfileCommand

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

(experimental) Renders `yarn install` or `npm install` with lockfile update (not frozen).

getInstallCommand

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

(experimental) Returns the command to execute in order to install all dependencies (always frozen).

getLockFile

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

(experimental) The name of the lock file.

getManifest

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

Deprecated. use `addField(x, y)`

getNpmAccess

@Stability(value=Experimental)
 @NotNull
public NpmAccess getNpmAccess()

(experimental) npm package access level.

getNpmRegistry

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

(experimental) The npm registry host (e.g. `registry.npmjs.org`).

getNpmRegistryUrl

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

(experimental) npm registry (e.g. `https://registry.npmjs.org`). Use `npmRegistryHost` to get just the host name.

getPackageManager

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

(experimental) The package manager to use.

getPackageName

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

(experimental) The name of the npm package.

getProjenCommand

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

(experimental) The command which executes "projen".

getCodeArtifactOptions

@Stability(value=Experimental)
 @Nullable
public CodeArtifactOptions getCodeArtifactOptions()

(experimental) Options for publishing npm package to AWS CodeArtifact.

Default: - undefined

getLicense

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

(experimental) The SPDX license of this module.

undefined if this package is not licensed.

getMaxNodeVersion

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

(experimental) Maximum node version required by this pacakge.

Default: - no maximum.

getMinNodeVersion

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

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

Default: - no minimum

getNpmTokenSecret

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

(experimental) GitHub secret which contains the NPM token to use when publishing packages.