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

cz-custom-issues

v1.0.0

Published

a commititizen helper with advanced issue config

Downloads

5

Readme

CZ CUSTOM ISSUES

A commititizen helper with advanced issue config.

npm Travis branch GitHub license GitHub issues Coveralls bitHound bitHound

Babel code style xo Standard Version test ava

yarn Commitizen friendly

example gif

Example output

The output follow the conventional-changelog and is easy to read for reviewers or project managers.

feat(new):  added config

options can now be changed

ISSUES CLOSED:
 - #12: add options
 - #14: configuration

BREAKING CHANGE: new options

Links

Getting started

## use yarn
yarn add cz-custom-issues -D
## or npm
## npm i cz-custom-issues -D

Setup

to setup the plugin simply extend you config in your package.json.

  • The "type" is currently optional and simply serves as an indicator. Keep this setting to make future updates easier.
  • The "prefix" can be used to add a project prefix to issue (e.g. jira issues): ABC // => #ABC-123

This allows easy listing of issues. The prefix will be added automatically.

23: server crashes, 27: server slows down, 21: page not available

ISSUES CLOSED:
 - #ABC-23: server crashes
 - #ABC-27: server slows down
 - #ABC-21: page not available

example gif

{
  "config": {
    "commitizen": {
      "path": "./node_modules/cz-custom-issues"
    },
    "cz-custom-issues": {
      "issues": {
        "type": "jira",
        "prefix": "ABC"
      },
      "config": "./cz-config.js"
    }
  }
}

Config

You can add your own flow to comitizen. See cz-customizable for the original implementation.

types

Custom commit types

  • types
    • [type]
      • name (used in prompt as info, use whitespaces and newlines for alignment)
      • value (used for commit message/prefix)
{
  types: [
    {
      value: 'feat',
      name: 'feature: Adds a new feature'
    },
    {
      value: 'fix',
      name: 'bugfix:  Fixes a bug'
    }
    // ...
  ]
}

scopes

Custom default scopes

  • scopes
    • [type]
      • name (used in prompt and commit message)
{
  scopes: [
    { name: 'client' },
    { name: 'server' }
    // ...
  ]
}

scopeOverrides

Override scopes per type

  • scopeOverrides
    • [type]
      • name (used in prompt and commit message)
{
  scopeOverrides: {
    fix: [{ name: 'windows' }, { name: 'osx' }, { name: 'linux' }],
    docs: [{ name: 'new' }, { name: 'change' }, { name: 'readme' }],
    style: [{ name: 'format' }, { name: 'whitespace' }, { name: 'fix' }]
  }
}

allowCustomScopes

Toggle custom scopes

  • allowCustomScopes
    • Boolean
{
  allowCustomScopes: true
}

allowBreakingChanges

Limit breaking chages to types

  • allowBreakingChanges
    • [...types]
{
  allowBreakingChanges: ['feat', 'fix']
}

Take a look at the example config file

Developing

To contribute make sure all test pass and the coding style is consistent

  • test: runs test and lints files
  • run lint: lints javascript files

Similar projects / inspiration