Skip to content

Latest commit

 

History

History
47 lines (31 loc) · 1.72 KB

index.md

File metadata and controls

47 lines (31 loc) · 1.72 KB
Raw

Getting started

  1. Introduction
  2. Required dependencies
  3. Installation
  4. Usage
  5. Configuration
  6. Event
  7. FAQs

Introduction

Foxy is a Composer plug-in that aggregates npm-packages from Composer packages.

This makes it possible (and automates the process of) installing and updating npm-packages that ship with your Composer packages, leveraging the native (npm or yarn) package manager to do the heavy lifting.

For this approach to work well, you should think of an npm-package in a Composer package not just as an "artifact", but as an actual npm-package embedded in your Composer package.

Importantly, you should name it and version it, independently of your Composer version number - like you would normally do with a stand-alone npm-package.

Note that, for npm-packages with no version number, Foxy will default to the Composer version, as a fallback only: versioning your npm-package explicitly is much safer in terms of correctly versioning breaking/non-breaking changes to any client-side APIs exposed by the embedded npm-package.

Required dependencies

Installation

See the Release Notes to know the Composer version required.

composer require "foxy/foxy:^1.0.0"

Composer will install the plugin to your project's vendor/foxy directory.

Next step

You can read how to: