backed-cli

A command line interface for fast es6 development

Installation

```sh $ npm install --global backed-cli ```

Usage

• Create a 'backed.json' file in your projects root example

Commands

Build--build, -b

Bundle your app/component ```sh backed --build ```

Copy--copy, -c

Copy resources ```sh backed --copy ```

Serve--serve, -s

Serve a localhost for your app/component ```sh backed --serve ```

Watch--watch, -w

Watch for file changes, rebuilds & reloads the app/component on change ```sh backed --watch ```

API

backed{options}

options

bundles

Type: array
Default: undefined
Options: src, dest, format, babel An array of objects with each object containing a src & dest property ```json // minimal { "bundles": {

"src": "some/path/to/index",

"dest": "some/path/to/index"

} } // minimal with multiple bundles { "bundles": {

"src": "some/path/to/index",

"dest": "some/path/to/index"

}, {

"src": "some/other/path/to/element",

"dest": "some/other/path/to/element"

} } // all options { "bundles": {

"src": "some/path/to/index",

"dest": "some/path/to/index",

"format": "iife"

}, {

"src": "some/other/path/to/element",

"dest": "some/other/path/to/element",

"format": ["iife", "es"],

"babel": {"babel-config"}

} } ```

format

Type: array
Default: iife
Options: iife, es, cjs, amd The format to build. TODO: deprecate ```json { "format": "es" } // multiple { "format": "iife", "es" } ```

watch{options}

Type: array
Default: ./src
Options: src, options
options can be any chokidar option. ```json { "watch": {

"src": ["./src"],

"options": {}

} } ```

server (documentation not finished check backed.json or when using next next-backed.json)

Type: object
Default: undefined
Options: demo, use, docs Serve your component/app documentation & demo

TODO

• Add more documentation & examples

• Add support for plugins example:
  

- backed-plugin-todo
- backed-plugin-atom
- ...

• Add support for presets example:
  

- backed-preset-element
- backed-preset-app
- backed-preset-atom
- ...

• Serve app after build & copy

• Handle errors

• Run tests with Travis CI & SAUCELABS

Projects using Backed CLI

components

• custom-marked

frameworks

• Backed - Small web framework for quick app & component development

Organizations using Backed CLI

• reeflight

License

MIT © Glenn Vandeuren()