# gulp-bom

> Add a UTF-8 BOM to files

Latest version **5.0.0** (published 2023-10-31) · MIT license · 0 weekly downloads

## Install

```sh
npm install gulp-bom
pnpm add gulp-bom
yarn add gulp-bom
bun add gulp-bom
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 5.0.0 |
| Published | 2023-10-31 |
| First published | 2015-06-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM |
| Node | >=18 |
| Dependencies | 1 |
| Unpacked size | 2.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 11 |
| Author | Sindre Sorhus |
| Maintainers | sindresorhus |
| Keywords | gulpplugin, bom, byte, order, mark, utf8, utf-8, add, prepend |

## Links

- npm: https://www.npmjs.com/package/gulp-bom
- Repository: https://github.com/sindresorhus/gulp-bom
- Homepage: https://github.com/sindresorhus/gulp-bom#readme
- Issues: https://github.com/sindresorhus/gulp-bom/issues
- Funding: https://github.com/sponsors/sindresorhus
- npm.io page: https://npm.io/package/gulp-bom

## Dependencies (1)

- [gulp-plugin-extras](https://npm.io/package/gulp-plugin-extras.md) ^0.1.0

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 5.0.0 (latest) — 2023-10-31
- 4.0.0 — 2022-06-06
- 3.0.0 — 2019-10-04
- 2.0.0 — 2017-12-30
- 1.0.0 — 2015-06-30

## README

# gulp-bom

> Add a [UTF-8 BOM](https://en.wikipedia.org/wiki/Byte_order_mark#UTF-8) to files

From Wikipedia:

> The Unicode Standard permits the BOM in UTF-8, but does not require nor recommend its use. Byte order has no meaning in UTF-8.

Gulp strips the BOM as it's useless. This is for the few dumb tools that do require it. Don't use this unless you really need to.

## Install

```sh
npm install --save-dev gulp-bom
```

## Usage

```js
import gulp from 'gulp';
import bom from 'gulp-bom';

export default () => (
	gulp.src('app.js')
		.pipe(bom())
		.pipe(gulp.dest('dist'))
);
```

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