Good code is its own best documentation. — Steve McConnell

Enforce variable names to include their type (declare-keyword)

💼 This rule is enabled in the following configs: 🌐 all, ✅ recommended.

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

📖 Rule details

Don't you hate it when you're unsure whether you can mutate a variable because it's declared with const, or if you're dealing with a class that can be instantiated?

By prefixing the variable name with its type, you can easily avoid these confusions and have a clearer understanding of your code at a glance.

⚙️ Options

side

_{(default: natural)}

• start - the type must be at the start of the variable name
• end - the type must be at the end of the variable name
• natural - the type must be at the natural position of the variable name (start for consts, end for classes, etc.)

oneLetter

_{(default: false)}

If true, the type must be a single letter (e.g. cName for a const, eName for an enum, etc.). Classes get k, not to be confused with consts.

🔧 Config

{ rules: { 'ninja/declare-keyword': [2, { side: 'start', oneLetter: false }] } }

🔗 See also

• Enforce that interface names do not begin with an I
• Require that interface names be prefixed with I

🧑‍💻 Demo