unqommented/index.js

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.

/**
 * @file Main entry point for the unqommented npm module
 * @description This file serves as the public API facade for the module, implementing
 * the facade pattern to provide a clean and consistent interface for consumers.
 * @rationale The facade pattern simplifies the module's import structure and abstracts
 * internal architectural decisions from end users. This approach makes the module easier
 * to maintain and extend while providing stability for consumers.
 * @architectural_decision We import from lib/utils.js rather than individual specialized
 * modules to maintain backward compatibility with existing test infrastructure that
 * relies on mocking functions through the consolidated utils module.
 */

const {
  formatString,
  validateEmail,
  generateId,
  findUncommentedFiles,
  validateDirectory,
  createLimiter,
} = require('./lib/utils.js');

/**
 * @module unqommented
 * @description A collection of utility functions for code analysis and validation.
 */
module.exports = {
  /**
   * @see {@link module:utils.formatString}
   */
  formatString,
  /**
   * @see {@link module:utils.validateEmail}
   */
  validateEmail,
  /**
   * @see {@link module:utils.generateId}
   */
  generateId,
  /**
   * @see {@link module:utils.findUncommentedFiles}
   */
  findUncommentedFiles,
  /**
   * @see {@link module:utils.validateDirectory}
   */
  validateDirectory,
  /**
   * @see {@link module:utils.createLimiter}
   */
  createLimiter,
};