Add CLI Support (#8)

* Add simple CLI support

* Update eslint

* 1.1.5

Author: BenBaryoPX

README.md

@@ -8,6 +8,7 @@ Detect different types of JS obfuscation by their AST structure.
 `npm install obfuscation-detector`
 
 ## Usage
+### Module
 ```javascript
 const fs = require('fs');
 const detectObfuscation = require('obfuscation-detector');
@@ -18,6 +19,19 @@ const most_likely_obfuscation_type = detectObfuscation(code);
 console.log(`Obfuscation type is probably ${most_likely_obfuscation_type}`);
 ```
 
+### CLI
+> obfuscation-detector /path/to/obfuscated.js [stopAfterFirst]
+
+Getting all matching obfuscation types for a file:
+> $ obfuscation-detector /path/to/obfuscated.js
+> [+] function_to_array_replacements, augmented_proxied_array_function_replacements
+
+Getting just the first match:
+> $ obfuscation-detector /path/to/obfuscated.js stop
+> [+] function_to_array_replacements
+
+The `stopAfterFirst` arguments doesn't have to be any specific string, it just needs not to be empty.
+
 ## Supported Obfuscation Types
 You can find descriptions of the different types in the code itself, and more info [here](src/detectors/README.md). 
 - [Array Replacements](src/detectors/arrayReplacements.js)

bin/obfuscation-detector.js

@@ -0,0 +1,18 @@
+#!/usr/bin/env node
+const fs = require('node:fs');
+const detectObfuscation = require(__dirname + '/../src');
+
+if (require.main === module) {
+	try {
+		const args = process.argv.slice(2);
+		if (args.length) {
+			let content = fs.readFileSync(args[0], 'utf-8');
+			const stopAfterFirst = !!args[1];
+			const obfuscationType = detectObfuscation(content, stopAfterFirst);
+			if (obfuscationType.length) console.log('[+] ' + obfuscationType.join(', '));
+			else console.log('[-] No obfuscation detected / unknown obfuscation');
+		} else console.log('Usage: obfuscation-detector /path/to/obfuscated.js [stopAfterFirst]');
+	} catch (e) {
+		console.error(`[X] Critical Error: ${e.message}`);
+	}
+}

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "obfuscation-detector",
-  "version": "1.1.4",
+  "version": "1.1.5",
   "description": "Javascript obfuscation detector",
   "main": "src/index.js",
   "directories": {
@@ -10,6 +10,9 @@
   "scripts": {
     "test": "node tests/testDetectors.js"
   },
+  "bin": {
+    "obfuscation-detector": "./bin/obfuscation-detector.js"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/PerimeterX/obfuscation-detector.git"
@@ -28,7 +31,7 @@
   },
   "homepage": "https://github.com/PerimeterX/obfuscation-detector#readme",
   "devDependencies": {
-    "eslint": "^8.43.0",
+    "eslint": "^8.45.0",
     "husky": "^8.0.1"
   },
   "dependencies": {