inpsyde/composer-assets-compiler

Composer plugin that installs and compile frontend dependencies for installed Composer packages based on configuration.

3.0.1 2023-05-29 11:09 UTC

Requires

• php: >= 7.2 < 8.3
• composer-plugin-api: ^1 || ^2
• ext-json: *

Requires (Dev)

• composer/composer: ^1.10.24 || ^2.5.5
• inpsyde/php-coding-standards: ^1.0.0
• mikey179/vfsstream: ^1.6.11
• mockery/mockery: ^1.3.5 || ^1.4.4
• phpunit/phpunit: ^8.5.33 || ^9.6.7
• vimeo/psalm: >=4.30.0

MIT

• Inpsyde GmbH
• Giuseppe Mazzapica

README

What is this

A Composer plugin that automatically "compiles" frontend assets (js, css, etc.) for packages installed via Composer.

A quick example

Let's assume we have a website project having a composer.json that looks like this:

{
    "name": "acme/my-project",
    "require": {
        "acme/foo": "^1",
        "acme/bar": "^2",
        "inpsyde/composer-assets-compiler": "^3"
    },
    "extra": {
        "composer-asset-compiler": { "auto-run": true }
    }
}

And then suppose that acme/foo's composer.json looks like this:

{
    "name": "acme/foo",
    "extra": {
        "composer-asset-compiler": "gulp"
    }
}

and acme/bar's composer.json looks like this:

{
    "name": "acme/bar",
    "extra": {
        "composer-asset-compiler": "build"
    }
}

When we'll install the project with Composer, the following happens:

1. Composer installs the three required packages
2. Immediately after that, the plugin executes and:
   1. the plugin looks for all installed packages (including transitive dependencies) that have a composer-asset-compiler configuration, finding "acme/foo"and "acme/bar"
   2. moves to "acme/foo" installation folder, and executes npm install && npm run gulp
   3. moves to "acme/bar" installation folder, and executes npm install && npm run build

At the end of the process, we have a project with the dependencies installed, and their assets processed.

The example above is the simplest use case, but the plugin has many possible configurations and advanced use cases.

Documentation

• Introduction
• Compiling Assets
• Script
• Dependencies
• Package Manager
• Pre-compilation
• Hash and Lock
• Execution Mode
• Configuration File
• Packages Configuration in Root
• Verbosity
• Isolated Cache
• Parallel Assets Processing
• Configuration Cheat-Sheet
• CLI Parameters
• Environment Variables

Copyright and License

Good news, this library is free for everyone! Since it's released under the MIT License you can use it free of charge on your personal or commercial website.