# gulp-userscript

> Generate Userscript metadata with gulp.

Latest version **1.2.0** (published 2020-12-19) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.0 |
| Published | 2020-12-19 |
| First published | 2016-10-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 5.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | pd4d10 |
| Maintainers | pd4d10, nbsp1221 |
| Keywords | gulp, userscript |

## Links

- npm: https://www.npmjs.com/package/gulp-userscript
- Repository: https://github.com/pd4d10/gulp-userscript
- Homepage: https://github.com/pd4d10/gulp-userscript#readme
- Issues: https://github.com/pd4d10/gulp-userscript/issues
- npm.io page: https://npm.io/package/gulp-userscript

## Dependencies (3)

- [through2](https://npm.io/package/through2.md) ^4.0.2
- [plugin-error](https://npm.io/package/plugin-error.md) ^1.0.1
- [userscript-meta](https://npm.io/package/userscript-meta.md) ^1.0.0

## Recent versions

- 1.2.0 (latest) — 2020-12-19
- 1.1.0 — 2016-10-21
- 1.0.0 — 2016-10-18
- 0.0.1 — 2016-10-15

## README

# gulp-userscript

[![Build Status](https://travis-ci.org/pd4d10/gulp-userscript.svg?branch=master)](https://travis-ci.org/pd4d10/gulp-userscript)
[![codecov](https://codecov.io/gh/pd4d10/gulp-userscript/branch/master/graph/badge.svg)](https://codecov.io/gh/pd4d10/gulp-userscript)
[![npm](https://img.shields.io/npm/v/gulp-userscript.svg)](https://www.npmjs.com/package/gulp-userscript)
[![](https://img.shields.io/npm/l/gulp-userscript.svg)](https://www.npmjs.com/package/gulp-userscript)

Generate Userscript metadata.

## Usage

```js
const gulp = require('gulp')
const userscript = require('gulp-userscript')

gulp.task('userscript', function () {
  return gulp.src('/path/to/src.js')
    .pipe(userscript({
      name: 'Your Userscript name', // required
      namespace: 'namespace',
      version: '0.1',
      'run-at': 'document-end',
      // Use an array when the field has multiple values
      match: [
        'http://www.example.com/*',
        'https://www.example.com/*'
      ],
    }))
    .pipe(gulp.dest('/path/to/dest'))
})
```

will generate Userscript metadata like this:

```js
// ==UserScript==
// @name Your Userscript name
// @namespace namespace
// @version 0.1
// @run-at document-end
// @match http://www.example.com/*
// @match https://www.example.com/*
// ==/UserScript==

// ... /path/to/src.js content here
```

For more options, see https://wiki.greasespot.net/Metadata_Block

## License

MIT

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