vite-plugin-browser-sync - GitLite

KO | EN

gitlite — search

#javascript #hacktoberfest #typescript #golang #android #machine-learning #deep-learning #docker #awesome #pytorch #mcp #ios #openai #open-source

vite-plugin-browser-sync

(★ 91)

Add BrowserSync in your Vite project

파일 탐색기

최종 버전 다운로드 (.zip)

- - ci.yml
- - .gitignore
  - astro.config.mjs
  - package.json
  - README.md
  - tsconfig.json
- - .gitignore
  - favicon.svg
  - index.html
  - package.json
  - tsconfig.json
  - vite.config.ts
- env.d.ts
- index.ts
- server.ts
- types.ts
- - dev.test.ts
  - preview.test.ts
- - buildWatch.test.ts
  - error.test.ts
- _global.ts
- _helper.ts
.gitignore
eslint.config.js
LICENSE
package.json
pnpm-lock.yaml
pnpm-workspace.yaml
README.md
screenshot.jpg
tsconfig.json
tsdown.config.ts
vitest.config.ts

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/Applelo/vite-plugin-browser-sync

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd vite-plugin-browser-sync

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Node.js

쉬움 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.

npm i -D vite-plugin-browser-sync

이 명령어를 터미널에 그대로 입력해 실행하세요.

yarn add -D vite-plugin-browser-sync

이 명령어를 터미널에 그대로 입력해 실행하세요.

pnpm add -D vite-plugin-browser-sync

이 명령어를 터미널에 그대로 입력해 실행하세요.

✅ 명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![npm](https://img.shields.io/npm/v/vite-plugin-browser-sync)](https://www.npmjs.com/package/vite-plugin-browser-sync) [![node-current](https://img.shields.io/node/v/vite-plugin-browser-sync)](https://nodejs.org/) [![Coverage Status](https://coveralls.io/repos/github/Applelo/vite-plugin-browser-sync/badge.svg?branch=main)](https://coveralls.io/github/Applelo/vite-plugin-browser-sync?branch=main)

# vite-plugin-browser-sync

Add [BrowserSync](https://browsersync.io) to your Vite project.

> This plugin supports Vite 7 and 8.

<p align="center">
<a href="https://github.com/Applelo/vite-plugin-browser-sync/blob/main/screenshot.jpg?raw=true">
<img src="https://raw.githubusercontent.com/Applelo/vite-plugin-browser-sync/main/screenshot.png?raw=true" alt=""/>
</a>
</p>

## 🚀 Features

- ⚡ Fully integrated in your ViteJS environment
- 👌 Zero config available for common use cases
- ✨ All the [BrowserSync features](https://browsersync.io/)
- 🙌 Support for BrowserSync `proxy` and `snippet` mode
- 🔥 Freedom to manage BrowserSync options
- 🎛️ Can run on `dev`, `preview` or `build --watch`

## 📦 Install

```
npm i -D vite-plugin-browser-sync

# yarn
yarn add -D vite-plugin-browser-sync

# pnpm
pnpm add -D vite-plugin-browser-sync

# bun
bun add -D vite-plugin-browser-sync
```

## 👨‍💻 Usage

By default, BrowserSync will start alongside your Vite Server in `dev`. It uses the `proxy` mode of BrowserSync based on your Vite server options: no need to pass any options to make it work!

```js
// vite.config.js / vite.config.ts
import VitePluginBrowserSync from 'vite-plugin-browser-sync'

export default {
  plugins: [VitePluginBrowserSync()]
}
```

If you want to manage BrowserSync or [override default behavior of this plugin](https://github.com/Applelo/vite-plugin-browser-sync#vite-plugin-browser-sync-options-for-browsersync), you can pass a `bs` object with your [BrowserSync options](https://browsersync.io/docs/options) in it:

```js
// vite.config.js / vite.config.ts
import VitePluginBrowserSync from 'vite-plugin-browser-sync'

export default {
  plugins: [
    VitePluginBrowserSync({
      dev: {
        bs: {
          ui: {
            port: 8080
          },
          notify: false
        }
      }
    })
  ]
}
```

If you need the `snippet` mode of BrowserSync, the plugin supports it by injecting the script automatically.

```js
// vite.config.js / vite.config.ts
import VitePluginBrowserSync from 'vite-plugin-browser-sync'

export default {
  plugins: [
    VitePluginBrowserSync({
      dev: {
        mode: 'snippet'
      }
    })
  ]
}
```

You can also enable the plugin on `vite build --watch` mode and `vite preview` mode.

> [!IMPORTANT]
> - In `buildWatch`, if you use the default `proxy` mode you need to set the `bs` object.
> - `snippet` mode is available in `buildWatch` but it is not recommended to use since it updates your `index.html` file.
> - In `preview`, only the `proxy` mode is supported since it will not inject the `snippet`.

```js
// vite.config.js / vite.config.ts
import VitePluginBrowserSync from 'vite-plugin-browser-sync'

export default {
  plugins: [
    VitePluginBrowserSync({
      dev: {
        enable: false,
      },
      preview: {
        enable: true,
      },
      buildWatch: {
        enable: true,
        bs: {
          proxy: 'http://localhost:3000',
        }
      }
    })
  ]
}
```

> [!NOTE]
> For Astro users, this plugin does not work in preview mode because of [overrides made by Astro](https://github.com/withastro/astro/blob/a6c4e6754493e7af5c953b644c6a19461f15467b/packages/astro/src/core/preview/static-preview-server.ts#L40).

## vite-plugin-browser-sync options for BrowserSync

This plugin overrides default options from BrowserSync to avoid duplicating behaviors already handled by ViteJS. Furthermore, your ViteJS config is synced with BrowserSync.

If you want to change the overridden options you are free to do so via the `bs` object.

| Option                                                          | Why                                                                                                                            | dev | buildWatch | preview |
|-----------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------|:---:|:----------:|:-------:|
| [logLevel](https://browsersync.io/docs/options#option-logLevel) | Set to `silent`, use ViteJS [printUrls](https://vitejs.dev/guide/api-javascript.html#createserver) to display BrowserSync info |  ✔️  |      ✔️     |    ✔️    |
| [open](https://browsersync.io/docs/options#option-open)         | Apply ViteJS [open option](https://vitejs.dev/config/server-options.html#server-open)                                          |  ✔️  |            |    ✔️    |
| [codeSync](https://browsersync.io/docs/options#option-codeSync) | Disabled because it is already handled by ViteJS                                                                               |  ✔️  |            |         |
| [online](https://browsersync.io/docs/options#option-online)     | Synced with the [server host option](https://vitejs.dev/config/server-options.html#server-host)                                |  ✔️  |            |    ✔️    |

### For `proxy` mode

| Option                                                           | Why                                           | dev | buildWatch | preview |
|------------------------------------------------------------------|-----------------------------------------------|:---:|------------|:-------:|
| [proxy.target](https://browsersync.io/docs/options#option-proxy) | Inject the right url from ViteJS              |  ✔️  |            |    ✔️    |
| [proxy.ws](https://browsersync.io/docs/options#option-proxy)     | Force websocket proxy to make ViteJS HMR work |  ✔️  |            |    ✔️    |

### For `snippet` mode

| Option                                                              | Why                                                    |
| ------------------------------------------------------------------- | ------------------------------------------------------ |
| [logSnippet](https://browsersync.io/docs/options#option-logSnippet) | Handled by the plugin so no need to display the snippet |
| [snippet](https://browsersync.io/docs/options#option-snippet)       | The snippet injection is handled by the plugin          |

## 👨‍💼 License

MIT