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

@edgelogistics/cz-conventional-changelog

v1.0.0

Published

Prompts for conventional changelog standard with an extra step to insert Jira ID.

Downloads

6

Readme

@edgelogistics/cz-conventional-changelog

A fork of cz-conventional-changelog.

Prompts for conventional changelog standard with an extra step to insert Jira Histories and Jira tasks

Demo

Jira ID in the format of /^([A-Z0-9]+-[0-9]+)(,[A-Z0-9]+-[0-9]+)*\$/, "ADR-123,DSA-31" for example. Allow multiple Jira issues.

Install

with npm

npm install --save-dev @edgelogistics/cz-conventional-changelog

or with yarn

yarn add --dev @edgelogistics/cz-conventional-changelog

To enable it, please update your package.config as the following

"config": {
    "commitizen": {
      "path": "./node_modules/@edgelogistics/cz-conventional-changelog"
    }
  },

Features

  • 🔥 It works with semantic-release and Standard Version right out of the box.
  • 💚 It share the same configurtion with commitlint's default configuration.
  • 💆‍♀️ It prompts an optional step for inserting your Jira ID.
  • 🤖 It automatically detects Jira ID from your current branch name and display it as default value at the prompt step.
  • 📝 Jira ID is composed into the top of your commit message body.

Configuration

package.json

Like commitizen, you specify the configuration of cz-conventional-changelog through the package.json's config.commitizen key.

{
// ...  default values
    "config": {
        "commitizen": {
            "path": "./node_modules/cz-conventional-changelog",
            "disableScopeLowerCase": false,
            "disableSubjectLowerCase": false,
            "maxHeaderWidth": 100,
            "maxLineWidth": 100,
            "defaultType": "",
            "defaultScope": "",
            "defaultSubject": "",
            "defaultBody": "",
            "defaultIssues": "",
            "scopeChoices": [{
              "name": "topic1",
              "description": "Scope for tasks related with the Topic 1"
            }],
            "types": {
              ...
              "feat": {
                "description": "A new feature",
                "title": "Features"
              },
              ...
            }
        }
    }
// ...
}

Environment variables

The following environment varibles can be used to override any default configuration or package.json based configuration.

  • CZ_TYPE = defaultType
  • CZ_SCOPE = defaultScope
  • CZ_SUBJECT = defaultSubject
  • CZ_BODY = defaultBody
  • CZ_MAX_HEADER_WIDTH = maxHeaderWidth
  • CZ_MAX_LINE_WIDTH = maxLineWidth

Commitlint

If using the commitlint js library, the "maxHeaderWidth" configuration property will default to the configuration of the "header-max-length" rule instead of the hard coded value of 100. This can be ovewritten by setting the 'maxHeaderWidth' configuration in package.json or the CZ_MAX_HEADER_WIDTH environment variable.