Reflect

Reflect is an innovative Node.js tool designed to generate a comprehensive reflection document based on GitHub activity. This tool efficiently compiles and formats merged pull requests and closed issues, allowing users to assess their contributions over a specified time period.

Features

• 📥 Fetches merged pull requests and closed issues directly from GitHub.
• 🔍 Offers filtering options by author and date range (defaulting to the last six months).
• 📝 Creates well-structured, chronological markdown documents, combining both pull requests and issues in a single reflection file.
• ⚡ Leverages the GitHub CLI for efficient data retrieval.
• 🤖 Includes an optional feature for AI-powered summary generation and a professional brag document.
• 🔒 Safeguards API keys and sensitive data through secure handling practices.

How to Use

The tool can be executed in two different modes:

Development Mode

Users can run the script easily with the TypeScript Node package:

npx ts-node index.ts --username <github-username> --months <months-to-look-back> [--brag]

Production Mode

Alternatively, the tool can be compiled and executed as follows:

npx tsc --outDir dist && node dist/index.js --username <github-username> --months <months-to-look-back> [--brag]

Arguments

The project supports several command-line arguments:

• -u, --username <username>: Specify the GitHub username to analyze.
• -m, --months <number>: Define how many months back to look for activity.
• -b, --brag: Use this flag to enable the generation of a brag document.

Output

Upon execution, the tool produces markdown files in the output directory:

• contributions.md: A chronological overview of GitHub contributions, detailing each pull request and issue, sorted by closing date.
• summarized_contributions.md: When the --brag flag is used, this file contains a condensed technical summary, grouping similar contributions and emphasizing key alterations and patterns.
• brag_document.md: This document focuses on notable achievements, business impact, and contributions, making it suitable for performance reviews or portfolio showcases.

Security Considerations

Reflect ensures security through the use of environment variables for API keys, sanitized file operations, and thorough input validation, protecting against potential vulnerabilities.