Docs

[BenBaryoPX]

This pull request introduces significant updates to the obfuscation-detector project, including enhancements to documentation, code refactoring for detectors, dependency updates, and ESLint configuration improvements. These changes aim to improve usability, maintainability, and accuracy of the tool.

Documentation Enhancements:

• Expanded and restructured README.md with an overview, use cases, API reference, CLI options, troubleshooting, and detailed examples for better user guidance. [1] [2]
• Replaced the verbose and outdated content in src/detectors/README.md with a modular structure, including a detector overview, list of detectors, and guidelines for adding new detectors.

Code Refactoring:

• Refactored detectArrayFunctionReplacements in src/detectors/arrayFunctionReplacements.js to simplify logic and improve readability by replacing nested loops with Array.prototype.some.
• Refactored detectArrayReplacements in src/detectors/arrayReplacements.js to use Array.prototype.some, aligning with modern JavaScript practices.

Dependency Updates:

• Upgraded eslint from ^9.16.0 to ^9.26.0 and flast from ^2.2.1 to ^2.2.3 in package.json to ensure compatibility and leverage the latest features.

ESLint Configuration:

• Changed the no-empty rule in eslint.config.js to allow empty catch blocks by enabling the allowEmptyCatch option, improving flexibility for error handling.

[Copilot]

Pull Request Overview

This PR overhauls documentation, modernizes detector implementations, and updates dependencies/configuration for better maintainability and usability.

• Expanded top-level and per-detector README files with clear overviews, usage instructions, CLI options, and examples
• Refactored detector loops to use Array.prototype.some/find, improved JSDoc comments, and added divide-by-zero guards
• Bumped eslint and flast versions and enabled allowEmptyCatch in eslint.config.js

Reviewed Changes

Copilot reviewed 17 out of 17 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
src/index.js	Enhanced JSDoc, switched detector iteration to Object.keys
src/detectors/sharedDetectionMethods.js	Fixed typo, added zero-length guard, refined JSDoc
src/detectors/obfuscator-io.js	Added and detailed JSDoc for new helper functions
src/detectors/functionToArrayReplacements.js	Updated JSDoc to follow consistent style
src/detectors/caesarp.js	Expanded JSDoc, corrected assignment spelling
src/detectors/augmentedProxiedArrayFunctionReplacements.js	Added JSDoc, clarified argument checks
src/detectors/augmentedArrayReplacements.js	Refactored loop to find, updated return pattern
src/detectors/augmentedArrayFunctionReplacements.js	Refactored loop to some, streamlined detection flow
src/detectors/arrayReplacements.js	Refactored loop to some, cleaned return logic
src/detectors/arrayFunctionReplacements.js	Refactored loop to some, cleaned return logic
src/detectors/README.md	Replaced verbose example code with modular overview and table
package.json	Upgraded eslint to ^9.26.0, flast to ^2.2.3
eslint.config.js	Enabled allowEmptyCatch for no-empty rule
README.md	Expanded overview, usage sections, CLI flags, troubleshooting tips

Comments suppressed due to low confidence (3)

src/index.js:7

• The logger import is not used in this file. Consider removing it to keep imports clean and avoid unused-variable warnings.

import {generateFlatAST, logger} from 'flast';

src/detectors/sharedDetectionMethods.js:51

• The JSDoc @returns {ASTNode[]|null} is misleading: the function actually returns a single ASTNode (or undefined). Update the JSDoc to reflect the actual return type.

function arrayIsProvidedAsArgumentToIIFE(references, targetArrayName) {

src/detectors/augmentedArrayReplacements.js:18

• [nitpick] The variable isFound suggests a boolean, but it's assigned an AST node or undefined. Consider renaming it to foundCandidate or similar for clarity.

const isFound = candidates.find(c => {

[Copilot]

Pull Request Overview

This PR overhauls documentation, modernizes detector code, updates dependencies, and tightens ESLint rules for the obfuscation-detector project.

• Expanded and restructured README files for clarity and navigation.
• Refactored detector modules to use Array.prototype.some/find and improved JSDoc.
• Upgraded eslint and flast, and enabled allowEmptyCatch for the no-empty rule.

Reviewed Changes

Copilot reviewed 17 out of 17 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
src/index.js	Updated JSDoc and iteration over detectors via Object.keys.
src/detectors/sharedDetectionMethods.js	Fixed typos, added guard for zero-length AST, refined JSDoc.
src/detectors/*.js	Switched loops to some/find, standardized JSDoc across detectors.
src/detectors/README.md	Replaced outdated content with a tabular overview of detectors.
README.md	Expanded project overview, use cases, CLI flags, and troubleshooting.
package.json	Bumped eslint to ^9.26.0 and flast to ^2.2.3.
eslint.config.js	Changed no-empty rule to allow empty catch blocks.

Comments suppressed due to low confidence (1)

src/detectors/arrayReplacements.js:18

• This refactored logic using some replaces the old loop-based return. Ensure you add or update unit tests to cover cases where arrays are on the threshold of detection.

const isFound = candidates.some(c => {

[Copilot]

Pull Request Overview

This pull request improves both the documentation and the internal detection logic of the obfuscation-detector project while updating dependencies and ESLint configuration.

• Expanded and restructured documentation (README and detectors README) to improve user guidance.
• Refactored several detectors to use modern JavaScript methods like Array.prototype.some and Array.prototype.find for simplified logic.
• Upgraded dependencies (eslint and flast) and updated ESLint rules for better error handling.

Reviewed Changes

Copilot reviewed 17 out of 17 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
src/index.js	Updated main entry point with improved JSDoc and cleaner detector iteration.
src/detectors/sharedDetectionMethods.js	Fixed a spelling error and enhanced division safety in percentage calculations.
src/detectors/obfuscator-io.js	Added clarifying JSDoc comments to better explain detection logic.
src/detectors/functionToArrayReplacements.js	Improved documentation and streamlined detection function.
src/detectors/caesarp.js	Revised JSDoc for clarity in scope checking and obfuscation type detection.
src/detectors/augmentedProxiedArrayFunctionReplacements.js	Updated JSDoc and refined detection logic using array methods.
src/detectors/augmentedArrayReplacements.js	Refactored loop to use Array.prototype.find for clearer detection logic.
src/detectors/augmentedArrayFunctionReplacements.js	Switched to Array.prototype.some and improved reference handling.
src/detectors/arrayReplacements.js	Refactored detection with Array.prototype.some for better readability.
src/detectors/arrayFunctionReplacements.js	Streamlined loop logic with Array.prototype.some and added a check for reference count.
src/detectors/README.md	Modularized and clarified documentation for detector modules.
package.json	Updated dependency versions for improved compatibility and feature support.
eslint.config.js	Modified the no-empty rule setting to allow empty catch blocks with proper error setup.
README.md	Enhanced overall documentation with clear usage examples and troubleshooting tips.