hydrawiki / lessoid
A persistent Less.js RESTful API parser service using Node.js.
Requires
- php: >=7.0
This package is auto-updated.
Last update: 2024-12-12 10:05:51 UTC
README
A LESS parser running as a Node.js RESTful API and implements the official Less.js package.(See notes below.) It is intended as a replacement for the oyejorge/less.php package and works as a drop in replacement for MediaWiki. It can be used for other projects.
Why LESSoid?
In the Hydra Wiki Farm, the default LESS.php parser doesn't play well with caching across shared file systems such as gluster and relies on slow file caching techniques. This Node.js solution uses an in-memory cache and can share the cache to multiple web nodes using Redis.
As for the name, we figured it matched MediaWiki's naming conventions. Parsoid, Mathoid... Why not LESSoid?
LESSoid versus LESS.php
PROS
- Initial benchmarks show significant performance increases for parsing and high concurrency situations.
- Once the code enters a beta stage we will release official benchmarks.
- New Less.js releases can be implemented immediately to get new features and bug fixes.
- Initial benchmarks show significant performance increases for parsing and high concurrency situations.
CONS
- Installations on shared hosts that can not run LESSoid as a service will fall back to invoking lessc from the command line. The lessc fall back will be slower then less.php in most situations.
How does it work?
The LESSoid package presents a Less_Parser class that is compatible with the less.php class of the same name. Existing projects should be able remove the existing less.php package and instead include lessoid package. If there are compatibility problems please report the issue.
All file includes, variables, and other required pieces are funnelled through a RESTful API request to the LESSoid service running localhost which return the compiled CSS as a JSON response. If the LESSoid service is not running then it will automatically fall back to invokving lessc through the command line. The lessc fall back prevents the loss of CSS on a site, but can be as slow as less.php.
Requirements
- PHP 7.0+
- Node.js 4+
- A process manager service such as supervisord, god, launchctl, or otherwise. A god configuration example is provided.
- Alternativly, if you don't already have a process manager service in place, PM2 is a fantastic and user friendly process manager that works great with LESSoid.
- Your poject's code checkout that contains all necessary LESS, CSS, and other requirements must be present on the server as the LESSoid service.
How to use
Installation through composer into your project:
composer require hydrawiki/lessoid
Without composer, download the latest release from the GitHub project and place it in an appropriate place in the project. (https://github.com/HydraWiki/lessoid/releases)
Please note: This is incompatible with oyejorge/less.php, so please make sure you (or composer) are not requiring it!
Configuration
- In
lib/config.defaults.iniyou will find the configuration for the MediaWiki shim that interfaces MediaWiki with LESSoid.- It's best not to modify this file, but instead create a
lib/config.inifile and put any settings overrides in it, so that future updates won't undo your configuration changes.
- It's best not to modify this file, but instead create a
- In
services/lessoid/config.jsonyou will find configuration options for the LESSoid service its self. They should all mostly be pretty self explanatory at this point.
Current Development Status
This is alpha level code and the first target is to work seamlessly with MediaWiki. There are various configuration settings that need to be implemented properly so it works not only seamlessly on MediaWiki, but on on frameworks as well.
For MediaWiki implementation, It currently implements a Less_Parser class that mimics the Less_Parser class from Less.php that MediaWiki uses by deault. It works great, but could probably be made cleaner if not having to drop directly into MediaWiki.
Other Notes
We are currently using Less.js version 3.9.0 with a small modification to make it friendlier in a MediaWiki environment. In the future we plan to eliminate this modification and have it user upgradeable through node package manager.