eloquent/composer-npm-bridge

NPM integration for Composer packages.

Installs: 6 853

Dependents: 5

Stars: 45

Watchers: 7

Forks: 2

Open Issues: 2

Language: PHP

2.1.1 2014-09-08 03:57 UTC

README

NPM integration for Composer packages.

The most recent stable version is 2.1.1 Current build status image Current coverage status image

CURRENTLY BROKEN

Due to upstream Composer changes, this plugin no longer works as intended (see #8). Pull requests are welcome.

Installation and documentation

Requirements

  • The npm executable must be available in PATH

Usage

To utilize the Composer NPM bridge, simply add eloquent/composer-npm-bridge to the require section of the project's Composer configuration:

composer require eloquent/composer-npm-bridge:~2

NPM dependencies are specified via a package.json configuration file in the root directory of the Composer package. Source control should be configured to ignore NPM's node_modules directory, similar to Composer's vendor directory.

How does it work?

The Composer NPM bridge is a Composer plugin that automatically installs and updates NPM packages whenever the corresponding Composer command is executed. To detect compatible packages, the bridge inspects Composer package configuration information to find packages that directly require the eloquent/composer-npm-bridge Composer package itself.

In addition to normal operation, composer install will install NPM dependencies for all Composer packages using the bridge. This includes the root package, as well as Composer dependencies. Similarly, composer update will install NPM dependencies for all Composer dependencies using the bridge. It will also update and shrinkwrap the NPM dependencies for the root project.

NPM dependencies will be installed exactly as if npm install were run from the root directory of the package. This applies even if the package is installed as a dependency.

Caveats

Because NPM dependencies are installed underneath the root directory of the Composer package, Composer may complain about working copy changes when the package is installed as a dependency. Source control should be configured to ignore the node_modules directory in order to avoid this.