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

commitwizard-cli

v1.0.6

Published

A CLI tool that helps developers select a commit message category interactively before writing a Git commit message, ensuring consistent and structured commit history.

Downloads

72

Readme

CommitWizard CLI

CommitWizard CLI is a command-line tool that helps developers write consistent and structured Git commit messages by interactively selecting a commit category before writing the message. This ensures best practices are followed and makes it easier to maintain a clear commit history.

Features

  • Interactive commit prompts: Select a commit category from a list of predefined options.
  • Structured commit messages: Automatically prepend the selected category to your commit message.
  • Customizable categories: Easily modify the categories to suit your workflow, including the use of special characters and emojis for more expressive commit messages.
  • Emoji and special character support: Write commit messages and categories that include emojis and special characters to add more context and visual clarity.
  • Command-line tools for managing commits:
    • View commit history: Use commitwizard --log to view a list of recent commits.
    • Undo last commit: Use commitwizard --undo to undo the last commit while keeping changes staged.
    • Amend previous commit: Use commitwizard --amend to modify the previous commit, including editing the message or adding new changes.
    • Generate configuration: Use commitwizard --config to create a default .commitwizardrc file for customizing commit categories.
    • View version: Use commitwizard -v or commitwizard --version to display the current version of CommitWizard CLI.

Installation

To install CommitWizard globally:

npm install -g commitwizard-cli

Updates

To update CommitWizard globally:

npm update -g commitwizard-cli

Current version: 1.0.6

Usage

After staging your changes, simply run:

commitwizard

Follow the prompts to select a commit category and write your commit message. CommitWizard will automatically format and create the Git commit for you.

Commands

| Command | Description | |----------------------------------|------------------------------------------------------------------------------------------------------------------| | commitwizard -v or --version | Displays the current version of CommitWizard CLI. | | commitwizard --config | Generates a default .commitwizardrc configuration file in the current directory. This file can be used to customize the available commit categories. | | commitwizard --log | Displays a list of the last 10 commits. | | commitwizard --undo | Undo the last commit but keep the changes staged. | | commitwizard --amend | Amend the previous commit, either by editing the message or adding new changes. |

Default Commit Categories

CommitWizard provides the following categories for your commit messages:

  • chore: Changes to the build process or auxiliary tools
  • ci: Continuous Integration and deployment
  • docs: Documentation only changes
  • feat: A new feature
  • fix: A bug fix
  • perf: Performance updates and optimization
  • refactor: A code change that neither fixes a bug nor adds a feature
  • remove: Removing files or unnecessary code
  • revert: Undo changes that have been committed to the repository
  • style: Changes that do not affect the meaning of the code
  • test: Adding tests or correcting existing tests
  • update: Small updates that do not change functionality

Example

Stage your changes:

git add -A

Run CommitWizard:

commitwizard

Select a category and write your commit message:

? Select the type of change that you're committing:

  • [feat]: A new feature
  • [fix]: A bug fix
  • [docs]: Documentation only changes

Write your commit message: Add feature to handle user login

The resulting commit message will be:

[feat]: Add feature to handle user login

Customization

CommitWizard allows you to define your own commit categories by creating a .commitwizardrc file in the root of your project. Running the commitwizard --config command will generate the .commitwizardrc file for you, including default categories that can be changed. The file should be written in JSON format, like so:

{ "categories": [ { "label": "chore", "description": "Changes to the build process or auxiliary tools" }, { "label": "feat", "description": "A new feature" } // Add more categories as needed ] }

Contributing

Contributions are welcome! Feel free to open an issue or submit a pull request on GitHub.

License

MIT

Author

Sarah Rhone Lachner (GitHub)

Happy committing! 😊