https://github.com/kcmr/broccoli-live-server

Live Server plugin for Broccoli projects
https://github.com/kcmr/broccoli-live-server

broccoli broccoli-plugin live-server

Last synced: 4 months ago
JSON representation

Live Server plugin for Broccoli projects

• Host: GitHub
• URL: https://github.com/kcmr/broccoli-live-server
• Owner: kcmr
• License: mit
• Created: 2019-07-14T21:36:24.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-01-05T03:32:47.000Z (over 3 years ago)
• Last Synced: 2025-03-14T02:39:41.337Z (about 1 year ago)
• Topics: broccoli, broccoli-plugin, live-server
• Language: JavaScript
• Size: 2.04 MB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# broccoli-live-server

[![Build Status](https://travis-ci.com/kcmr/broccoli-live-server.svg?branch=master)](https://travis-ci.com/kcmr/broccoli-live-server)

[![npm version](https://badge.fury.io/js/broccoli-live-server.svg)](https://badge.fury.io/js/broccoli-live-server)

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

[![codecov](https://codecov.io/gh/kcmr/broccoli-live-server/branch/master/graph/badge.svg)](https://codecov.io/gh/kcmr/broccoli-live-server)

[![Greenkeeper badge](https://badges.greenkeeper.io/kcmr/broccoli-live-server.svg)](https://greenkeeper.io/)

![Dependency status](https://img.shields.io/david/kcmr/broccoli-live-server.svg)

Starts a [Live Server](https://github.com/tapio/live-server) from a Broccoli tree.

## Install

```sh

npm i -D broccoli-live-server

```

## Usage

```js

const LiveServer = require('broccoli-live-server');

const tree = funnel('src');

const server = new LiveServer(tree);

return mergeTrees([tree, server]);

```

## API

### LiveServer(tree, [options])

#### options

Type: `Object`   

Default: 

```js

{

  open: false,

  ignore: /.*\.map/

}

```

See [Live Server options](https://github.com/tapio/live-server#usage-from-node).   

Note: the `root` option is set by the plugin to the input path.

## License

This project is licensed under the [MIT License](LICENSE).