Codify Images

[![License][License Badge]](LICENSE)
[![Version][Version Badge]][Version Package]
[![Release][Release Badge]][Release Workflow]
[![Coverage][Coverage Badge]][Coverage Report]
[![Node Version][Node Version Badge]](package.json#L75)

Quick and easy tool for converting a set of images into inline JavaScript.

Installation

``console
npm i -D codify-images
`

Usage

There are 2 uses of this package either as a library or a command line interface
(CLI).

$3

An example of typical usage as a library can be found below.

`js
import { codifyImages, codifyImagesSync } from 'codify-images';

const options = {
svgMode: 'base64',
ignoreUnsupportedTypes: true,
log: (name, path) => {...}
};
let images = await codifyImages('path/to/assets', options); // asynchronous

images = codifyImagesSync('path/to/assets', options); // synchronous
`

The images object returned will have a member for each file, of supported
type, found at the location path/to/assets formatted as camel case. Assuming
path/to/assets has 3 files in that location (test.gif, test.png and
test.svg) the resulting images would look like the following.

`js
const images = {
testGif: 'data:image/gif;base64,...',
testPng: 'data:image/png;base64,...',
testSvg: 'data:image/svg+xml;base64,...'
};
`

#### Options

* svgMode: Allows you to supply the mode that will be used to generate SVG
outputs. The current options are base64, uri, mini, mini-srcset. The
default for this setting is base64 and is the recommended setting as it has
the highest compatibility with different use cases. For more info related to
the mini and mini-srcset modes please consult the [Mini SVG Data] package
documentation.
* ignoreUnsupportedTypes: This will allow files of unsupported types to be
simply skipped instead of throwing an UnsupportedTypeError error. The
default for this setting is true.
* log: This allows you to add a custom logger that will be called after each
file is processed. The callback provides the arguments name and path.

$3

Below is the output of codify-images --help.

`console
Usage: codify-images [options]

Arguments:
input path path to where image files reside

Options:
-V, --version output the version number
-d, --double-quotes Use double quotes for output instead of single quotes (default: false)
-o, --output path to write generated files (default: "generated")
-e, --es version of ESM to generate (default: 6)
-c, --indent-count number of indent elements to output (default: 1)
-B, --no-banner do not include banner comment at top of generated file
-t, --indent-type type of indent to output (choices: "tab", "space", default: "tab")
-s, --svg-mode output mode to use for SVG images
(choices: "base64", "uri", "mini", "mini-srcset", default: "base64")
-h, --help display help for command
`

Development

Development can be done on any machine that can install Node.js. Only the
latest LTS version is tested against.

$3

Install dependencies via npm.

`console
npm i
`

$3

Execute linters via npm.

`console


git, javascript, markdown and package.json

npm run lint

git only

npm run lint:git

javascript only

npm run lint:js

markdown only

npm run lint:md

package.json only

npm run lint:pkg
`

$3

Execute tests via npm.

`console


lint and unit tests

npm test

unit tests only

npm run test:unit
`

$3

Execute fixers via npm.

`console


javascript, markdown and package.json

npm run fix

javascript only

npm run fix:js

markdown only

npm run fix:md

package.json only

npm run fix:pkg
`

$3

Run a build via npm.

`console
npm run build
``

[License Badge]: https://img.shields.io/github/license/devpow112/codify-images?label=License
[Version Badge]: https://img.shields.io/npm/v/codify-images?label=Version
[Version Package]: https://www.npmjs.com/codify-images
[Node Version Badge]: https://img.shields.io/node/v/codify-images
[Release Badge]: https://github.com/devpow112/codify-images/actions/workflows/release.yml/badge.svg?branch=main
[Release Workflow]: https://github.com/devpow112/codify-images/actions/workflows/release.yml?query=branch%3Amain
[Coverage Badge]: https://img.shields.io/coveralls/github/devpow112/codify-images/main?label=Coverage
[Coverage Report]: https://coveralls.io/github/devpow112/codify-images?branch=main
[Mini SVG Data]: https://www.npmjs.com/package/mini-svg-data-uri