Project-prompt-generator

Or install from source
pip install .

For development
pip install -e ".[dev]"


New Features ✨

- **Clipboard Integration**: 📎 Automatically copy output file paths to clipboard on macOS
- **Improved Event Handling**: ⚡ Refactored event system with dedicated handlers for end events
- **Enhanced Documentation**: 📚 Added important usage notes and deprecation warnings

Improvements 🔧

- **Build Process**: 🧹 Added clean step to release process in Makefile
- **Directory Structure**: 🏗️ Reorganized code for better maintainability
- **Environment Configuration**: 🔄 Enhanced `.envrc` handling with smarter variable management

Technical Changes 🛠️

- Added new `osx_clipboard.py` module with Swift-based clipboard functionality
- Refactored event handling in output handlers for better separation of concerns
- Renamed `envrc_handler.py` to `envrc.py` with improved variable management
- Removed deprecated `PPG_OUTPUT_DIR` environment variable
- Added new `PPG_ENABLE_CLIPBOARD` environment variable (default: "false")

Bug Fixes 🐞

- Fixed duplicate handler calls in event processing system
- Improved file path handling in clipboard integration
- Enhanced environment variable management to avoid duplicates in `.envrc` files

Notes 📝

- **Deprecated**: The `--markdown` output format is now deprecated and will be removed in a future version
- **Important**: While the tool attempts to mask sensitive information, always review generated files before sharing

New Features ✨

- **JSON Output Format**: 📊 Generates project data in JSON format, with options for compact or line-split content.
- **Markdown Output**: 📝 Generate structured Markdown documentation, including a table of contents.
- **`.envrc` Integration**: 🚀 Simplified configuration with automatic `.envrc` file updates.
- **`last-run` Tool**: 🏃‍♂️ A command-line utility to quickly run recently modified scripts in your Downloads directory.
- **Force Execution**: 💪 Use the `--force` flag to run ppg outside of a git repository.

Improvements 🔧

- **Simplified CLI Usage**: Streamlined command-line interface with more intuitive options.
- **JSON Output**: 📊 Generates structured JSON outputs for ingestion into other tools.
- **Robust Script Detection**: `last-run` uses comprehensive script type detection in clipboard content, especially for macOS users.
- **Enhanced Error Handling**: Improved error messages and graceful exit for various scenarios.
- **Improved Path Handling**: `.envrc` configuration now defaults to use paths in your Downloads folder relative to the current project.

Technical Changes 🛠️

- Introduced new `cli/last_run.py` and `cli/ppg.py` for handling command-line arguments.
- Created `outputs` package for managing different output formats (JSON and Markdown).
- Refactored file processing and output generation with event-based architecture.
- Improved language mapping and sensitive data masking.
- Moved utility functions into a `utils` package for better organization.

Bug Fixes 🐞

- Resolved issues related to git repository detection.
- Enhanced handling of file paths and directory creation.
- Improved reliability of sensitive data masking.
- Addressed miscellaneous issues for more consistent operation.

New Features ✨

- **Event-Based Architecture**: Completely refactored to use an event system for file processing and output generation 📡
- **Simplified Command Interface**: Default command now generates a single all-in-one file, with `--split` option for individual files 🧩
- **Enhanced File Walking**: New dedicated `FileWalker` class for improved directory traversal and file filtering 🔍
- **Custom Ignore Files**: Support for custom ignore files via `PPG_IGNORE_FILES` environment variable 🛠️
- **PowerShell Secure String Detection**: Improved sensitive data masking for PowerShell secure strings 🔒
- **Advanced Test Cases**: Added test cases for complex password patterns and secure string variations ✅

Improvements 🔧

- **Simplified Usage**: The default `ppg` command now generates an all-in-one file without requiring subcommands 🚀
- **Cleaner Error Handling**: Better error management in file processing and improved feedback during processing 📊
- **More Flexible Ignore Rules**: Enhanced ignore rules that respect both `.gitignore` and custom patterns 🛡️
- **Modular Components**: Split functionality into focused modules for better code organization 📁

