Home

Awesome

gulp-unassert

A gulp plugin for unassert.

unassert

Build Status NPM version Code Style License

Description

gulp-unassert is a gulp plugin for unassert: Encourages programming with assertions by providing tools to compile them away.

Related modules

Install

npm install --save-dev gulp-unassert

Usage

gulp 3.x

const unassert = require('gulp-unassert');

gulp.task('build', () => {
  gulp.src('./src/*.js')
    .pipe(unassert())
    .pipe(gulp.dest('./dist'));
});

gulp 4.x

const { src, dest } = require('gulp');
const unassert = require('gulp-unassert');

function build() {
  return src('./src/*.js')
    .pipe(unassert())
    .pipe(dest('./dist'));
}
exports.build = build;

custom unassert options

const { src, dest } = require('gulp');
const unassert = require('gulp-unassert');

function build() {
  return src('./src/*.js')
    .pipe(unassert({
      modules: [
        'assert',
        'assert/strict',
        'node:assert',
        'node:assert/strict',
        'invariant',
        'uvu/assert'
      ]
    }))
    .pipe(dest('./dist'));
}
exports.build = build;

Source maps

gulp 3.x

gulp-unassert can be used with gulp-sourcemaps to generate source maps for the transformed javascript code. Note that you should init gulp-sourcemaps prior to running the gulp-unassert and write the source maps after. gulp-unassert works well with some gulp plugins that supports gulp-sourcemaps.

const unassert = require('gulp-unassert');
const coffee = require('gulp-coffee');
const concat = require('gulp-concat');
const sourcemaps = require('gulp-sourcemaps');

gulp.task('build', () => {
  // compile, instrument then concatinate
  gulp.src('./src/**/*.coffee')
    .pipe(sourcemaps.init())
    .pipe(coffee({bare: true}))
    .pipe(unassert())
    .pipe(concat('bundle.js'))
    .pipe(sourcemaps.write())
    .pipe(gulp.dest('./build'));
  // will write the source maps inline in the code
});

For more information, see gulp-sourcemaps.

gulp 4.x

In gulp 4, sourcemaps are built-in by default.

const { src, dest } = require('gulp');
const unassert = require('gulp-unassert');
const coffee = require('gulp-coffee');
const concat = require('gulp-concat');

function build() {
  return src('./src/*.coffee', { sourcemaps: true })
    .pipe(coffee({ bare: true }))
    .pipe(unassert())
    .pipe(concat('bundle.js'))
    .pipe(dest('./build'));
}
exports.build = build;

Changelog

See CHANGELOG

Author

Our Support Policy

We support Node under maintenance. In other words, we stop supporting old Node version when their maintenance ends.

This means that any other environment is not supported.

NOTE: If gulp-unassert works in any of the unsupported environments, it is purely coincidental and has no bearing on future compatibility. Use at your own risk.

License

Licensed under the MIT license.