"The end may justify the means as long as there is something that justifies the end." — Leon Trotsky

Enforce comments explaining code (justify)

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

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

📖 Rule details

Every line of code should be accompanied by a comment. Not all readers possess the same experience or context as you. Well-placed comments can save hours for both future you and others, aiding in faster comprehension.

💡 Examples

// ❌ Incorrect
if (a) {
  b = c

  function foo(d) {
    e = f
  }
}

// ✅ Correct
// if a
if (a) {
  // then assign c to b
  b = c

  // define foo
  function foo(d) {
    // assign f to e
    e = f
  }
}

🔧 Config

{ rules: { 'ninja/justify': 2 } }

🔗 See also

• justify2

🧑‍💻 Demo