"A picture is worth a thousand words."

Require variables and properties to be named using emojis (prefer-emoji)

💼⚠️ This rule is enabled in the 🌐 all config. This rule warns in the ✅ recommended config.

🔧 This rule is automatically fixable by the --fix CLI option.

📖 Rule details

Emojis convey complex ideas succinctly and are universally recognized. Using them as variable names enhances code clarity and expressiveness. Unfortunately, the Javascript ecosystem doesn't embrace this potential as emojis can't be used as variable names.

💡 Examples

Check all

// ❌ Incorrect
if (a) {
  b = c
  return foo(d, {
    e: f,
    g: h,
  })
}

// ✅ Correct
if (🍪) {
  ⛺️ = 🧲
  return 🐷️(🤹, {
    🦄: 🍭,
    🌺: 🙈,
  })
}

Check properties only

// ❌ Incorrect
if (a) {
  b = c
  return foo(d, {
    e: f,
    g: h,
  })
}

// ✅ Correct
if (a) {
  b = c
  return foo(d, {
    🦄: f,
    🌺: h,
  })
}

⚙️ Options

See eslint-plugin-unicorn/prevent-abbreviations, which this rule is copied from.

checkDefaultAndNamespaceImports

checkFilenames

checkProperties

checkShorthandImports

checkShorthandProperties

checkVariables

ignore

replacements

🔧 Config

{ rules: { 'ninja/prefer-emoji': 2 } }

🧑‍💻 Demo