yiisoft/assets

Asset bundles and asset manager

1.0.1 2021-08-30 18:20 UTC

This package is auto-updated.

Last update: 2021-10-07 21:11:24 UTC


README

68747470733a2f2f796969736f66742e6769746875622e696f2f646f63732f696d616765732f7969695f6c6f676f2e737667

Yii Assets


Latest Stable Version Total Downloads Build Status Scrutinizer Code Quality Code Coverage Mutation testing badge static analysis type-coverage

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 7.4 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

Open Collective

Follow updates

Official website Twitter Telegram Facebook Slack