CommentEase

Automatically generate comments for your code files with CommentEase.

Features

• Recursive File Processing: Scans all files within the source directory.
• File Exclusion: Skips specified files and directories.

Installation

Ensure Node.js is installed, then run:

npm install commentease

Usage

1. Create a .exclude file in your project root to list files or directories to be excluded. Example:

   node_modules
   index.html

2. Run the Script:

   • Using npx:

     npx commentease

   • Or, if installed globally:

     commentease

3. Provide the Path:

   When prompted, enter the path to your source file or directory. For example:

   • Current directory:

     .

   • Single file:

     ./index.js

Example

$ npx commentease

Welcome to CommentEase - Let's enhance your code with comments!
Please enter the path to your source file or directory (e.g., . for current directory): .

Configuration

Excluded Paths

Add paths to exclude in the .exclude file, one per line.

License

Licensed under the ISC License.