semantic-commit-emoji-config
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

semantic-commit-emoji-config

This library powers the configuration loading for semantic-commit-emoji.

Config files

This library will parse up the directory tree to attempt to find any of the following filenames:

  • package.json with a semantic-commit-emoji key
  • .semantic-commit-emojirc
  • .semantic-commit-emojirc.json
  • .semantic-commit-emojirc.yaml
  • .semantic-commit-emojirc.yml
  • .semantic-commit-emojirc.ts
  • .semantic-commit-emojirc.js
  • semantic-commit-emoji.config.ts
  • semantic-commit-emoji.config.js

Config Values

Option Default Description
withSpace false If true, includes a space between the emoji and the commit type
automaticTypes A map of specific automatic commit actions and the emoji to prepend. Overriding will merge with the defaults.
automaticTypes.fixup ""
automaticTypes.merge "twisted_rightwards_arrows" 🔀
automaticTypes.revert "rewind"
automaticTypes.version "bookmark" 🔖
conventionalTypes A map of semantic commit types, and the corresponding emoji to prepend. Overriding will not merge with the defaults
conventionalTypes.feat "sparkles"
conventionalTypes.fix "bug" 🐛
conventionalTypes.docs "pencil" 📝
conventionalTypes.refactor "recycle" ♻️
conventionalTypes.style "art" 🎨
conventionalTypes.test "microscope" 🔬
conventionalTypes.perf "zap"
conventionalTypes.hotfix "ambulance" 🚑
conventionalTypes.locale "globe_with_meridians" 🌐
conventionalTypes.ci "construction_worker" 👷
conventionalTypes.chore "wrench" 🔧
conventionalTypes.types "label" 🏷️

Readme

Keywords

none

Package Sidebar

Install

npm i semantic-commit-emoji-config

Weekly Downloads

380

Version

1.0.0

License

GPL-3.0

Unpacked Size

43.8 kB

Total Files

5

Last publish

Collaborators

  • adambullmer