0.1.2 • Published 6 years ago

brunch-browser-sync v0.1.2

Weekly downloads
-
License
MIT
Repository
github
Last release
6 years ago

Brunch-browser-sync

Adds Browser Sync support to brunch.

Install

Install the plugin via npm with npm install --save-dev brunch-browser-sync.

Or, do manual install:

  • Add "brunch-browser-sync": "~x.y.z" to package.json of your brunch app.
  • If you want to use git version of plugin, use the GitHub URI "brunch-browser-sync": "arcesilas/brunch-browser-sync".

Usage

Simply run brunch watch (without -s) option) to have Browser Sync serve your files and update your browser.

Configuration

Please see BrowserSync configuration to configure BrowserSync in your Brunch plugin configuration. For example:

exports.plugins = {
    browserSync: {
        port: 8000,
        server: "app/",
        open: false
    }
};

Default configuration:

{
    watch: true,
    open: 'local',
    server: 'public/',
    enabled: true,
}

Tests

There are currently no tests for a simple reason: I know nothing about tests with Node and/or JS.

Help is welcome to provide tests, if possible with code coverage.

Contributing

This package follows Vincent Driessen's git branching model.

This means that the master branch is the latest production ready version. The latest unstable version is develop.

Contributing to source code

To contribute and submit your contribution:

  • first of all, thank you!
  • please fork the repository and create a new feature branch
  • submit a PR from that branch

Bugs

Please open a new issue and provide any relevant information to help us reproduce the bug.

New features

If you think this package lacks a feature, feel free to open a new issue to explain how this package could be improved.