# @firma-de/gulp-package

> Gulp module for packaging a NodeJS project for deployment

Latest version **0.0.1** (published 2016-04-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install @firma-de/gulp-package
pnpm add @firma-de/gulp-package
yarn add @firma-de/gulp-package
bun add @firma-de/gulp-package
```

## 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.0.1 |
| Published | 2016-04-05 |
| First published | 2016-04-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4.2.0 |
| Dependencies | 10 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | firma.de |
| Maintainers | firma-de |

## Links

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

## Dependencies (10)

- [gulp](https://npm.io/package/gulp.md) ^3.9.0
- [gulp-tar](https://npm.io/package/gulp-tar.md) ^1.8.0
- [through2](https://npm.io/package/through2.md) ^2.0.0
- [gulp-file](https://npm.io/package/gulp-file.md) ^0.2.0
- [gulp-gzip](https://npm.io/package/gulp-gzip.md) ^1.2.0
- [gulp-util](https://npm.io/package/gulp-util.md) ^3.0.7
- [deep-extend](https://npm.io/package/deep-extend.md) ^0.4.1
- [js-beautify](https://npm.io/package/js-beautify.md) ^1.5.10
- [detect-indent](https://npm.io/package/detect-indent.md) ^4.0.0
- [stream-combiner](https://npm.io/package/stream-combiner.md) ^0.2.2

## Recent versions

- 0.0.1 (latest) — 2016-04-05

## README

# Gulp Package

[![npm version](https://img.shields.io/npm/v/@firma-de/gulp-package.svg)](https://www.npmjs.com/package/@firma-de/gulp-package)
[![build status](https://img.shields.io/circleci/project/firma-de/gulp-package/master.svg)](https://circleci.com/gh/firma-de/gulp-package)
[![dependencies](https://img.shields.io/david/firma-de/gulp-package.svg)](https://david-dm.org/firma-de/gulp-package)
[![coverage](https://img.shields.io/coveralls/firma-de/gulp-package/master.svg)](https://coveralls.io/github/firma-de/gulp-package)

Gulp module for packaging a NodeJS project for deployment

## Description

Will generate a `tar.gz` package of the project with included 
`package.json`. It adds to the `package.json` a `build` property that 
will be the `revision` option if provided.

This gulp plugin is opinionated and is used across our projects.

## Installation

```
$ npm install @firma-de/gulp-package
```

## Usage

Basic usage :

```
const pack = require("@firma-de/gulp-package");

return gulp
    .src( [
        "./.build/**/*",
        "./config/**"
    ], { base : "./.build" } )
    .pipe( pack( {
        revision : `${your_git_revision}`,
        branch : `${your_git_branch}`
    } ) )
    .pipe( gulp.dest( "./package" ) )
```

With this configuration options it will create a `tar.gz` file that has
as a root `./build` folder and inside it will copy `./config` and the
`package.json` of the project.

It will add to the package.json `revision` property from the 
configuration and it will name the file `pkgName-gitBranch-gitRev.tar.gz` 

## Options

### `revision`

The revision number that will be included in `package.json` and in the
name of the final file.

Usually this can be env variable from your build, e.g. :

```
{ revision: process.env["CIRCLE_SHA1"] }
```

Value : `String`
  
Default Value : `snapshot`  

### `branch`

Branch of the package. It's used for the name of the package file.

Usually this can be env variable from your build, e.g. :

```
{ branch: process.env["CIRCLE_BRANCH"] }
```

Value : `String`
  
Default Value : `branchless`

## License

MIT

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