https://github.com/javascript-obfuscator/gulp-javascript-obfuscator
Gulp plugin for javascript-obfuscator package.
https://github.com/javascript-obfuscator/gulp-javascript-obfuscator
Last synced: 3 months ago
JSON representation
Gulp plugin for javascript-obfuscator package.
- Host: GitHub
- URL: https://github.com/javascript-obfuscator/gulp-javascript-obfuscator
- Owner: javascript-obfuscator
- Created: 2016-10-26T13:01:05.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2023-06-05T11:30:08.000Z (over 2 years ago)
- Last Synced: 2025-03-29T04:04:19.617Z (8 months ago)
- Language: JavaScript
- Size: 19.5 KB
- Stars: 103
- Watchers: 6
- Forks: 37
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# gulp-javascript-obfuscator
Gulp plugin for [javascript-obfuscator](https://github.com/javascript-obfuscator/javascript-obfuscator)
## Installation
Install the package with npm:
```bash
$ npm install --save gulp-javascript-obfuscator
```
## Usage
```javascript
const gulp = require('gulp');
const javascriptObfuscator = require('gulp-javascript-obfuscator');
gulp.src('file.js')
.pipe(javascriptObfuscator())
.pipe(gulp.dest('dist'));
```
## Options
[Pass any options available in the obfuscator](https://github.com/javascript-obfuscator/javascript-obfuscator#javascript-obfuscator-options)
```javascript
gulp.src('file.js')
.pipe(javascriptObfuscator({
compact: true
}))
.pipe(gulp.dest('dist'));
```
The only exception is obfuscator's `sourceMap` option which must not be set, as it will be handled automatically when using `gulp-sourcemaps`.
## Source Maps
With version `1.1.6` onwards, gulp-javascript-obfuscator can be used in tandem with [gulp-sourcemaps](https://github.com/floridoo/gulp-sourcemaps) in order to generate source maps for your javascript files.
You will need to initialize gulp-sourcemaps prior to running gulp-javascript-obfuscator and write the source maps after, as such:
```javascript
const sourcemaps = require('gulp-sourcemaps');
gulp.src('file.js')
.pipe(sourcemaps.init())
.pipe(javascriptObfuscator({
compact: true
}))
.pipe(sourcemaps.write())
.pipe(gulp.dest('dist'));
```
This will output a `file.js.map` file to the **dist** directory.
You can chain other gulp plugins as well:
```javascript
const sourcemaps = require('gulp-sourcemaps');
gulp.src('file.js')
.pipe(sourcemaps.init())
// use babel to pre-process javascript files
.pipe(babel({
presets: ['@babel/preset-env']
}))
.pipe(javascriptObfuscator({
compact: true
}))
.pipe(sourcemaps.write())
.pipe(gulp.dest('dist'));
```
### Alternative source maps method
For backwards compatibility, if `gulp-sourcemaps` is not used and obfuscator's **sourceMap** option is set to **true**, a _.map_ file will be thrown to Gulp stream. ([This method is _deprecated_ and not recommended for future use.](https://github.com/javascript-obfuscator/gulp-javascript-obfuscator/pull/18#backwards-compatibility))