https://github.com/i80and/greni

A batteries-included way to quickly build modern, fast, single-page applications
https://github.com/i80and/greni

Last synced: 8 months ago
JSON representation

A batteries-included way to quickly build modern, fast, single-page applications

• Host: GitHub
• URL: https://github.com/i80and/greni
• Owner: i80and
• License: mit
• Created: 2017-03-18T16:50:40.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-09-15T18:59:21.000Z (almost 9 years ago)
• Last Synced: 2025-03-28T20:12:44.767Z (over 1 year ago)
• Language: JavaScript
• Size: 45.9 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# greni [![npm version](https://badge.fury.io/js/greni.svg)](https://badge.fury.io/js/greni)

A batteries-included way to quickly build modern, fast, single-page applications

## Introduction

*Greni* is the Icelandic word for the den of a fox. It is also a build tool that

intelligently concatenates a pipeline of the following tools:

* [svelte](http://svelte.technology)

* [rollup.js](http://rollupjs.org)

* [eslint](http://eslint.org)

* [bublé](http://buble.surge.sh)

* [UglifyJS2 Harmony](https://www.npmjs.com/package/uglify-js-harmony)

* [sorcery](https://www.npmjs.com/package/sorcery)

`greni` is *cunning*, and avoids rebuilding your `svelte` component files unless

they have changed or the build configuration (i.e. `debug` vs `production`) has

changed.

## Usage

Create a `greni.json` file, and populate it with contents such as the following:

    {

        "components": ["src/components/Card.html", "src/components/App.html"],

        "entryPoints": {"index.js": "src/index.js"},

    }

You can also put this in your `package.json` under the `greniConfig` key:

    {

        "greniConfig": {

            "output": "output/",

            "components": ["src/components/Card.html", "src/components/App.html"],

            "entryPoints": {"index.js": "src/index.js"}

        }

    }

Run `greni` or `greni --debug` to build the following artifacts:

* `output/index.js`

* `output/index.js.map`

To automatically rebuild when your source files change, use the

[entr](http://entrproject.org/) utility:

    while true; do find src/ -type f | entr -d greni || break; done

## Configuration Reference

You can configure greni via either a `greni.json` file, or `package.json`

using the `greniConfig` key.

The possible keys in this object are shown below:

| Key         | Value                                                 |

| ----------  | ----------------------------------------------------- |

| components  | An array of svelte component paths. Defaults to `[]`. |

| entryPoints | An object mapping `outputName` -> `entrySourceFile`.  |

| output      | A path. Defaults to `output/`.                        |

| buble       | An object defining `buble` options. Defaults to `null`, meaning `buble` is not run. |

| eslint      | A boolean. Defaults to `true`.                        |

## Future Plans

`greni` may someday become the central tool for building

[Vixeno](https://vixeno.com) apps, and house a repository of common

components.