Nevermore: a Poet's Mantra

    @jeromefitz/conventional-gitmoji
    TypeScript icon, indicating that this package has built-in type declarations

    3.1.0 • Public • Published

    @jeromefitz/conventional-gitmoji

    1. 🌉️ A bridge between gitmoji and conventional-commits configured for semantic-release.
    2. 🛠️ A conventional-changelog plugin for semantic-release.

    Usage

    yarn install @jeromefitz/conventional-gitmoji
    import { releaseRules, typeSpecs, types } from '@jeromefitz/conventional-gitmoji`
    • releaseRules: informs @semantic-release/commit-analyzer
    • typeSpecs: informs @jeromefitz/release-notes-generator (via writerOpts)
      • @hack: This informs three different ways to ensure we catch the change from gitmoji to conventional
    • types: informs @jeromefitz/git-cz for the gitmoji theme.

    Commit Analyzer

      [
        '@semantic-release/commit-analyzer',
        {
          config: '@jeromefitz/conventional-gitmoji',
          releaseRules,
        },
      ]

    Release Notes Generator

      [
        '@jeromefitz/release-notes-generator',
        {
          config: '@jeromefitz/conventional-gitmoji',
        },
      ]

    Overview

    😄️ gitmoji

    This maps gitmoji to an equivalent conventional-commit.

    ⚗️ Example(s):

    • ✨️ => feat
    • 🐛️ => fix
    • 🚑️ => hotfix

    📝️ conventional-commits

    This expands on the original conventional-commits nomenclature to account for the multitude coming from gitmoji

    ⚗️ Example(s):

    • ⚗️ (gitmoji)
      • alembic (emoji code)
      • experiement (conventional)
    • 🤡️ (gitmoji)
      • clown-face (emoji code)
      • mock (conventional)
    • 🚨️ (gitmoji)
      • rotating-light (emoji code)
      • lint (conventional)

    🚀️ semantic-release

    Adds semver to each type to inform @jeromefitz/semantic how to handle each commit type (and if it is a convential branch type).

    ⚗️ Example(s):

    {
      "experiment": {
        "branch": false,
        "code": ":alembic:",
        "commit": "experiment",
        "description": "Perform experiments.",
        "emoji": "⚗️",
        "entity": "📸",
        "name": "alembic",
        "semver": "patch"
      },
      "feat": {
        "branch": "feature",
        "code": ":sparkles:",
        "commit": "feat",
        "description": "Introduce new features.",
        "emoji": "",
        "entity": "✨",
        "name": "sparkles",
        "semver": "minor"
      },
      "log-add": {
        "branch": false,
        "code": ":loud_sound:",
        "commit": "log-add",
        "description": "Add or update logs.",
        "emoji": "🔊",
        "entity": "🔊",
        "name": "loud-sound",
        "semver": null
      }
    }

    📝️ Please Note: The values major|minor|patch are moving to breaking|feature|fix

    Keywords

    none

    Install

    npm i @jeromefitz/conventional-gitmoji

    DownloadsWeekly Downloads

    196

    Version

    3.1.0

    License

    MIT

    Unpacked Size

    290 kB

    Total Files

    60

    Last publish

    Collaborators

    • jeromefitz