yiisoft/assets

Asset bundles and asset manager

4.0.0 2023-02-13 11:15 UTC

Requires

• php: ^8.0
• ext-mbstring: *
• psr/log: ^1.1|^2.0|^3.0
• yiisoft/aliases: ^1.1|^2.0|^3.0
• yiisoft/files: ^2.0
• yiisoft/json: ^1.0

Requires (Dev)

• maglnet/composer-require-checker: ^4.2
• phpunit/phpunit: ^9.5
• rector/rector: ^0.15.3
• roave/infection-static-analysis-plugin: ^1.16
• spatie/phpunit-watcher: ^1.23
• vimeo/psalm: ^4.30|^5.6
• yiisoft/di: ^1.2
• yiisoft/test-support: ^3.0

BSD-3-Clause

• assets
• library
• yii

README

Yii Assets

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

Requirements

• PHP 8.0 or higher.
• mbstring PHP extension.

Installation

The package could be installed via composer:

composer require yiisoft/assets --prefer-dist

General 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).

Testing

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 with Infection Static Analysis Plugin. To run it:

./vendor/bin/roave-infection-static-analysis-plugin

Static analysis

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

./vendor/bin/psalm

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.

Support the project

Follow updates