jscrambler - npm Package Compare versions

Comparing version 0.2.0 to 0.3.0

jscrambler-client.js

@@ -182,2 +182,2 @@ 'use strict';
 
-exports = module.exports = JScramblerClient;
+exports = module.exports = JScramblerClient;

jscrambler.js

@@ -96,2 +96,2 @@ 'use strict';
   }
-};
+};

package.json

 {
   "name": "jscrambler",
   "description": "JScrambler API client.",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "homepage": "https://github.com/auditmark/node-jscrambler",
@@ -29,5 +29,8 @@ "author": {
     "lodash": "^2.4.1",
-    "needle": "^0.6.6"
+    "needle": "^0.6.6",
+    "commander": "^2.1.0",
+    "fs-extra": "^0.8.1"
   },
-  "main": "jscrambler"
+  "main": "jscrambler",
+  "bin": "bin/jscrambler"
 }

README.md

 # JSCrambler Client for Node.js
 
-## Upload/download example
+## CLI
+```shell
+npm install -g jscrambler
+```
+    Usage: jscrambler [source files] [options]
+
+    Options:
+
+      -h, --help                    output usage information
+      -V, --version                 output the version number
+      -c, --config [config]         JScrambler configuration options
+      -o, --output <output>         Output directory
+      -a, --access-key <accessKey>  Access key
+      -s, --secret-key <secretKey>  Secret key
+
+## API
+```shell
+npm install jscrambler
+```
+### Upload/download example
 ```js
@@ -34,2 +53,152 @@ var fs = require('fs-extra');
   });
-  ```
+```
+
+## JScrambler Options
+
+The following options are passed to the JScrambler services through the CLI config file or some API methods. More information about them can be found [here](https://jscrambler.com/en/help/webapi/documentation).
+
+### asserts_elimination
+Type: `String`
+
+`name1;name2;...` - assert function names
+
+Remove function definitions and function calls with a given name.
+
+### constant_folding
+Type: `String`
+
+`%DEFAULT%` - enable constant folding
+
+Simplifies constant expressions at compile-time to make your code faster at run-time.
+
+### dead_code
+Type: `String`
+
+`%DEFAULT%` - enable dead code
+
+Randomly injects dead code into the source code.
+
+### dead_code_elimination
+Type: `String`
+
+`%DEFAULT%` - enable dead code elimination
+
+Removes dead code and void code from your JavaScript.
+
+### debugging_code_elimination
+Type: `String`
+
+`name1;name2;...` - debugging code names
+
+Removes statements and public variable declarations used to control the output of debugging messages that help you debug your code.
+
+### dictionary_compression
+Type: `String`
+
+`%DEFAULT%` - enable dictionary compression
+
+Dictionary compression to shrink even more your source code.
+
+### domain_lock
+Type: `String`
+
+`domain1;domain2;...` - your domains
+
+Locks your project to a list of domains you specify.
+
+### dot_notation_elimination
+Type: `String`
+
+`%DEFAULT%` - enable dot notation elimination
+
+Transforms dot notation to subscript notation.
+
+### exceptions_list
+Type: `String`
+
+`name;name1;name2;...` - list of exceptions that will never be replaced or used to create new declarations
+
+There are some names that should never be replaced or reused to create new declarations e.g. document, toUpperCase. Public declarations existing in more than one source file should not be replaced if you submit only a part of the project where they appear. Therefore a list of irreplaceable names and the logic to make distinction between public and local names already exists on JScrambler to avoid touching those names. Use this parameter to add your own exceptions.
+
+### expiration_date:
+Type: `String`
+
+`date` - date format YYYY/MM/DD
+
+Sets your JavaScript to expire after a date of your choosing.
+
+### function_outlining
+Type: `String`
+
+`%DEFAULT%` - enable function outlining
+
+Turns statements into new function declarations.
+
+### function_reorder
+Type: `String`
+
+`%DEFAULT%` - enable function reordering
+
+Randomly reorders your source code's function declarations.
+
+### ignore_files
+Type: `String`
+
+`filename;filename1` - List of files (relative paths) to be ignored
+
+Define a list of files (relative paths) that JScrambler must ignore.
+
+### literal_hooking
+Type: `String`
+
+`min;max[;percentage]` - min and max predicates in ternary operator and percentage chance of replacement
+
+Replaces literals by a randomly sized chain of ternary operators. You may configure the minimum and maximum number of predicates per literal, as the occurrence probability of the transformation. This allows you to control how big the obfuscated JavaScript grows and the potency of the transformation.
+
+### literal_duplicates
+Type: `String`
+
+`%DEFAULT%` - enable literal duplicates
+
+Replaces literal duplicates by a symbol.
+
+### member_enumeration
+Type: `String`
+
+`%DEFAULT%` - enable member enumeration
+
+Replaces Browser and HTML DOM objects by a member enumeration.
+
+### mode
+Type: `String`
+
+`starter` - Standard protection and optimization behavior. Enough for most JavaScript applications
+`mobile` - Transformations are applied having into account the limitations and needs of mobile devices
+`html5` - Protects your HTML5 and Web Gaming applications by targeting the new HTML5 features
+
+### name_prefix
+Type: `String`
+
+Set a prefix to be appended to the new names generated by JScrambler.
+
+### rename_local
+Type: `String`
+
+`%DEFAULT%` - enable rename local
+
+Renames local names only. The best way to replace names without worrying about name dependencies.
+
+### string_splitting:
+Type: `String`
+
+`occurrences[;concatenation]`
+
+occurrences - Percentage of occurrences. Accepted values between 0.01 and 1.
+concatenation - Percentage of concatenation occurrences. Accepted values between 0 and 1 (0 means chunks of a single character and 1 the whole string).
+
+### whitespace
+Type: `String`
+
+`%DEFAULT%` - enable whitespace
+
+Shrink the size of your JavaScript removing unnecessary whitespaces and newlines from the source code.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

17199

increased by60.51%

Number of package files

7

increased by40%

Lines of code

289

increased by5.09%

Number of lines in readme file

204

increased by500%

Worsened metrics

Dependency count

5

increased by66.67%

Dependency changes

• + Addedcommander@^2.1.0

• + Addedfs-extra@^0.8.1

• + Addedcommander@2.20.3(transitive)

• + Addedfs-extra@0.8.1(transitive)

• + Addedjsonfile@1.1.1(transitive)

• + Addedmkdirp@0.3.5(transitive)

• + Addedncp@0.4.2(transitive)

• + Addedrimraf@2.2.8(transitive)