AutoObfuscator

All suggested changes within this README.md address the index.js file.

This respository contians Node.js code which'll allow for automatic on-save Obfuscation for external JS files [1] and Uglification for external CSS files [2]. A watch is applied [3], so that, when the user saves a file ending with *-preugly.js or *-preugly.css (or whatever suffix user changes it to in the code, by changing const suffix), an obfuscated/uglified copy is created in the same directory without the -preugly suffix. The user can change the code to save to a different directory if they wish, by programmatcially manipulating const outputFile.

First of all, the user should have Node.js installed on their device. After cloning this repository, they should run the following command to download all the required packages.

npm install

The watcher is, by default, set to watch for changes in all files (or technically files within 99 nested layers) within the path/to/server/directory directory. The user should change this to their server directory if they wish for this default behaviour.

If the user wants to change this default behaviour to, for example, watch for changes to particular files or directories within their server, they should consult [3] and change the following lines of code accordingly:

// Watch all JS and CSS files on the server
const serverDirectory = 'path/to/server/directory'; // Update this with your server directory
const watcher = chokidar.watch(serverDirectory, {
    ignored: /(^|[\/\\])\../, // ignore dotfiles
    persistent: true,
    depth: 99 // Set depth to watch nested directories
});

The default settings for the javascript obfuscation is shown below. If the user wishes to change this for their own use, they should consult [1]; then find and change the following block of code accordingly [1].

const result = JavaScriptObfuscator.obfuscate(code, {
    compact: true,
    controlFlowFlattening: true,
    controlFlowFlatteningThreshold: 0.75,
    deadCodeInjection: true,
    deadCodeInjectionThreshold: 0.4,
    debugProtection: false,
    debugProtectionInterval: 0,
    disableConsoleOutput: true,
    identifierNamesGenerator: 'hexadecimal',
    log: false,
    renameGlobals: false,
    rotateStringArray: true,
    selfDefending: true,
    stringArray: true,
    stringArrayEncoding: [],
    stringArrayThreshold: 0.75,
    unicodeEscapeSequence: false
});

Once the user is happy with their setup, they can start the watching by running the following in the command line. Then all saves are obfuscated as long as the watching is active.

node index.js

[1] javascript-obfuscator: https://github.com/javascript-obfuscator/javascript-obfuscator

[2] uglifycss: https://github.com/fmarcia/uglifycss

[3] chokidar: https://github.com/paulmillr/chokidar