gitmoji

mirror of https://github.com/carloscuesta/gitmoji.git synced 2025-12-08 20:14:12 +00:00

History

✨ Export gitmojis as CJS and ESM (#1280 )

* ➕ Install `unbuild` dependency
* 🚚 Rename `gitmojis.d.ts` to `index.d.ts`
* ✨ Export `cjs` and `esm` with `unbuild`
* 👷 Add `build` step to publish action
* 🔧 Add `gitmojis` build output to turborepo config
* 🔧 Add `build` as a dependency for `lint`, `tscheck` and `build`
* ✨ Add `assert { type: json }` for JSON imports
* 🧑‍💻 Watch changes on `gitmojis` to rebuild deps for website (#1282)

Co-authored-by: Vinícius Hoyer <contact@vhoyer.dev>

2023-01-18 19:33:43 +01:00

src

✨ Export gitmojis as CJS and ESM (#1280 )

2023-01-18 19:33:43 +01:00

.lintstagedrc.json

✨ Add schema to gitmojis (#1263 )

2023-01-13 19:26:48 +01:00

package.json

✨ Export gitmojis as CJS and ESM (#1280 )

2023-01-18 19:33:43 +01:00

README.md

🏗️ Transform project into a monorepo (#1235 )

2022-12-22 20:51:15 +01:00

README.md

About

The emojis from the gitmoji convention bundled into a node module.

Install

npm i gitmojis

Usage

import { gitmojis } from 'gitmojis'

console.log(gitmojis)

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

API

Alternatively you can also consume this as through HTTP using the API:

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

Spread the word

Are you using Gitmoji on your project? Set the Gitmoji badge on top of your readme using this code:

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