@comparaonline/assets

@comparaonline/assets

This project has as objective have a single point to store and access common assets among multiple applications. The output files will be uploaded to a CDN with a long duration cache.

Install

yarn add @comparaonline/assets

Usage

import image from '@comparaonline/assets/image';

Then, you can explicity include an image

image('logos/comparaonline.svg');

The output will be like this:

'https://cdnjs.comparaonline.com/assets/images/af6085a0e7e3f3af17c78f30e3384e0e.svg';

Autocomplete

The TypeScript definitions let us discover the available assets using a IDE with autocomplete support

How to add new assets

The source of the assets is the src folder. Place them according to its type. The convention is to have an entry file per each asset, in the image case, there is a folder with a small function to map the keys in the manifest file. The idea of have multiple entries by asset type is take advance of the tree shaking features or only use the required portions of the assets gallery.

If you need to check the output, you'll need to run the optimize step:

yarn optimize:images

Note: This step is automatically executed in the Jenkins workflow.