Socket
Socket
Sign inDemoInstall

@stackr23/gitmoji-conventional-commits

Package Overview
Dependencies
0
Maintainers
1
Versions
25
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @stackr23/gitmoji-conventional-commits

add gitmojis to conventional commit messages


Version published
Maintainers
1
Install size
68.6 kB
Created

Readme

Source

@stackr23/gitmoji-conventional-commits

add gitmojis to conventional commit messages

Build Status Greenkeeper badge Maintenance PRs Welcome
npm version Conventional Commits Semantic Versioning GitMoji

v3

gitMojiToCC

import {gitMojiToCC}  from '@stackr23/gitmoji-conventional-commits'
const emoji           {name: 'zap', emoji: '⚡️'}
const prefixedGitmoji = gitMojiToCC({name, emoji})
console.log(prefixedGitmoji)
// => 'perf(⚡️):'

TBD - advanced format

  • use scope if added - fix(<scope>): 🐛
    • add scope to promots.gitmoji

extendGitmoji

import {extendGitmoji}  from '@stackr23/gitmoji-conventional-commits'
const extendedConfig    = extendGitmoji(GITMOJI/DATA/GITMOJI.json)

adds found cc_prefix to gitmoji objects for later usage

relation table

commit typeprefixgitmojiversioning
bug fixfix::bug:patch
featurefeat::sparkles:minor
breaking changefix::boom:major
chore taskschore:???
documentationdoc::memo:
stylingstyle::lipstick:
refactorrefactor::recycle:
performanceperf::zap:
teststest::white_check_mark:
without topic relfavicon

TBC

detailed specification of conventional-commits:
https://www.conventionalcommits.org/en/v1.0.0-beta.2/

extended type definitions are stated by angular
https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#type

plugin PROPOSAL conventionalcommits - gitmoji

suffix "structural elements" with gitmojis fix(header): #33 header menu open() => fix(header): :bug: #33 header menu open()

other conventional-commit tools

should be considered into compatibility specations of @stackr23/gitmoji-conventional-commits

Keywords

FAQs

Last updated on 19 Nov 2018

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc