brucealdridge / assets

Assets management

Yii Assets

The package impements client-side asset (such as CSS and JavaScript) management for PHP. It helps resolving dependencies and getting lists of files ready for generating HTML <script and <link tags.

Installation

The package could be installed via composer:

composer require yiisoft/assets

Usage

There are three main steps using the package:

1. Define asset bundles. These are config classes defining where your assets are and how they should be used.
2. Register bundles to asset manager and obtain list of files to include.
3. Optionally use asset converter with asset bundle for asset format conversion (such as TypeScript to JavaScript).
4. Use your favorite method to include files into HTML (out of scope of this package).

Extra development requirements

The package tests depend on foxy/foxy that needs npm installed.

Unit testing

The package is tested with PHPUnit. To run tests:

./vendor/bin/phpunit

Mutation testing

The package tests are checked with Infection mutation framework. To run it:

./vendor/bin/infection

Static analysis

The code is statically analyzed with Psalm. To run static analysis:

./vendor/bin/psalm

Support the project

Follow updates

License

The Yii Assets is free software. It is released under the terms of the BSD License. Please see LICENSE for more information.

Maintained by Yii Software.