Gitmoji

To maintain consistency when using gitmojis, follow this recommended commit message structure:

<intention> [scope?][:?] <message>

• <intention>: An emoji from the gitmoji list representing the purpose of the commit.
• [scope?]: An optional string providing contextual information about the area of the code being changed.
• [:?]: Optional separator.
• <message>: A brief, descriptive explanation of the change.

You can install the gitmojis package via npm to get access to the bundled gitmoji convention as a Node module.

npm i gitmojis

To use gitmojis from your command line via an interactive client, install the gitmoji-cli package globally using npm.

npm i -g gitmoji-cli

Import the gitmojis constant from the gitmojis package. It returns an array of objects, where each object represents a gitmoji with its corresponding emoji, HTML entity, shortcode, description, and name.

import { gitmojis } from 'gitmojis'

console.log(gitmojis)

/*
[
  {
    emoji: '🎨',
    entity: '🎨',
    code: ':art:',
    description: 'Improve structure / format of the code.',
    name: 'art',
    semver: null
  },
  {
    emoji: '⚡️',
    entity: '⚡',
    code: ':zap:',
    description: 'Improve performance.',
    name: 'zap',
    semver: null
  },
  ...
]
*/

You can display a Gitmoji badge at the top of your project's README to indicate support for the initiative using the following HTML snippet:

<a href="https://gitmoji.dev">
  <img
    src="https://img.shields.io/badge/gitmoji-%20😜%20😍-FFDD67.svg?style=flat-square"
    alt="Gitmoji"
  />
</a>

If you prefer not to install the package, you can consume the gitmoji data via a public HTTP API endpoint.

curl https://gitmoji.dev/api/gitmojis

The next-sitemap.config.js file defines the configuration for generating sitemaps and robots.txt files using the next-sitemap package. It uses the IConfig type from next-sitemap to ensure valid settings.

/** @type {import('next-sitemap').IConfig} */
module.exports = {
  siteUrl: 'https://gitmoji.dev',
  generateRobotsTxt: true,
}

The gitmojis package provides a direct export of the complete list of gitmojis. You can import the gitmojis constant to access the array of gitmoji objects, which contains the emoji, description, and other metadata for each gitmoji. Additionally, the package exports a schema object representing the JSON schema used for the gitmoji data.

import { gitmojis, schema } from 'gitmojis';

console.log(gitmojis); // Array of gitmoji objects
console.log(schema);   // The JSON schema for the gitmojis data

The LOGO_STATUSES object defines the available emoji states for the logo. Use these constants to ensure type safety when passing a status to the Status component.

export const LOGO_STATUSES = {
  JOY: 'JOY',
  LOVED: 'LOVED',
  SEXY: 'SEXY',
  SMILING: 'SMILING',
  SUNGLASSES: 'SUNGLASSES',
  TONGUE: 'TONGUE',
} as const

The gitmojis constant is a read-only array of Gitmoji objects. It is the primary entry point for accessing the full list of available gitmojis and their metadata.

import { gitmojis } from 'gitmojis';

// Example usage: finding a specific gitmoji by name
const bugEmoji = gitmojis.find(g => g.name === 'bug');
console.log(bugEmoji?.code); // ':bug:'

The Gitmoji type represents a single gitmoji object. Each object contains the emoji character, its HTML entity, a description of its use-case, its name, its associated semver impact, and its shortcode format.

type Gitmoji = {
  readonly emoji: string;      // e.g. '🎨'
  readonly entity: `&#${string};`; // e.g. '🎨'
  readonly description: string; // e.g. '🎨 Art'
  readonly name: string;       // e.g. 'art'
  readonly semver: 'patch' | 'minor' | 'major' | null;
  readonly code: `:${string}:`; // e.g. ':art:'
}