Technical Changes 🛠️

- Added new modules: `events.py`, `file_walker.py`, `ignore_handler.py`, `language_mapping.py`, `options.py`, and `output_handler.py` for better code organization ⚙️
- Completely refactored `generator.py` to use the event system architecture 🔄
- Modified command-line interface in `cli.py` to simplify usage patterns 🖥️
- Replaced direct file output with handlers for different output formats 📝
- Added `FileEntry` data class for consistent file metadata handling 📄

Bug Fixes 🐞

- Fixed sensitive data masking to properly handle PowerShell secure strings with different parameter formats 🛠️
- Fixed path handling for files with special characters 🔧
- Improved UTF-8 handling for file content processing 📄

Dependency Updates ⬆️

- No changes to external dependencies in this version ✓

New Features ✨

- **Environment Variable Configuration**: Customize output locations using `PPG_OUTPUT_DIR` and `PPG_OUTPUT_FILE` 🌐
- **Flexible CLI**: Uses `argparse` for enhanced command-line argument parsing 🚀
- **Test Coverage**: Added `coverage` target to Makefile for test coverage reporting 🧪
- **Test Cases**: Added test cases for masking API keys, passwords, and handling text without sensitive data ✅
- **Ignore .pytest_cache**: The `.pytest_cache` directory is now ignored by default 🛡️

Improvements 🔧

- **Enhanced README**: Improved documentation with comprehensive examples and environment variable details 📚
- **Robust Path Handling**: Handles environment variables, "~", and absolute paths in output directory and file configurations 📁

Technical Changes 🛠️

- Migrated from `click` to `argparse` in `cli.py` for argument parsing ⚙️
- Added `expand_path_variables` in `prompts/generator.py` for path handling 🌐
- Modified `get_files_to_process` in `prompts/file_processor.py` to skip output file and `.pytest_cache` 📁
- Improved sensitive data masking regex and handling in `prompts/sensitive_masker.py` 🔒

Bug Fixes 🐞

- Fixed sensitive data masking to correctly handle different quote characters in PowerShell secure strings and other scenarios 🛠️

Dependency Updates ⬆️

- Removed `click` dependency 🚫
- Added `pytest` and `pytest-cov` as development dependencies ✅

New Features ✨

- **Modular Architecture**: Completely refactored the codebase into a modular structure with dedicated modules for different functionality 🔄
- **Command Flexibility**: Split the functionality into two separate commands:
- `generate` (aliases: `g`, `gen`): Creates individual markdown files in a directory 📄
- `generate_all_in_one` (aliases: `a`, `all`): Creates a single consolidated markdown file 📑
- **Simpler Command Names**: Added `ppg` as an alternative to `promg` for easier typing ⌨️

Improvements 🔧

- **Better Code Organization**: Created dedicated modules for file processing, generation, and sensitive data masking 🗂️
- **Enhanced Documentation**: Updated README with detailed command documentation and project structure 📚
- **Cleaner Output Options**: More flexibility in where output files are created:
- Individual files in `ppg_generated/` directory 🗄️
- Single file as `ppg_created_all.md.txt` in the current directory 📁

Technical Changes 🛠️

- Moved core functionality from monolithic `cli.py` into separate modules:
- `generator.py`: Handles file generation workflows ⚙️
- `file_processor.py`: Handles file reading and markdown conversion 📑
- `sensitive_masker.py`: Manages sensitive data detection and masking 🔒
- Added proper package exports in `__init__.py` 📦
- Simplified command-line interface with clear command aliases ⌨️

Upgrade Notes ⚠️

- The legacy `gen` command has been removed; use `generate` or `generate_all_in_one` instead 🚫
- Command aliases provide convenient shortcuts for frequently used commands 🔄
- The output directory is now called `ppg_generated` (without the dot prefix) 📁