Robo Task that brings an import mechanism to your JS files
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src/Task
tests
.editorconfig
.gitattributes
.gitignore
.stickler.yml
.travis.yml
LICENSE.txt
README.md
composer.json
phpunit.xml.dist

README.md

Robo Import JS

Software License Build Status Codecov

This Robo task brings an import method for Javascript files. Think of it as an equivalent of the PHP include function or as the @import statement in SASS files for Javascript files.

Requirements

  • PHP >= 7.1.0
  • Robo

Installation

You can install this Robo task using composer.

The recommended way to install composer packages is:

composer require elephfront/robo-import-js

Using the task

You can load the task in your RoboFile using the LoadImportJavascriptTasksTrait trait:

use Elephfront\RoboImportJs\Task\Loader\LoadImportJavascriptTasksTrait;

class RoboFile extends Tasks
{

    use LoadImportJavascriptTasksTrait;
    
    public function concatJavascript()
    {
        $this
            ->taskImportJavascript([
                'assets/js/main.js' => 'assets/min/js/main.min.js',
                'assets/js/home.js' => 'assets/min/js/home.min.js',
            ])
            ->run();
    }
}

The only argument the taskImportJavascript() takes is an array ($destinationsMap) which maps the source files to the destination files : it will load the assets/js/main.js, do its magic and put the final content in assets/min/js/main.min.js and do the same for all of the other files.

In the end, you will get one file per entry in your maps array.

Import in your JS files are made with the fake roboimport() method:

// in the home.js file
roboimport('libs/jquery');
roboimport('plugins/slider.min.js');

var slider = $('.slider').initSlider();

When reading the content of the home.js file, the task will replace the roboimport() statements with the content of the linked file.

This is particularly useful if you want to have very "page specific" production JS files.

Note that the task can read nested roboimport() statements, meaning an imported file can itself import other files.

Chained State support

Robo includes a concept called the Chained State that allows tasks that need to work together to be executed in a sequence and pass the state of the execution of a task to the next one. For instance, if you are managing assets files, you will have a task that compile SCSS to CSS then another one that minify the results. The first task can pass the state of its work to the next one, without having to call both methods in a separate sequence.

The robo-import-js task is compatible with this feature.

All you need to do is make the previous task return the content the robo-import-js task should operate on using the data argument of a Robo\Result::success() or Robo\Result::error() call. The passed data should have the following format:

$data = [
    'path/to/source/file' => [
        'js' => '// Some javascript code',
        'destination' => 'path/to/destination/file
    ]
];

In turn, when the robo-import-js task is done, it will pass the results of its work to the next task following the same format.

Preventing the results from being written

By default, the robo-import-js task writes the result of its work into the destination file(s) passed in the $destinationsMap argument. If the robo-import-js task is not the last one in the sequence, you can disable the file writing using the disableWriteFile() method. The files will be processed but the results will not be persisted and only passed to the response :

$this
    ->taskImportJavascript([
        'assets/js/main.js' => 'assets/min/main.min.js',
        'assets/js/home.js' => 'assets/min/home.min.js',
    ])
        ->disableWriteFile()
    ->someOtherTask()
    ->run();

Contributing

If you find a bug or would like to ask for a feature, please use the GitHub issue tracker. If you would like to submit a fix or a feature, please fork the repository and submit a pull request.

Coding standards

This repository follows the PSR-2 standard.

License

Copyright (c) 2017, Yves Piquel and licensed under The MIT License. Please refer to the LICENSE.txt file.