MCPcopy Index your code
hub / github.com/BrowserSync/browser-sync

github.com/BrowserSync/browser-sync @v3.0.4 sqlite

repository ↗ · DeepWiki ↗ · release v3.0.4 ↗
1,492 symbols 4,640 edges 441 files 355 documented · 24% 21 cross-repo links
README

Keep multiple browsers & devices in sync when building websites.

Follow @Browsersync on twitter for news & updates.

Ask questions on Discord

Features

Please visit browsersync.io for a full run-down of features

Requirements

Browsersync works by injecting an asynchronous script tag (<script async>...</script>) right after the <body> tag during initial request. In order for this to work properly the <body> tag must be present. Alternatively you can provide a custom rule for the snippet using snippetOptions

Upgrading from 1.x to 2.x ?

Providing you haven't accessed any internal properties, everything will just work as there are no breaking changes to the public API. Internally however, we now use an immutable data structure for storing/retrieving options. So whereas before you could access urls like this...

browserSync({server: true}, function(err, bs) {
  console.log(bs.options.urls.local);
});

... you now access them in the following way:

browserSync({server: true}, function(err, bs) {
  console.log(bs.options.getIn(["urls", "local"]));
});

Install and trouble shooting

browsersync.io docs

Integrations / recipes

Browsersync recipes

Support

If you've found Browser-sync useful and would like to contribute to its continued development & support, please feel free to send a donation of any size - it would be greatly appreciated!

Support via PayPal

Supported by

Originally supported by JH - they provided financial support as well as access to a professional designer to help with Branding.

Apache 2 Copyright (c) 2021 Shane Osbourne

Extension points exported contracts — how you extend this code

Inputs (Interface)
(no doc)
packages/browser-sync-client/lib/index.ts
BsError (Interface)
(no doc)
packages/browser-sync/lib/bin.ts
NextArgs (Interface)
(no doc)
tests/utils.ts
InitOptions (Interface)
(no doc)
packages/browser-sync-client/lib/types.ts
BsErrorItem (Interface)
(no doc)
packages/browser-sync/lib/bin.ts
RequestForArgs (Interface)
(no doc)
tests/utils.ts
ISnippetOptions (Interface)
(no doc)
packages/browser-sync-client/lib/types.ts
IServerOption (Interface)
(no doc)
packages/browser-sync/lib/types.ts

Core symbols most depended-on inside this repo

cleanup
called by 284
packages/browser-sync-ui/public/js/app.js
M
called by 143
packages/browser-sync-ui/public/js/app.js
create
called by 97
packages/browser-sync-ui/public/js/app.js
merge
called by 96
packages/browser-sync/lib/cli/cli-options.ts
emit
called by 91
packages/browser-sync-ui/public/js/app.js
fe
called by 74
packages/browser-sync-ui/public/js/app.js
he
called by 72
packages/browser-sync-ui/public/js/app.js
_e
called by 66
packages/browser-sync-ui/public/js/app.js

Shape

Function 1,316
Method 102
Interface 64
Enum 8
Class 2

Languages

TypeScript100%

Modules by API surface

packages/browser-sync-ui/public/js/app.js587 symbols
packages/browser-sync/lib/lodash.custom.js170 symbols
packages/browser-sync/lodash.custom.min.js97 symbols
packages/browser-sync/test/fixtures/bootstrap/js/bootstrap.bundle.js87 symbols
packages/browser-sync/test/fixtures/bootstrap/js/jquery-3.2.1.slim.min.js71 symbols
packages/browser-sync/test/fixtures/bootstrap/js/bootstrap.js23 symbols
packages/browser-sync-client/lib/browser.utils.ts22 symbols
packages/browser-sync/lib/utils.ts21 symbols
packages/browser-sync-client/lib/types/types.d.ts20 symbols
packages/browser-sync-client/lib/types.ts20 symbols
packages/browser-sync/lib/options.ts17 symbols
packages/browser-sync/lib/bin.ts13 symbols

Dependencies from manifests, versioned

@babel/core7.21.3 · 1×
@babel/preset-env7.20.2 · 1×
@babel/preset-typescript7.21.0 · 1×
@playwright/test1.43.0 · 1×
@types/node8 · 1×
angular1.8.2 · 1×
angular-route1.8.2 · 1×
angular-sanitize1.8.2 · 1×
angular-touch1.8.2 · 1×
async-each-series0.1.1 · 1×
babel-loader9.1.2 · 1×
browser-sync2.3.1 · 1×

For agents

$ claude mcp add browser-sync \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact