Rollup Plugin for JavaScript Obfuscator

Common errors

• Error: Cannot find module 'javascript-obfuscator'

  cause The `javascript-obfuscator` package, a peer dependency, has not been installed.
  fix Install `javascript-obfuscator` alongside the plugin: `npm install --save-dev javascript-obfuscator`.

• TypeError: Cannot read properties of undefined (reading 'transform')

  cause Often indicates an issue where the plugin factory didn't return a valid plugin object or `javascript-obfuscator` wasn't correctly loaded.
  fix Ensure `javascript-obfuscator` is installed and the plugin configuration is syntactically correct, particularly the `options` object. Check your Rollup configuration for correct plugin array syntax.

• Rollup 'transform' hook (plugin rollup-plugin-obfuscator) failed with error: Error: Options must be an object!

  cause The `options` property passed to `rollup-plugin-obfuscator` is not a plain JavaScript object or is missing.
  fix Verify that the `options` property within the plugin configuration is a valid object, e.g., `obfuscator({ options: { /* ... */ } })`.

Warnings

• gotcha This plugin requires `javascript-obfuscator` to be installed separately as a peer dependency. Forgetting to install it will lead to runtime errors.
  Fix: Run `npm install --save-dev rollup-plugin-obfuscator javascript-obfuscator` or `yarn add --dev rollup-plugin-obfuscator javascript-obfuscator`.
• gotcha When `global` option is `false` (default), obfuscation is applied per-file. This means `include` and `exclude` options determine which individual files are processed. Ensure these patterns correctly target your source code and avoid external dependencies.
  Fix: Review your `include` and `exclude` arrays, especially if you observe unexpected obfuscation or non-obfuscation. The default `exclude: ['node_modules/**']` is usually sufficient, but might need adjustment for monorepos or specific build setups.
• gotcha Overly aggressive `javascript-obfuscator` settings can break your application, especially with complex frameworks or dynamic code evaluations. Test thoroughly after applying obfuscation.
  Fix: Start with milder obfuscation options and incrementally increase complexity. Rigorously test your application's functionality in a production-like environment after obfuscation. Consult the `javascript-obfuscator` documentation for details on each option.

Install

• npm install rollup-plugin-obfuscator npm
• yarn add rollup-plugin-obfuscator yarn
• pnpm add rollup-plugin-obfuscator pnpm

Imports

• obfuscator
  wrong:

  import { obfuscator } from 'rollup-plugin-obfuscator';
  const obfuscator = require('rollup-plugin-obfuscator');

  correct:

  import obfuscator from 'rollup-plugin-obfuscator';

  The plugin is exported as a default export. For CommonJS, `require('rollup-plugin-obfuscator').default` is correct but less common in modern Rollup configs.
• RollupOptions

  import type { RollupOptions } from 'rollup';

  While not directly from this plugin, users often need Rollup types when configuring plugins in TypeScript.
• ObfuscatorOptions

  import type { ObfuscatorOptions } from 'javascript-obfuscator';

  For precise typing of the `options` property, import types directly from `javascript-obfuscator`, as this plugin passes them through.

Quickstart

This quickstart demonstrates how to apply obfuscation to a Rollup bundle using the `rollup-plugin-obfuscator`. It shows the basic plugin setup and includes common `javascript-obfuscator` options for a strong obfuscation.

import obfuscator from 'rollup-plugin-obfuscator';

export default {
	input: 'src/main.js',
	output: {
		dir: 'dist',
		format: 'esm'
	},
	plugins: [
		obfuscator({
			// Obfuscate the entire bundle (default is file-by-file)
			// global: true,
			options: {
				// Your javascript-obfuscator options here
				// See what's allowed: https://github.com/javascript-obfuscator/javascript-obfuscator
				compact: true,
				controlFlowFlattening: true,
				deadCodeInjection: true,
				identifierNamesGenerator: 'hexadecimal',
				selfDefending: true,
				sideEffects: true,
				splitStrings: true,
				stringArray: true,
				stringArrayThreshold: 0.75
			}
		}),
	]
}