https://github.com/zoubin/gulp-expose

Expose a node module in browser, no dependencies handled
https://github.com/zoubin/gulp-expose

Last synced: 8 days ago
JSON representation

Expose a node module in browser, no dependencies handled

• Host: GitHub
• URL: https://github.com/zoubin/gulp-expose
• Owner: zoubin
• Created: 2015-04-15T09:11:07.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2018-08-29T05:44:41.000Z (about 6 years ago)
• Last Synced: 2024-10-29T09:06:01.259Z (21 days ago)
• Language: JavaScript
• Size: 8.79 KB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# gulp-expose

Expose module.exports to a global object, like `window` in the browser envrionment.

## install

```

npm install --save-dev gulp-expose

```

## usage

number.js:

```

module.exports = 1;

```

```javascript

var expose = require('gulp-expose');

gulp.src('number.js')

    .pipe(expose('window', 'One'))

    .pipe(gulp.dest('dist'));

// window.One == 1

```

OR

```javascript

var expose = require('gulp-expose');

gulp.src('number.js')

    .pipe(expose('window.MyFavNumber', 'One'))

    .pipe(gulp.dest('dist'));

// window.MyFavNumber.One == 1

// as long as the namespace `window.MyFavNumber` is available.

```

And json can be exposed, too:

config.json:

```js

{

    "name": "gulp-expose"

}

```

```js

var expose = require('gulp-expose');

var gulp = require('gulp-rename');

gulp.src('test/src/config.json')

    .pipe(expose('window', 'PKG'))

    .pipe(rename('config.js'))

    .pipe(gulp.dest('test/dist'))

// window.PKG = { name: 'gulp-expose' }

```

### expose(host, expose)

* host. String. The object that will have the exposed api. It can be any valid expression that can be evaluated as an object.

* expose. String. The property name that will be added to `host`, with the exposed api.

If `host` is a function, it receives a [vinyl](https://github.com/wearefractal/vinyl) `file` object, and should return the expose info object `{ host: host, expose: expose }`.

## example

### build

```javascript

var gulp = require('gulp');

var expose = require('gulp-expose');

gulp.src('number.js')

    .pipe(expose('window', 'One'))

    .pipe(gulp.dest('dist'));

```

### dist/number.js

```javascript

(function (host, expose) {

   var module = { exports: {} };

   var exports = module.exports;

   /****** code begin *********/

module.exports = 1;

   /****** code end *********/

   ;(

function copy(src, target, obj) {

    obj[target] = obj[target] || {};

    if (src && typeof src === 'object') {

        for (var k in src) {

            if (src.hasOwnProperty(k)) {

                obj[target][k] = src[k];

            }

        }

    } else {

        obj[target] = src;

    }

}

   ).call(null, module.exports, expose, host);

}).call(window, window, "One");

```

Now in browser:

```

window.One === 1; // true

```