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

@codoonfxd/commitlint-config

v0.2.0

Published

git commit message 规范配置

Downloads

9

Readme

commitlint-config

根据公司项目定制化的 git commit message 规范。

需要注意的是,该配置基于angular的规范,并稍稍做了一些改动。如果对这方面还不够了解,可以参考阮一峰的这篇文章

安装与配置

该配置必须配合commitlint使用,具体细节请参考其官方文档。

(1) 安装

需要在项目中安装huskycommitlint

yarn add -D @codoonfxd/commitlint-config @commitlint/cli husky

(2) 配置

在项目中的package.json中添加以下内容。

/* package.json */
{
  "husky": {
    "hooks": {
      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
    }
  },
  "commitlint": {
    "extends": ["@codoonfxd/commitlint-config"]
  }
}

规则简介

该配置项目包含以下配置,所有的配置列表请查看这里

header-max-length

  • 条件: header的最大长度不能超过 72

body-leading-blank

  • 条件: body要以空行开始,即\n

footer-leading-blank

  • 条件: footer要以空行开始,即\n

scope-case

  • 条件: 允许的scope格式,支持以下三种。
// 小写形式
lowercase
// 驼峰形式
camelCase
// 蛇形
snake_case

scope-empty

  • 条件: scope可以为空,但是会警报。

subject-empty

  • 条件: subject不可为空。

type-case

  • 条件: type必须是小写的格式。

type-empty

  • 条件: type不可以为空。

type-enum

  • 条件: type 的类型只能是下表中的一个。
build
chore
ci
docs
feat
fix
pack
perf
refactor
revert
style
test

温馨提示:可以直接使用cz-codoon-changelog进行 commit 提交。