juniwalk / tessa Goto Github PK

PHP 99.49% JavaScript 0.45% CSS 0.07%

tessa's Introduction

Installation

To install latest version of juniwalk/tessa use Composer.

composer require juniwalk/tessa

Usage

Check config.neon from tests for more details.

extensions:
	tessa: JuniWalk\Tessa\DI\TessaExtension

tessa:
	outputDir: %wwwDir%/static
	checkLastModified: true

	default:
		defer: true
		assets:
			- %moduleDir%/font-awesome/css/font-awesome.min.css
			- %moduleDir%/jquery/dist/jquery.min.js
			- %moduleDir%/bootstrap/dist/css/bootstrap.min.css
			- %moduleDir%/bootstrap/dist/js/bootstrap.min.js
			- %moduleDir%/nette-forms/src/assets/netteForms.min.js
			- %wwwDir%/assets/style.css
			- %wwwDir%/assets/index.js

	frontend:
		extend: default
		assets: []

	backend:
		extend: default
		assets:
			- %wwwDir%/assets/admin.js

	fullcalendar:
		defer: true
		assets:
			- %moduleDir%/fullcalendar/index.global.min.js

Include AssetManager trait to get access to Tessa component.

use JuniWalk\Tessa\Attributes\AssetBundle;
use JuniWalk\Tessa\Traits\AssetManager;

#[AssetBundle('frontend')]
class TessaPresenter extends Presenter
{
	use AssetManager;

	#[AssetBundle('calendar')]
	public function actionCalendar(): void {}
}

Then render styles and scripts in template from Presenter attributes.

<!DOCTYPE html>
<html>
<head>

	<title>Tessa example</title>
	{control tessa:css}
	{control tessa:js}

</head>
<body>

	<!-- your page content -->

</body>
</html>

Alternatively you can render specific part of bundle.

<!DOCTYPE html>
<html>
<head>

	<title>Render just fullcalendar scripts</title>
	{control tessa:js 'fullcalendar'}

</head>
<body>

	<!-- your page content -->

</body>
</html>

tessa's People

Contributors

Watchers

tessa's Issues

ScssAsset: hasBeenModified does not work

Bundle: Add option for direct linking

Do not move assets into outputDir if enabled.

BundleManager: Cache compiled bundles so they are not compiled over and over again

Manager: Handle directLinking by not registering Storage

If Storage is made optional, directLinking could be handled just by not registering it.

Config: Allow explicit type override in config.

There are types of assets that cannot be easily distinguished for types from file extension (url that don't have extension).

For ease of use and fast compiling, there should be an option to explicitly set asset type in the configuration.

Example:

default:
    joinFiles: false
    assets:
        - %wwwDir%/css/style.css --type=js	# as cli param?
        - %wwwDir%/css/style.css?type=js	# as url query?

        # Potential issues
        - https://example.com/script.js --type=js	# should work well
        - https://example.com/script.js?type=js		# could be interpreted as part of the url

And the result

$asset = new FileAsset($file, $type ?? null);

Leave room for future params extension if possible.

When extending, extended bundle must go first

Modules: Generate importMap json for module assets

https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script/type/importmap

Needed to jeep timestamped filenames for cache invalidation.

Bundle: Move most of the properties to array of attributes

Bundles: Per bundle directLinking implementation

Bundle: Allow multiple bundles in extends

Allow bundle composition of multiple other bundles.

Bundle: Add to getAssets optional argument to filter by type

AssetBundle::getCombinedBy could then possibly be dropped as the combination could be done in getAssets

ScssAsset: Parse for @imports and check if hasBeenModified

/**
 * @param  string  $file
 * @param  bool  $checkLastModified
 * @return bool
 */
public function hasBeenModified(string $file, bool $checkLastModified): bool
{
	if (!file_exists($file)) {
		return true;
	}

	if (!$checkLastModified) {
		return false;
	}

	// TODO: Parse for @imports and check those files too

	return filemtime($this->file) > filemtime($file);
}

Bundle: Handle multi-level hierarchy

Right now only single extend is calculated. Add search of extend of the extended bundle.

checkLastModified might not work as the assets are not updated

Manager: Return just list of assets after compiling, do not return bundle instance

Allow clearing previous bundles from attribute importing

BundleManager: Add crc32 checking of files?

Bundle: Add option to include modified time in url

/**
 * @param  Asset  $asset
 * @return string
 */
public function createPublicPath(Asset $asset): string
{
	return str_replace($this->wwwDir, $this->basePath, $asset->getFile()).'?'.$asset->getLastModified();
}

Storage: Ignore result of hasBeenModified in debug mode

BundleManager: Make sure there is no recursion in bundle compilation.

Move $wwwDir & $basePath to BundleManager

Set those values to ReadOnlyBundle on compile so it returns public paths automatically.

FileAsset: filemtime can fail, handle it

https://github.com/juniwalk/tessa/blob/master/src/Assets/FileAsset.php#L45