The purpose of this plugin is to optimize the images included as part of the UI source.
This is a functioning plugin that can be installed as-is to a Skeletor-equipped project.
To learn more about Skeletor, go here.
After you have cloned this repository, run npm install
in a terminal to install some necessary tools, including a testing framework (Jest) and a linter (ESLint).
The primary source code for this sample plugin is located in the index.js
file.
This sample plugin is pre-configured with the Jest testing framework and an example test.
From a terminal, run npm test
. You should see one test pass and feel pleased.
Test code can be found in the index.test.js
file.
For a Skeletor plugin to function within the Skeletor ecosystem, it must expose a simple API that the Skeletor task runner will interact with. The method signatures of the API are as follows:
The run()
method executes a plugin's primary task. It is the primary way (and, currently, the only way) that the Skeletor task runner interacts with a plugin.
{
Your Name Here
}
a module that provides utilities for working with file and directory paths
A collection of format specific image optimizers