UNPKG

unqommented

Version:

A Node.js utility that quickly identifies files with uncommented code in your codebase. Designed for developers who want to efficiently tell LLMs exactly which files need comments added.

21 lines (14 loc) 1.11 kB
# `lib` Directory Summary This directory contains the core logic and utility functions for the `unqommented` application, organized using Single Responsibility Principle (SRP) architecture. ## Core Modules (SRP Architecture) - **`index.js`**: Central export point that consolidates all library exports for easy importing. - **`utils.js`**: Compatibility layer that maintains backward compatibility by re-exporting all functions from specialized modules. ## Specialized Modules (by Responsibility) - **`string-utils.js`**: String manipulation and formatting functions - **`validation-utils.js`**: Input validation utilities (email validation, etc.) - **`id-utils.js`**: Unique identifier generation using crypto.randomBytes - **`file-utils.js`**: File system operations and cross-platform path handling - **`concurrency-utils.js`**: Async concurrency management with configurable limits - **`code-analyzer.js`**: Core code analysis logic for detecting uncommented code and directory scanning ## Testing - **`tests/`**: Comprehensive Jest-based test suite covering all modules and edge cases