https://github.com/z0ffy/vite-plugin-bundle-obfuscator

Javascript obfuscator plugin for Vite environments
https://github.com/z0ffy/vite-plugin-bundle-obfuscator

Last synced: 21 days ago
JSON representation

Javascript obfuscator plugin for Vite environments

• Host: GitHub
• URL: https://github.com/z0ffy/vite-plugin-bundle-obfuscator
• Owner: z0ffy
• License: mit
• Created: 2024-07-23T03:55:58.000Z (about 2 months ago)
• Default Branch: main
• Last Pushed: 2024-08-23T06:22:05.000Z (25 days ago)
• Last Synced: 2024-08-24T03:23:43.356Z (24 days ago)
• Language: TypeScript
• Homepage:
• Size: 56.6 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• trackawesomelist - vite-plugin-bundle-obfuscator (⭐3) - JavaScript obfuscator. (Recently Updated / [Aug 26, 2024](/content/2024/08/26/README.md))
• fucking-awesome-vite - vite-plugin-bundle-obfuscator - JavaScript obfuscator. (Plugins / Framework-agnostic Plugins)
• awesome-vite - vite-plugin-bundle-obfuscator - JavaScript obfuscator. (Plugins / Framework-agnostic Plugins)

README

        
# vite-plugin-bundle-obfuscator

![stars](https://img.shields.io/github/stars/z0ffy/vite-plugin-bundle-obfuscator)

[![awesome-vite](https://awesome.re/badge.svg)](https://github.com/vitejs/awesome-vite)

![weekly downloads](https://img.shields.io/npm/dw/vite-plugin-bundle-obfuscator)

![license](https://img.shields.io/npm/l/vite-plugin-bundle-obfuscator)

[![install size](https://packagephobia.com/badge?p=vite-plugin-bundle-obfuscator)](https://packagephobia.com/result?p=vite-plugin-bundle-obfuscator)

Javascript obfuscator plugin for Vite environments

## ⭐️ Feature

- [ ] support the stringArray options

- [ ] support the node_modules split chunk

## 👨‍💻 Usage

1. Run npm install vite-plugin-bundle-obfuscator -D

2. Register the plugin in `vite.config.js`

3. Set your own configuration or set empty to use default options

```shell

npm install vite-plugin-bundle-obfuscator -D

```

```javascript

import vitePluginBundleObfuscator from 'vite-plugin-bundle-obfuscator';

const obfuscatorConfig = {

  enable: true,

  excludes: [],

  options: {}

};

export default {

  plugins: [vitePluginBundleObfuscator(obfuscatorConfig)]

};

```

## 💪 Config

| Property Name | Description                           | Type              | Default        | version |

|---------------|---------------------------------------|-------------------|----------------|---------|

| log           | show or hide log                      | Boolean           | true           | v1.0.4  |

| enable        | enable or disable obfuscator          | Boolean           | true           | v1.0.1  |

| excludes      | bundle names that need to be excluded | string[]          | []             | v1.0.0  |

| options       | javascript obfuscator options         | ObfuscatorOptions | Config example | v1.0.0  |

## 💪 Config example

```javascript

const obfuscatorConfig = {

  // You can temporarily package the dependency of node_modules into a bundle named vendor-modules or other names, and configure it as a filter item.

  excludes: ['vendor-modules'],

  enable: true,

  log: true,

  options: {

    compact: true,

    controlFlowFlattening: true,

    controlFlowFlatteningThreshold: 1,

    deadCodeInjection: false,

    debugProtection: false,

    debugProtectionInterval: 0,

    disableConsoleOutput: false,

    identifierNamesGenerator: 'hexadecimal',

    log: false,

    numbersToExpressions: false,

    renameGlobals: false,

    selfDefending: true,

    simplify: true,

    splitStrings: false,

    // stringArray must be false, if you set true.your style sheet will be missing some。

    stringArray: false,

    stringArrayCallsTransform: false,

    stringArrayCallsTransformThreshold: 0.5,

    stringArrayEncoding: [],

    stringArrayIndexShift: true,

    stringArrayRotate: true,

    stringArrayShuffle: true,

    stringArrayWrappersCount: 1,

    stringArrayWrappersChainedCalls: true,

    stringArrayWrappersParametersMaxCount: 2,

    stringArrayWrappersType: 'variable',

    stringArrayThreshold: 0.75,

    unicodeEscapeSequence: false,

  }

};

```