# NpmManager

> Integrates npm with Foxy's install, update, workspace, and audit workflows.

[API reference](/docs/api/index.md) › [Foxy](/docs/extensions/foxy/reference/index.md) › [Asset](/docs/extensions/foxy/reference/asset/index.md) › NpmManager

| final class | `Foxy\Asset\NpmManager` |
| --- | --- |
| Extends | [`AbstractAssetManager`](/docs/extensions/foxy/reference/asset/abstractassetmanager/index.md) » [`AbstractManifestAssetManager`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md) |
| Implements | [`AssetManagerInterface`](/docs/extensions/foxy/reference/asset/assetmanagerinterface/index.md) |
| Source | [`src/Asset/NpmManager.php`](https://github.com/php-forge/foxy/blob/main/src/Asset/NpmManager.php#L24) |

Integrates npm with Foxy's install, update, workspace, and audit workflows.

## Properties

| Property | Type | Description | Defined by |
| --- | --- | --- | --- |
| <span id="property-config"></span>[`$config`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md#property-config) protected constructor | [`Foxy\Config\Config`](/docs/extensions/foxy/reference/config/config/index.md) | Foxy configuration. | [`AbstractManifestAssetManager`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md) |
| <span id="property-executor"></span>[`$executor`](/docs/extensions/foxy/reference/asset/abstractassetmanager/index.md#property-executor) protected constructor | `Composer\Util\ProcessExecutor` | Process executor used to invoke the manager. | [`AbstractAssetManager`](/docs/extensions/foxy/reference/asset/abstractassetmanager/index.md) |
| <span id="property-fs"></span>[`$fs`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md#property-fs) protected constructor | `Composer\Util\Filesystem` | Filesystem used to resolve and update manifest paths. | [`AbstractManifestAssetManager`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md) |
| <span id="property-io"></span>[`$io`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md#property-io) protected constructor | `Composer\IO\IOInterface` | Composer output used for progress messages. | [`AbstractManifestAssetManager`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md) |
| <span id="property-updatable"></span>[`$updatable`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md#property-updatable) protected | `bool` | Whether an existing frontend installation may be updated. Default: `true`. | [`AbstractManifestAssetManager`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md) |
| <span id="property-versionConverter"></span>[`$versionConverter`](/docs/extensions/foxy/reference/asset/abstractassetmanager/index.md#property-versionConverter) protected constructor | [`Foxy\Converter\VersionConverterInterface`](/docs/extensions/foxy/reference/converter/versionconverterinterface/index.md)`\|null` | Converter for manager version output. Default: `null`. | [`AbstractAssetManager`](/docs/extensions/foxy/reference/asset/abstractassetmanager/index.md) |

## Methods

| Method | Description | Defined by |
| --- | --- | --- |
| <span id="method-__construct"></span>[`__construct()`](/docs/extensions/foxy/reference/asset/abstractassetmanager/index.md#method-__construct) | Creates a manager that executes frontend commands for the configured asset manifest. | [`AbstractAssetManager`](/docs/extensions/foxy/reference/asset/abstractassetmanager/index.md) |
| <span id="method-addDependencies"></span>[`addDependencies()`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md#method-addDependencies) | Merges Composer asset dependencies into the frontend package manifest. | [`AbstractManifestAssetManager`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md) |
| <span id="method-audit"></span>[`audit()`](/docs/extensions/foxy/reference/asset/abstractassetmanager/index.md#method-audit) | Runs the manager audit command against the current lock file. | [`AbstractAssetManager`](/docs/extensions/foxy/reference/asset/abstractassetmanager/index.md) |
| [`getAuditParser()`](#method-getAuditParser) | Returns the parser for npm audit JSON output. | `NpmManager` |
| [`getLockPackageName()`](#method-getLockPackageName) | Returns npm's lock-file name. | `NpmManager` |
| [`getName()`](#method-getName) | Returns the manager name used in Foxy configuration. | `NpmManager` |
| <span id="method-getPackageJsonPath"></span>[`getPackageJsonPath()`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md#method-getPackageJsonPath) | Returns the frontend package manifest path. | [`AbstractManifestAssetManager`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md) |
| <span id="method-getPackageName"></span>[`getPackageName()`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md#method-getPackageName) | Returns the frontend package manifest filename. | [`AbstractManifestAssetManager`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md) |
| [`getVersionConstraint()`](#method-getVersionConstraint) | Returns the npm versions supported by this integration. | `NpmManager` |
| <span id="method-hasLockFile"></span>[`hasLockFile()`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md#method-hasLockFile) | Returns whether the manager lock file exists. | [`AbstractManifestAssetManager`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md) |
| <span id="method-isAvailable"></span>[`isAvailable()`](/docs/extensions/foxy/reference/asset/abstractassetmanager/index.md#method-isAvailable) | Returns whether the manager executable reports a detectable version. | [`AbstractAssetManager`](/docs/extensions/foxy/reference/asset/abstractassetmanager/index.md) |
| <span id="method-isInstalled"></span>[`isInstalled()`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md#method-isInstalled) | Returns whether both the dependency directory and package manifest exist. | [`AbstractManifestAssetManager`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md) |
| <span id="method-isUpdatable"></span>[`isUpdatable()`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md#method-isUpdatable) | Returns whether an existing frontend installation may be updated. | [`AbstractManifestAssetManager`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md) |
| <span id="method-run"></span>[`run()`](/docs/extensions/foxy/reference/asset/abstractassetmanager/index.md#method-run) | Installs or updates frontend dependencies according to the manager state and configuration. | [`AbstractAssetManager`](/docs/extensions/foxy/reference/asset/abstractassetmanager/index.md) |
| <span id="method-setUpdatable"></span>[`setUpdatable()`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md#method-setUpdatable) | Enables or disables updates of an existing frontend installation. | [`AbstractManifestAssetManager`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md) |
| <span id="method-validate"></span>[`validate()`](/docs/extensions/foxy/reference/asset/abstractassetmanager/index.md#method-validate) | Validates the installed manager version against Foxy's supported and configured constraints. | [`AbstractAssetManager`](/docs/extensions/foxy/reference/asset/abstractassetmanager/index.md) |
| [`actionWhenComposerDependenciesAreAlreadyInstalled()`](#method-actionWhenComposerDependenciesAreAlreadyInstalled) protected | Removes already-installed Composer assets so npm installs their updated manifest paths. | `NpmManager` |
| <span id="method-actionWhenComposerDependenciesAreMerged"></span>[`actionWhenComposerDependenciesAreMerged()`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md#method-actionWhenComposerDependenciesAreMerged) protected | Runs after the Composer asset dependencies are merged and before the asset package is written. | [`AbstractManifestAssetManager`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md) |
| <span id="method-buildCommand"></span>[`buildCommand()`](/docs/extensions/foxy/reference/asset/abstractassetmanager/index.md#method-buildCommand) protected | Returns the manager command run by the configured or default binary, followed by the `manager-options` and `manager-{action}-options` values. | [`AbstractAssetManager`](/docs/extensions/foxy/reference/asset/abstractassetmanager/index.md) |
| <span id="method-buildUnconfiguredCommand"></span>[`buildUnconfiguredCommand()`](/docs/extensions/foxy/reference/asset/abstractassetmanager/index.md#method-buildUnconfiguredCommand) protected | Returns the manager command run by the configured or default binary, without the install and update options. | [`AbstractAssetManager`](/docs/extensions/foxy/reference/asset/abstractassetmanager/index.md) |
| [`getAuditCommand()`](#method-getAuditCommand) protected | Returns an npm audit command that covers the root package and every locked workspace. | `NpmManager` |
| <span id="method-getAuditEnvironment"></span>[`getAuditEnvironment()`](/docs/extensions/foxy/reference/asset/abstractassetmanager/index.md#method-getAuditEnvironment) protected | Get environment overrides required for a complete audit. | [`AbstractAssetManager`](/docs/extensions/foxy/reference/asset/abstractassetmanager/index.md) |
| <span id="method-getDefaultBinary"></span>[`getDefaultBinary()`](/docs/extensions/foxy/reference/asset/abstractassetmanager/index.md#method-getDefaultBinary) protected | Returns the executable used when `manager-bin` is not configured; defaults to the manager name. | [`AbstractAssetManager`](/docs/extensions/foxy/reference/asset/abstractassetmanager/index.md) |
| <span id="method-getInstallCommand"></span>[`getInstallCommand()`](/docs/extensions/foxy/reference/asset/abstractassetmanager/index.md#method-getInstallCommand) protected | Returns the command that installs the asset dependencies, followed by the `manager-options` and `manager-install-options` values. | [`AbstractAssetManager`](/docs/extensions/foxy/reference/asset/abstractassetmanager/index.md) |
| <span id="method-getLockFilePath"></span>[`getLockFilePath()`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md#method-getLockFilePath) protected | Returns the manager lock-file path under the root package directory. | [`AbstractManifestAssetManager`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md) |
| <span id="method-getManagerConfig"></span>[`getManagerConfig()`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md#method-getManagerConfig) protected | Returns the configuration scoped to this manager, so `manager-*` map entries resolve to its own value. | [`AbstractManifestAssetManager`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md) |
| <span id="method-getManagerWorkingDirectory"></span>[`getManagerWorkingDirectory()`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md#method-getManagerWorkingDirectory) protected | Returns the configured manager working directory, or `null` to use the process default. | [`AbstractManifestAssetManager`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md) |
| <span id="method-getNodeModulesPath"></span>[`getNodeModulesPath()`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md#method-getNodeModulesPath) protected | Returns the `node_modules` path under the root package directory. | [`AbstractManifestAssetManager`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md) |
| <span id="method-getRootPackageDir"></span>[`getRootPackageDir()`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md#method-getRootPackageDir) protected | Returns the resolved root package directory. | [`AbstractManifestAssetManager`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md) |
| <span id="method-getRootPackagePath"></span>[`getRootPackagePath()`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md#method-getRootPackagePath) protected | Resolves a path under the root package directory. | [`AbstractManifestAssetManager`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md) |
| <span id="method-getUpdateCommand"></span>[`getUpdateCommand()`](/docs/extensions/foxy/reference/asset/abstractassetmanager/index.md#method-getUpdateCommand) protected | Returns the command that updates the asset dependencies, followed by the `manager-options` and `manager-update-options` values. | [`AbstractAssetManager`](/docs/extensions/foxy/reference/asset/abstractassetmanager/index.md) |
| <span id="method-getVersion"></span>[`getVersion()`](/docs/extensions/foxy/reference/asset/abstractassetmanager/index.md#method-getVersion) protected | Returns the normalized manager version, or `null` when it cannot be detected. | [`AbstractAssetManager`](/docs/extensions/foxy/reference/asset/abstractassetmanager/index.md) |
| <span id="method-getVersionCommand"></span>[`getVersionCommand()`](/docs/extensions/foxy/reference/asset/abstractassetmanager/index.md#method-getVersionCommand) protected | Returns the command that prints the manager version, without the install and update options. | [`AbstractAssetManager`](/docs/extensions/foxy/reference/asset/abstractassetmanager/index.md) |
| <span id="method-normalizeVersionOutput"></span>[`normalizeVersionOutput()`](/docs/extensions/foxy/reference/asset/abstractassetmanager/index.md#method-normalizeVersionOutput) protected | Normalizes the trimmed output of the version command before it is converted. | [`AbstractAssetManager`](/docs/extensions/foxy/reference/asset/abstractassetmanager/index.md) |
| <span id="method-validateAuditConfiguration"></span>[`validateAuditConfiguration()`](/docs/extensions/foxy/reference/asset/abstractassetmanager/index.md#method-validateAuditConfiguration) protected | Validate manager configuration that can change the audit scope. | [`AbstractAssetManager`](/docs/extensions/foxy/reference/asset/abstractassetmanager/index.md) |
| <span id="method-withManagerTimeout"></span>[`withManagerTimeout()`](/docs/extensions/foxy/reference/asset/abstractassetmanager/index.md#method-withManagerTimeout) protected final | Runs the callback with the process timeout set to the `manager-timeout` option and restores the previous timeout afterward, even when the callback throws. | [`AbstractAssetManager`](/docs/extensions/foxy/reference/asset/abstractassetmanager/index.md) |

## Constants

| Constant | Value | Description | Defined by |
| --- | --- | --- | --- |
| <span id="const-NODE_MODULES_PATH"></span>[`NODE_MODULES_PATH`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md#const-NODE_MODULES_PATH) | `'./node_modules'` |  | [`AbstractManifestAssetManager`](/docs/extensions/foxy/reference/asset/abstractmanifestassetmanager/index.md) |

## Method details

### getAuditParser() <span id="method-getAuditParser"></span>

```php
public function getAuditParser(): Foxy\Audit\AuditParserInterface
```

Returns the parser for npm audit JSON output.

**Returns**

[`Foxy\Audit\AuditParserInterface`](/docs/extensions/foxy/reference/audit/auditparserinterface/index.md)

### getLockPackageName() <span id="method-getLockPackageName"></span>

```php
public function getLockPackageName(): string
```

Returns npm's lock-file name.

**Returns**

`string`

### getName() <span id="method-getName"></span>

```php
public function getName(): string
```

Returns the manager name used in Foxy configuration.

**Returns**

`string`

### getVersionConstraint() <span id="method-getVersionConstraint"></span>

```php
public function getVersionConstraint(): string
```

Returns the npm versions supported by this integration.

**Returns**

`string`

### actionWhenComposerDependenciesAreAlreadyInstalled() <span id="method-actionWhenComposerDependenciesAreAlreadyInstalled"></span>

```php
protected function actionWhenComposerDependenciesAreAlreadyInstalled(array $names): void
```

Removes already-installed Composer assets so npm installs their updated manifest paths.

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$names` | `array` |  |

### getAuditCommand() <span id="method-getAuditCommand"></span>

```php
protected function getAuditCommand(bool $noDev): string
```

Returns an npm audit command that covers the root package and every locked workspace.

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$noDev` | `bool` |  |

**Returns**

`string`