📦 @lowxr/gitmoji

💾 Installation

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

🛠 How to use?

📅 gitmoji/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: "@lowxr/gitmoji/changelog-config",
};

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

♟ gitmoji/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"

✨ gitmoji/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 .commitlintrc.js

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

☂ gitmoji/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 "@lowxr/gitmoji/parser";

const changelogConfig = {
 parserOpts,
};

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

🎨 gitmoji/regexs

[!NOTE] It is used to export all the regexs needed for the previous configurations, but if you need emojis you can use it

🎯 Contributing

🔩 Reporting Issues

If you encounter any bugs or problems while using the tool, please open a new issue here. To help us assist you faster, include as much detail as possible, such as:

• What you were trying to do.
• Any error messages or console logs.
• Your environment details (OS, versions, etc.)

The more info you provide, the quicker we can identify and fix the problem.

🔀 Pull Requests

Thanks for wanting to contribute! To submit improvements or fixes, please follow these steps:

1. Clone this repository using git clone https://github.com/lowxr/gitmoji.git.
2. Create a new branch from main with a clear, descriptive name, for example: git checkout -b feature/your-feature-name.
3. Make your changes and commit them with clear, meaningful messages.
4. Open a new pull request here, explaining what you added or fixed and why.

We’ll carefully review each PR and provide feedback if needed to help you get it merged.

📋 License

This repository is distributed under the terms of the MIT License.