nodejs-php-fallback/nodejs-php-fallback

Allow you to call node.js module or scripts throught PHP and call a fallback function if node.js is not available

1.6.0 2020-10-30 09:26 UTC

Requires

• php: >=7.3
• composer-plugin-api: ^1.0 || ^2.0

Requires (Dev)

• composer/composer: ^2.0
• phpmd/phpmd: ^2.9
• phpunit/phpunit: ^8.5

MIT

• Kyle

README

Allow you to call node.js module or scripts throught PHP and call a fallback function if node.js is not available.

Usage

Edit composer.json to add nodejs-php-fallback to "require", your "npm" dependancies to "extra" and "NodejsPhpFallback\\NodejsPhpFallback::install"to both "post-install-cmd" and "post-update-cmd" in "scripts"

For example, to use node.js stylus and fallback to the php kylekatarnls/stylus port, use:

...
"require": {
    "nodejs-php-fallback/nodejs-php-fallback": "*",
    "kylekatarnls/stylus": "*"
},
"extra": {
    "npm": {
        "stylus": "^0.54"
    }
},
"scripts": {
    "post-install-cmd": [
        "NodejsPhpFallback\\NodejsPhpFallback::install"
    ],
    "post-update-cmd": [
        "NodejsPhpFallback\\NodejsPhpFallback::install"
    ]
},
...

With this configuration, both node stylus and php kylekatarnls/stylus packages will be installed and updated when you update or install with composer if node is installed, else, only the php package will be.

So you can easily create a function that will try first to call the node package, then else the php one:

use NodejsPhpFallback\NodejsPhpFallback;
use Stylus\Stylus;

function getCssFromStylusFile($stylusFile)
{
    $node = new NodejsPhpFallback();
    $fallback = function () use ($stylusFile) {
        $stylus = new Stylus();

        return $stylus->fromFile($stylusFile)->toString();
    };

    return $node->execModuleScript('stylus', 'bin/stylus', '--print ' . escapeshellarg($stylusFile), $fallback);
}

$css = getCssFromStylusFile('path/to/my-stylus-file.styl');

Here $css will contain CSS code rendered from your stylus file, no matter node is installed or not. So you can install node on your production environment to benefit of the last official version of a npm package but any one can test or develop your project with no need to install node.

Note: the PHP fallback can be a simple php function, not necessarily a call to a class or a composer package.

Settings

The extra.npm can be an object with npm required packages as key and versions for each of them as value (see https://docs.npmjs.com/misc/semver for version definition). You can also set it as an array of package names, it's the same as specify all packages dependancies with "*" version. Else if you need only one package and don't care about the version, just pass it as a string:

Array configuration:

"extra": {
    "npm": [
        "hamljs",
        "kraken-js"
    ]
},

String configuration:

"extra": {
    "npm": "express"
},

Ask the user to confirm package install

You can use the npm-confirm setting to ask the user if he want to install one or more npm package. This should be used to make the user aware npm packages will be installed, and what for they are. This is also a way to not install optional packages if they are used in a user specific case.

"extra": {
    "npm": [
        "stylus",
        "less",
        "clean-css",
    ],
    "npm-confirm": {
        "stylus": "This package is needed if you have stylus files.",
        "less": "This package is needed if you have less files."
    }
},

With the configuration above, when the user will execute compoers update or composer install, he will be asked the following:

The node package [stylus] can be installed:
This package is needed if you have stylus files.
Would you like to install/update it? (if you're not sure, you can safely press Y to get the package ready to use if you need it later) [Y/N] 

The node package [less] can be installed:
This package is needed if you have less files.
Would you like to install/update it? (if you're not sure, you can safely press Y to get the package ready to use if you need it later) [Y/N] 

Each of stylus and less packages will be installed only if the user enter Y on confirm or if he ran the command with the mode --no-interaction.

The clean-css package will be installed with no confirm.