gulp-jscrambler

gulp-jscrambler

Add obfuscation to your build process with gulp and gulp-jscrambler.

How to Use

Version Compatibility

---

The version's compatibility table match your Jscrambler Version with the Jscrambler Gulp Client. Please make sure you install the right version, otherwise some functionalities might not work properly.

Jscrambler Version	Client and Integrations
<= 7.1	<= 5.x.x
>= 7.2	>= 6.0.0

Install

Install with npm.

npm install -D gulp-jscrambler

Option -D will make sure it is installed as a devDependency.

Setup your Jscrambler Gulp task

In order to start using gulp-jscrambler you will need to add a new task to your project gulpfile.js. This task will be responsible for protecting your application with Jscrambler.

Here's an example of how Jscrambler task should look like:

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

function enable(filesSrc) {
  if (filesSrc.length === 0) {
    return false;
  }

  return true;
}

gulp.task('default', function (done) {
  gulp
    .src('app/**/*.js')
    .pipe(jscrambler({
      keys: {
        accessKey: 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX',
        secretKey: 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
      },
      applicationId: 'XXXXXXXXXXXX',
      enable,
      params: [
        {
          name: 'whitespaceRemoval'
        },
        {
          name: 'stringSplitting'
        }
      ]
    }))
    .pipe(gulp.dest('dist/'))
    .on('end', done);
});

You will need your credentials and Application ID in order to protect your application. Navigate to your Settings page and grab your accessKey and secretKey at the API Credentials section.

Your applicationId can be found inside your application page just below your application name. Click the copy to clipboard icon to copy the applicationId.

You can also grab your current configuration on your application page. This will download a .json file containing a valid configuration with your currently selected options.

Keep in mind that the params object is optional and if it is not provided we will use your previous configuration.

The enable object is an optional function (returns true by default) that will allow to manipulate the files sources and decide if you want to protect them (returning true) or skip (returning false). The example provided before is a use case that will skip the Jscrambler protection when there isn't any files on source.

Usage Example

You can find some working examples here.