# sourcejs-contrib-browser-sync

> Browser Sync integration into SourceJS

Latest version **0.1.1** (published 2015-04-06) · 0 weekly downloads

## Install

```sh
npm install sourcejs-contrib-browser-sync
pnpm add sourcejs-contrib-browser-sync
yarn add sourcejs-contrib-browser-sync
bun add sourcejs-contrib-browser-sync
```

## Health

**Score 10/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2015-04-06 |
| First published | 2015-04-06 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Robert Haritonov |
| Maintainers | sourcejs |
| Keywords | sourcejs, plugin, browser-sync |

## Links

- npm: https://www.npmjs.com/package/sourcejs-contrib-browser-sync
- Repository: https://github.com/sourcejs/sourcejs-contrib-browser-sync
- Issues: https://github.com/sourcejs/sourcejs-contrib-browser-sync/issues
- npm.io page: https://npm.io/package/sourcejs-contrib-browser-sync

## Dependencies (2)

- [deep-extend](https://npm.io/package/deep-extend.md) ^0.3.3
- [browser-sync](https://npm.io/package/browser-sync.md) 2.5.2

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 0.1.1 (latest) — 2015-04-06
- 0.1.0 — 2015-04-06

## README

Browser Sync integration into SourceJS
===============

Run [browser-sync](http://www.browsersync.io) together with [SourceJS](http://sourcejs.com). Get instant web-page updates after changing Spec file or JS, CSS assets.

___

To install, run npm in `sourcejs/user` folder:

```
npm install sourcejs-contrib-browser-sync --save
```

Then restart SourceJS, plugin will be enabled on next engine start.

## Options

In `user/options.js` use `plugins.browserSync` object. Available options:

```
{
    enabled: true,
    forceEnabled: false,

    browserSync: {
        files: [
            'specs/**/index.+(src|src.html)',
            'specs/**/*.css',
            'specs/**/*.js'
        ],
        logSnippet: false,
        codeSync: false,
        open: false
    }
}
```

* `forceEnabled` - by default plugin is activated only for `development` environment, if you want to force run it in other modes, set this option to `true`
* `browserSync` - contains [configuration](http://www.browsersync.io/docs/options) passed to BrowserSync directly
* `browserSync.files` - paths to watch, relative to `sourcejs/user` folder

## TODO

* Check the path of changed files and update only specific Spec URL
* Add SourceJS DSS plugin support (refresh spec on CSS with docs change)

___

Compatible with SourceJS v0.5.1+.

---
_Source: https://npm.io/package/sourcejs-contrib-browser-sync · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._