Nth Phonetic Mnemonic

    @stackr23/gitmoji-conventional-commits

    3.2.10 • Public • Published

    @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 type prefix gitmoji versioning
    bug fix fix: 🐛 patch
    feature feat: minor
    breaking change fix: 💥 major
    chore tasks chore: ???
    documentation doc: 📝
    styling style: 💄
    refactor refactor: ♻️
    performance perf:
    tests test:
    without topic rel favicon

    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

    Install

    npm i @stackr23/gitmoji-conventional-commits

    DownloadsWeekly Downloads

    3

    Version

    3.2.10

    License

    GNU LGPLv3

    Unpacked Size

    69.2 kB

    Total Files

    10

    Last publish

    Collaborators

    • doubleu23