emoji-cz's Introduction

emoji-cz

✨ Un adaptador con emoji para commitizen.

? Selecciona el tipo de cambio que estas enviando: (Use arrow keys)
❯ ✨  Feat:      Una nueva característica
  🐛  Fix:       Una corrección de error
  📚  Docs:      Cambios solamente en documentación
  🎨  Style:     Cambios que no afectan el código.
  🔨  Refactor:  Un cambio de código que no corrige un error ni agrega una característica
  🚀  Perf:      Un cambio de código que mejora el rendimiento.
  🚨  Test:      Agregar pruebas faltantes o corregir pruebas existentes

Demo

Solo mira el historial de confirmaciones ☝️

Instalation

yarn global add @rsurjano/emoji-cz
# O
# npm install --global @rsurjano/emoji-cz

establecer como adaptador predeterminado globalmente
echo '{ "path": "emoji-cz" }' > ~/.czrc

Uso

Simplemente use git cz en lugar degit commit cuando se comprometa. Ver el documento de Commitizen para más información.

Configuraciones

Puede sobrescribir la configuración de 3 formas diferentes, aplicará la configuración en este orden:

package.json
.cz.json
.czrc

// in package.json
"config": {
  "commitizen": {
    // ...
    "emoji-cz": {
      // Overwrite types prompted to the command line.
      "types": {
        "Fix": {
          "emoji": "🐝", // overwrite "Fix" emoji to a bee
          "name": "Bug", // overwrite "Fix" name to "Bug"
          "description": "Dirty bug" // overwrite description of "Fix"
        },
        // add a new type "Chore"
        "Chore": {
          "emoji": "❓",
          "description": "Other changes that don't modify src or test files"
        }
      },

      // Overwrite the output commit subject in the specified format.
      // Below is the default format,
      // [emoji] will be replace with the chose type's emoji,
      // [name] will be replace with the chose type's name,
      // [subject] will be replace with the subject you entered.
      // One example output of the format can be: `✨ Feat: initial commit`
      "format": "[emoji] [name]: [subject]"
    }
  }
}

// in .cz.json or .czrc
{
  "emoji-cz": {
    //...
  }
}