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

@shad02w/cmz

v1.0.13

Published

A helpful commit cli πŸ˜‚πŸ˜‚πŸ˜‚πŸ˜‚πŸ˜‚πŸ˜‚πŸ˜‚

Downloads

13

Readme

CMZ

A helpful commit cli πŸ˜‚πŸ˜‚πŸ˜‚πŸ˜‚πŸ˜‚πŸ˜‚πŸ˜‚

Installation

Global

yarn add global @shad02w/cmz
# or
npm i -g @shad02w/cmz
# then commit using
cmz

Local

yarn add -D @shad02w/cmz
# then commit using
yarn cmz

Configurations

Add cmz.config.js to the root of workspace and repo, add setup as following:

const { defineConfig } = require('@shad02w/cmz')

module.exports = defineConfig({
    commitTypes: [
        {
            name: 'Refactor',
            description: 'A code change that neither fixes a bug nor adds a feature',
        },
        {
            name: 'Fix',
            description: 'A bug fix',
        },
        {
            name: 'Upgrade',
            description: 'Dependencies update and change',
        },
        {
            name: 'Publish',
            description: 'Release a new version to npm',
        },
    ],
    scopes: [
        {
            name: 'app',
            description: 'App for native platform',
        },
        {
            name: 'web',
            description: 'Web application',
        },
        {
            name: 'shared',
            description: 'Shared code between web and app',
        },
    ],
    // Final commit message reolve to
    resolve: ({ commitType, message }) => `(${commitType.name}) ${message}`,
})

You can also define configuration file in Typescirpt , to do that , create a cmz.config.ts file and set it up similar to above

import { defineConfig } from '@shad02w/cmz'

export default defineConfig({
    // Your config here
})

and also install ts-node, without ts-node the config file will not able to transpile.

If you do not want to put config file on root of the workspace or want a alternative config file name, you can use

cmz -c "your config file path here"

to specify a config file.

Options

# cmz -h
A simple git commit tool

USAGE
  $ cmz

OPTIONS
  -c, --config=config  custom config file path
  -h, --help           show CLI help
  -v, --version        show CLI version

Contributors