Skip to content

Intevel/convert-gitmoji

Folders and files

NameName
Last commit message
Last commit date

Latest commit

1b9510e · Jan 25, 2024

History

44 Commits
Jun 27, 2022
Jan 25, 2024
Jul 4, 2022
Jun 25, 2022
Jun 25, 2022
Jul 4, 2022
Jun 26, 2022
Jun 25, 2022
Jan 25, 2024
Jun 25, 2022
Jun 25, 2022
Jul 8, 2022
Jan 25, 2024
Jul 4, 2022
Nov 6, 2022

Repository files navigation

convert-gitmoji

npm version npm downloads Github Actions CI License

Simple way to replace strings with gitmojis ♻️

Install

# Using npm
npm install convert-gitmoji

# Using yarn
yarn add convert-gitmoji

Usage

convert(content: string, withSpace?: boolean | "leading" | "trailing" | "both")

Convert all gitmojis in a string withSpace is default false, if true its sets a trailing (at the end of the string) whitespace after the converted gitmoji.

For more control, withSpace can also be set to leading for a whitespace before the string, trailing for a whitespace at the end of the string (same as true) or both to have the string surrounded by whitespaces.

// CommonJS
const { convert } = require("convert-gitmoji");

// ESM
import { convert } from "convert-gitmoji";

convert(':arrow_up: bump qs from 6.10.3 to 6.10.4 (xxx) - **helper:** :pencil:  Updated TSDoc (xxx)', true);

--> "⬆️ bump qs from 6.10.3 to 6.10.4 (xxx) - **helper:** ✏️ Updated TSDoc (xxx)"

convert("This:art:is on:fire:!")

--> "This🎨is on🔥!"

convert("This:art:is on:fire:!", "both")

--> "This 🎨 is on 🔥 !"

License

Published under MIT - Made with ❤️ by Conner Luka Bachmann