Google style indentation

[thernstig]

Motivation

Indentation matters for readability, especially having a consistent indentation of documentation. I want to be able to use google style indentation for @parameter and @return as an example.

Current behavior

This might be part of check-indentation but I could not get it work with it.

Desired behavior

I want this to be invalid:

  /**
   * Do something.
   *
   * @param {string} fooA - Some text
   * @param {string} fooB - If defined, it foos
   * a lot all day long.
   */

I want this to be valid (with the new rule)

  /**
   * Do something.
   *
   * @param {string} fooA - Some text
   * @param {string} fooB - If defined, it foos
   *     a lot all day long. // This has been double-indented (4 spaces, we use 2 spaces for indents)
   */

This is called google style indent. It makes it easier to read the documentation.

---

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

[thernstig]

@brettz9 Is this hard to get in place? 😄

[brettz9]

I don't think it would be too hard, especially on its own, but I think we'd want to integrate it into check-line-alignment, so that there would not be inconsistencies. We could avoid forcing users to use that rule's never or always options, while still enforcing a specific indent. Haven't been feeling too well, so not sure about implementing, unfortunately...

[thernstig]

@brettz9 ok I hope you are feeling ok soon!

[brettz9]

@thernstig : Would you mind taking #964 for a spin to see if it works well for you?

[github-actions]

🎉 This issue has been resolved in version 40.0.0 🎉

The release is available on:

• GitHub release
• npm package (@latest dist-tag)

Your semantic-release bot 📦🚀