gulp-nar

Create and extract nar archives

Usage no npm install needed!

<script type="module">
  import gulpNar from 'https://cdn.skypack.dev/gulp-nar';
</script>

README

gulp-nar Build Status Dependency Status NPM version

Create and extract nar archives from Gulp

Installation

Install nar as global package

$ npm install -g nar

Install the task

$ npm install gulp-nar --save-dev

Usage

var gulp = require('gulp')
var nar = require('gulp-nar')

gulp.task('create', function () {
  gulp.src('package.json')
    .pipe(nar.create('releases/'))
})

gulp.task('create-executable', function () {
  gulp.src('package.json')
    .pipe(nar.createExecutable('releases/'))
})

gulp.task('extract', function () {
  gulp.src('app.nar')
    .pipe(nar.extract('app/'))
})

See gulpfile.js for more examples

API

nar.create(path, options)

Creates an archive according to the package.json configuration

  • path string Destination directory for the nar archive. Default to current directory
  • options object Archive creation options

nar.createExecutable(path, options)

Creates an executable binary-like archive

  • path string Destination directory for the nar archive. Default to current directory
  • options object Executable creation options

nar.extract(path, options)

Extract archive content into a directory

  • path string Destination directory for the extracted files. Default to current directory
  • options object Archive extract options

License

MIT © Tomas Aparicio