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 for the module.
 * It imports all public-facing functions from the 'lib' directory and re-exports them,
 * providing a clean and consistent interface for users. This approach simplifies the
 * module's import structure and makes it easier to manage public-facing utilities.
 */

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,
};