catdawg / assetchef

A node library to process assets using a configurable a pipeline

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Build Status Codacy Badge Codacy Badge

LIBRARY IN DEVELOPMENT, NOT READY TO USE

Asset Chef

A library for processing assets through a configurable pipeline. The pipeline is configured by a recipe.json file. The recipe configures a sequence of modules that are executed on assets. Each module is a separate library. Examples of possible libraries are: A downscaler for pngs, a atlas packer, a aws uploader, a json to binary converter.

Installation

npm install @catdawg/assetchef

Usage

This library is still in a very initial stage, but the very basic usage will look like this:

var assetchef = require('@catdawg/assetchef');

assetchef.loadRecipe("recipe.json");
assetchef.cook();

The idea is to also integrate this library into a running app, so it can be watching a directory, and we can run the assetchef only on files that change.

Roadmap

  • Recipe Loading (In Progress)
  • Validate JSON
  • Resolve Dependencies
  • Recipe Step
  • Define Structure
  • Make recipe loading validate step options section dynamically.
  • ... many other things

Tests

npm test

About

A node library to process assets using a configurable a pipeline

License:MIT License


Languages

Language:TypeScript 98.0%Language:JavaScript 1.9%Language:Shell 0.1%Language:HTML 0.1%