Allows using SCSS files for MediaWiki styling

2.0.0 2020-04-19 04:07 UTC

This package is auto-updated.

Last update: 2020-05-18 00:21:19 UTC


README

Build Status Latest Stable Version License

The MediaWiki SCSS library provides a ResourceLoader module capable of compiling SCSS.

Requirements

Use

An SCSS module is defined much like any other style module. See the manual for $wgResourceModules. It should also be possible to add the module definition to the extension.json of a MediaWiki extension. See Developing_with_ResourceLoader

There are some additional keys, that may be used:

  • class: This is mandatory. It selects the class to be used for the module. For SCSS the value has to be 'SCSS\\ResourceLoaderSCSSModule'

  • styles: Not really an additional key, but it has extended semantics. This key contains the list of style files of the module. Each file can optionally be given a position to influence the order in which the files are compiled. Allowed values for the position are

    1. beforeFunctions
    2. functions
    3. afterFunctions
    4. beforeVariables
    5. variables
    6. afterVariables
    7. beforeMain
    8. main
    9. afterMain

    If no position is given, main will be assumed.

    All files of one module will be compiled together, i.e. variables, mixins etc. will be shared between them.

  • variables: An array of variables and values to override the SCSS variables in the style files. This allows changing values (e.g. colors, fonts, margins) without having to modify the actual style files.

  • cacheTriggers: Compiling SCSS is expensive, so compiled results are cached. This option lists files that when changed will trigger a flushing of the cache and re-compiling the style files.

    All files on this list will be checked for each web request. To minimizes the load on the file system and the time to build the page it is not advisable to just add all style files to this list.

Here is an example definition:

$wgResourceModules[ 'ext.MyExtension.styles' ] = [

	'class' => 'SCSS\\ResourceLoaderSCSSModule',
	'localBasePath' => $localBasePath,
	'remoteBasePath' => $remoteBasePath,
	'position' => 'top',

	'styles' => [
		'modules/ext.MyExtension.foo.scss' => 'main',
		'modules/ext.MyExtension.bar.scss'
	],
	'variables' => [
		'red' => '#ff0000',
		'green' => '#00ff00',
		'blue' => '#0000ff',
	],
	'cacheTriggers' => [
		'LocalSettings.php',
		'composer.lock',
	],
];

The extension uses the leafo/scssphp compiler, which has some limitations. See the issue list.

Cache type

$egScssCacheType can be set to request a specific cache type to be used for the compiled styles. To disable caching of SCSS styles completely (e.g. during development), set $egScssCacheType = CACHE_NONE;. This should obviously never be done on a production site.

Professional Support

The SCSS extension is maintained by Professional.Wiki. You can contract us to help you with installation or customization of SCSS. We also do development work.

Running the tests

The tests can only be run when the library is loaded within MediaWiki. You can add it via composer.local.json (probably using dev-master).

Inside your MediaWiki root directory

php tests/phpunit/phpunit.php -c vendor/mediawiki/scss/phpunit.xml.dist

License

You can use the SCSS extension under the GNU General Public License, version 3 (or any later version).

Release notes

Version 2.0

Releases on 2020-04-19

  • Turned MediaWiki extension into a standard PHP/Composer library
  • Switched to new version of scssphp

Version 1.0

Initial release