mishak/web-resource-management

Tools for management of scripts and styles (using Nette Framework)

Maintainers

Details

github.com/mishak87/web-resource-management

Source

Issues

Installs: 62

Dependents: 2

Suggesters: 0

Security: 0

Stars: 0

Watchers: 2

Forks: 0

Open Issues: 0

1.4 2013-04-10 23:34 UTC

Requires

BSD-3-Clause, GPL-2.0, GPL-3.0 32396f3914b4378a74a0b4d757e8274e97dbd89f

dependencymanagernettescriptsstyleresource

This package is not auto-updated.

Last update: 2024-11-23 13:44:51 UTC

README

Main purpose is to simplify resource management of scripts and styles by moving their definition to configs (of modules) and automated generating of content.

EXPERIMENTAL! BC breaks might occur. This is still more of a draft then proper code so please bear with me.

Installation

Add to your composer.json requirement "mishak/web-resource-management": "dev-master". Directory %WWW_DIR%/generated must be writable by server. Scripts must be under %WWW_DIR%/js directory for now.

Bootstrap

$configurator = new Nette\Config\Configurator;
// after the line above
Mishak\WebResourceManagement\DI\WebResourceManagementExtension::register($configurator);
// before the line bellow
$container = $configurator->createContainer();

In template

<head>
	...
	{include ../../libs/mishak/web-resource-management/@styles.latte}
</head>

<body>
	...
	{include ../../libs/mishak/web-resource-management/@scripts.latte}
</body>

Capabilities

  • dependency management

Scripts

  • translations
  • per script configuration
  • using public, minified and raw version of script based on debugMode and config

Styles

  • support for less (you must have lessc in path)
  • extracting resources to new folders to prevent caching issues using new url
  • renaming file to prevent caching issues
  • generating of gzipped files - can be used by nginx using gzip_static on;

Usage

In config.neon:

resources:

	styles:
		bootstrap:
			filename: %appDir%/../libs/twitter/bootstrap/less/bootstrap.less
		bootstrap.responsive:
			filename: %appDir%/../libs/twitter/bootstrap/less/responsive.less
			depends: bootstrap

	scripts:
		jquery:
			filename: jquery-1.8.2.js
			public: //ajax.googleapis.com/ajax/libs/jquery/1.8.2/jquery.js
		bootstrap:
			filename: bootstrap.js
			minified: bootstrap.min.js
			depends: jquery
		main:
			filename: main.js
			depends: [ jquery, bootstrap ]
  • attribute depends is optional, defaults to empty array ([ ])

Scripts

  • minified version is optional
  • at least filename or public must be defined
  • switching between is done automatically in this order (productionMode = TRUE) public > minified > filename (debugMode = TRUE)