Reflect is a Node.js tool that simplifies the creation of a reflection document based on GitHub activity. By collecting merged pull requests and closed issues, it generates a detailed markdown document highlighting key contributions, ensuring users have a polished summary of their achievements.
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.
The tool can be executed in two different modes:
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]
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]
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.Upon execution, the tool produces markdown files in the output directory:
--brag flag is used, this file contains a condensed technical summary, grouping similar contributions and emphasizing key alterations and patterns.Reflect ensures security through the use of environment variables for API keys, sanitized file operations, and thorough input validation, protecting against potential vulnerabilities.
No comments yet.
Sign in to be the first to comment.