npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

commitscribe

v1.0.13

Published

Translate git logs into Release Notes / Changelog

Downloads

15

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

brianofrokk3rbrianofrokk3r

Keywords

gitchangelogreleasenotescommitscribe

Readme

CommitScribe

An npm package for generating a changelog from git logs. The script retrieves git logs for the past week, processes the logs, and generates a changelog using GPT-3.

Installation

To install the script, run the following command:

npm install -g commitscribe

Usage

To use the script, first set your OpenAI API key by running the following command:

cs config -k <key>

Then, to generate a changelog for the week, run:

cs weekly

Then, to generate a changelog between two branches, run:

cs between dev main

Output

The script will output a changelog in the following format:

✨ Feature (38%):
- add new feature requests and chore tasks to development section in README.md
- add build, start, and dev dependencies to package.json
- add OPENAI_API_KEY environment variable and config file to config.ts
- add functions to get git logs and last merge to git.ts
- add instructions for installation and usage to README.md
- add getNodeVersion function to get version from package.json
- add dotenv package to load environment variables to index.js
- add generateCommitSummary function to generate commit summary using OpenAI API to index.js
- add classifyCommit function to classify commit messages to index.js
- add processGitLogs function to process git logs and generate daily and weekly summaries to index.js
- add updateChangelog function to update changelog with daily and weekly summaries to index.js
- add script to generate changelog from git logs to index.js

🐛 Fix (5%):
- fix typo in package-lock.json file name in .gitignore
- fix indentation in getGitLogs function in index.js

📦 Chore (21%):
- add description to package.json in docs
- remove build directory from git tracking in .gitignore
- add build directory to gitignore in .gitignore
- add .env file to ignore list in .gitignore
- update OpenAI API key and organization ID in index.js
- add axios and fs dependencies in index.js
- add dependencies for changelog script (axios, commander, openai) in package.json

🔄 Refactor (5%):
- change program name from 'get' to 'cl' in index.js

📝 Docs (31%):
- add release 1.0.0 with features, chores, fixes, and docs to CHANGELOG.md
- add development tasks for cl command to README.md
- add MIT License to project in LICENSE
- create new file CHANGELOG.md in docs

Development

  • [ ] Test: Add tests
  • [ ] Test: Resolve prompt to handle certain cases
  • [ ] Test: Validate date logic in getGitLogs
  • [ ] Chore: Limit number of commits to specific token size
  • [ ] Feature: Pipe output to CHANGELOG.md
  • [ ] Feature: Options for "User-Friendly" or "Technical" outputs
  • [ ] Feature: Summary since last merge from base branch to head branch (cs between <base branch> <head branch>)

License

This project is licensed under the MIT License.