@billoneta/gitmoji NPM

📦 `@billoneta/gitmoji`

💾 Installation

# Using npm
npm install -D @billoneta/gitmoji
# Using yarn
yarn add -D @billoneta/gitmoji
# Using pnpm
pnpm add -D @billoneta/gitmoji

🛠 How to use?

📅 `changelog-config`

!NOTE A brief explanation of its use and the most recommended one.

You need to create a semantic release file first, files config

!IMPORTANT To use conventional gitmoji chagelog at least in Semantic Release just add it

// release.config.js or .releaserc.js

const changelogConfig = {
 config: '@billoneta/gitmoji/changelog-config',
};

export default {
 branches: ['main'],
 plugins: [
  ['@semantic-release/commit-analyzer', changelogConfig],
  ['@semantic-release/release-notes-generator', changelogConfig],
 ],
};

♟ `commit-types`

!NOTE These are the types I use to send commits to Github

1. Types

build: Changes to build system or dependencies
ci: Changes to CI configuration
docs: Documentation updates
feat: New features
fix: Bug fixes
perf: Performance improvements
refactor: Code refactoring
revert: Reverted changes
style: Code style changes
test: Test additions/modifications
chore: Maintenance tasks
wip: Work in progress (special case)

2. Usage

git commit -m "📝 docs: Update README.md with project details and installation instructions"

✨ `commitlint-config`

!NOTE A brief explanation of its use and the most recommended one.

You need to create a commitlint file first, files config

// commitlint.config.js or .commitlint.js

export default {
 extends: ['@billoneta/gitmoji/commitlint-config'],
};

☂ `parser`

!NOTE A brief explanation of its use and the most recommended one.

You need to create a semantic release file first, files config

!IMPORTANT The gitmoji parser is used in the Semantic Release configuration invidually, you would add only the parser and nothing else.

// release.config.js or .releaserc.js

import parserOpts from '@billoneta/gitmoji/parser';

const changelogConfig = {
 parserOpts,
};

export default {
 branches: ['main'],
 plugins: [
  ['@semantic-release/commit-analyzer', changelogConfig],
  ['@semantic-release/release-notes-generator', changelogConfig],
 ],
};