Package Exports

codefend

Readme

Codefend

GitHub Workflow Status NPM Bundlephobia NPM NPM

Codefend is a versatile CLI tool designed to obfuscate not only your source code but also your folder and file names across any programming language or framework. In addition to its CLI functionality, Codefend is available as a plugin for Webpack, Rollup, and Vite.

Beyond basic obfuscation, Codefend offers advanced features. It seamlessly integrates with existing uglifiers or minifiers, providing a two-layer obfuscation process that creates a hidden code within another hidden code, ensuring irreversible protection of your source code.

To unleash Codefend's capabilities, it requires adherence to specific naming conventions within your project. Once set up, Codefend automates the obfuscation process, allowing you to focus on coding while it safeguards your intellectual property ✨

Visit the docs for instructions, examples, and advanced settings.

Installation

`Globally`

npm install -g codefend
codefend -i  //required only the first time, generates .codefendrc.json
codefend -o  //obfuscates your whole project inside a new directory: 'codefend-output'

`Dev dependency`

npm install -D codefend

`npx`

In case you want to execute it directly without installing it on your machine:

npx codefend -i  //required only the first time, generates .codefendrc.json
npx codefend -o  //obfuscates your whole project inside a new directory: 'codefend-output'

`Webpack`

If you're using Webpack, you can use webpack-plugin-codefend instead of directly using the CLI, keeping in mind that not all features are propagated to the plugin and may take time to become available.

`Rollup/Vite`

If you're using Rollup or Vite, you can use rollup-plugin-codefend instead of directly using the CLI, keeping in mind that not all features are propagated to the plugin and may take time to become available.

Commands

Usage: codefend [options]

Defend Your Code By All Means Necessary. 💪 😎

Options:
  -i, --init       Create the config file (.codefendrc.json)
  -o, --obfuscate  Obfuscate the project
  -c, --check      Check the config file for potential warnings/errors
  -v, --version    Output the version number
  -h, --help       Display help for command

Basic Usage

`Step 1`: Naming convention

Add prefixes to the words that you want to encrypt.

//as a starting point:  prefix the words that should be encrypted with l_
class l_Calculator {
  l_sum(l_a, l_b) {
    const l_results = l_a + l_b;
    return l_results;
  }
}

//>>>>>>==== Will Become ======<<<<<<

class Ox0 {
  Ox1(Ox2, Ox3) {
    const Ox4 = Ox2 + Ox3;
    return Ox4;
  }
}

// Or for a better organized naming convention:
/** 
 * 
1- class -> starts with c_
2- function -> starts with f_
3- parameter -> starts with p_
4- local variable -> starts with l_
*/
class c_Calculator {
  f_sum(p_a, p_b) {
    const l_results = p_a + p_b;
    return l_results;
  }
}

//>>>>>>==== Same results ======<<<<<<
class Ox0 {
  Ox1(Ox2, Ox3) {
    const Ox4 = Ox2 + Ox3;
    return Ox4;
  }
}

<!-- Html example, can work also with Angular,React,Vue,Svelte... in the same way -->

<html>
  <head>
    <style>
      .l_red {
        color: red;
      }
    </style>
  </head>
  <body>
    <div class="l_red">l_secret</div>
    <div class="l_red">Hello World</div>
  </body>
</html>

<!-- Will Become -->

<html>
  <head>
    <style>
      .Ox1 {
        color: red;
      }
    </style>
  </head>
  <body>
    <div class="Ox1">Ox0</div>
    <div class="Ox1">Hello World</div>
  </body>
</html>

`Step 2`: Run the CLI

navigate to the root of your project and run the following commands:

codefend -i  //required only the first time, generates .codefendrc.json

codefend -o  //obfuscates your whole project inside a new directory: 'codefend-output'

For a more detailed explanation, please refer to the obfuscation section of the docs.

`Step 3`: install dependencies, build and deploy the obfuscated project

Please refer to the build and deployment and troubleshooting sections of the docs.

Configuration

Please refer to the configuration section of the docs.

Migration guide

Please refer to the migration guide section of the docs.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT

codefend