# gulp-proxy-inject-css

> gulp plugin for UserCSS live reload

Latest version **0.1.3** (published 2019-03-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install gulp-proxy-inject-css
pnpm add gulp-proxy-inject-css
yarn add gulp-proxy-inject-css
bun add gulp-proxy-inject-css
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.3 |
| Published | 2019-03-03 |
| First published | 2019-03-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 9 KB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | 3lo1i |
| Maintainers | 3lo1i |

## Links

- npm: https://www.npmjs.com/package/gulp-proxy-inject-css
- Repository: https://github.com/3lo1i/gulp-proxy-inject-css
- Homepage: https://github.com/3lo1i/gulp-proxy-inject-css#readme
- Issues: https://github.com/3lo1i/gulp-proxy-inject-css/issues
- npm.io page: https://npm.io/package/gulp-proxy-inject-css

## Dependencies (5)

- [ws](https://npm.io/package/ws.md) ^6.1.4
- [opn](https://npm.io/package/opn.md) ^5.4.0
- [express](https://npm.io/package/express.md) ^4.16.4
- [through2-spy](https://npm.io/package/through2-spy.md) ^2.0.0
- [http-proxy-middleware](https://npm.io/package/http-proxy-middleware.md) ^0.19.1

## Recent versions

- 0.1.3 (latest) — 2019-03-03
- 0.1.2 — 2019-03-03
- 0.1.1 — 2019-03-03
- 0.1.0 — 2019-03-03

## README

gulp-proxy-inject-css
==============

Gulp plugin that allows to open any website on localhost and inject your custom CSS that will be applied to page on each save without page reload, much like live reload, but without having to have site hosted locally. This is most useful for developing UserCSS for third-party sites.

**This plugin is a quick and dirty solution to a very specific problem, there are a lot of plugins that do much more and much better. Unless you are developing UserCSS for third-party website, this might be not a plugin you are looking for.**

## Installation

`$ npm install --save-dev gulp-proxy-inject-css`

## Usage

cssInject() creates proxy server at http://localhost:8080 and returns function that creates file stream for pipeline that notifies script in browser via websocket on each change of CSS file.

```js
import gulp from 'gulp';
import cssInject from 'gulp-proxy-inject-css';
import sass from 'gulp-sass';
import sourcemaps from 'gulp-sourcemaps';

const inject = cssInject('habr.com');

export const styles = () => {
  return gulp.src('sass/**/*.scss', {since: gulp.lastRun(styles)})
    .pipe(sourcemaps.init())
    .pipe(sass().on('error', sass.logError))
    .pipe(sourcemaps.write('./'))
    .pipe(gulp.dest('dist'))
    .pipe(inject());
};


export const watch = () => {
  return gulp.watch('sass/**/*.scss', { ignoreInitial: false }, styles);
};
```

## Options

Default proxy server listens at http://localhost:8080/ and websocket at ws://localhost:8081/reload

Key | Type | Default | Description
--- | --- | --- | ---
`target` | String | | Target website to proxy, i.e. `github.com`
`options` | Object | | Plugin options
`options.port` | Number | `8080` | Proxy server port
`options.host` | String | `localhost` | Proxy server host
`https` | Boolean | `true` | Whether or not target site uses HTTPS
`wsPort` | String | `8081` | Websocket server port
`wsHost` | String | `localhost` | Websocket server host
`wsPath` | String | `/reload` | Websocket server path
`open` | Boolean | `true` | Whether or not to open proxy in browser automatically
`proxyOpts` | Object | `{}` | Additional options to pass to [http-proxy-middleware](https://www.npmjs.com/package/http-proxy-middleware), if needed

## License

[MIT](https://github.com/3lo1i/gulp-proxy-inject-css/blob/master/LICENSE)

---
_Source: https://npm.io/package/gulp-proxy-inject-css · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._