Add lines alignment rule

[renatho]

The PR

When developing for WordPress, there is a recommended standard to have the comment lines aligned.

Some days ago, we created an Eslint rule for that: https://github.com/Automattic/eslint-plugin-jsdoc-alignment/
It was created with the purpose to start using it and soon submit a contribution to add it to the eslint-plugin-jsdoc, which makes much more sense.

If this PR is approved, the current eslint-plugin-jsdoc-alignment will be deprecated in favor of this rule.

It's my first contribution to eslint-plugin-jsdoc, so I'm sorry if I missed something. But I'll be happy to fix anything if needed.

Example

❌ Incorrect example:

/**
 * Function description.
 *
 * @param {string} lorem Description.
 * @param {int} sit Description multi words.
 */
const fn = ( lorem, sit ) => {}

✅ Correct example:

/**
 * Function description.
 *
 * @param {string} lorem Description.
 * @param {int}    sit   Description multi words.
 */
const fn = ( lorem, sit ) => {}

[brettz9]

Besides my comments, this looks good to me from an initial look.

It would be ideal if we could in the future instead use comment-parser for obtaining the tag, name, and description with whitespace, but comment-parser doesn't currently support that, so regexes should work for now.

If you could make the changes per the comments, I can see about taking a closer look locally. Thanks a lot!

[renatho]

@brettz9, thank you for your first review! I still need to change a little my last commit to having the full coverage, but I already pushed, so you can see the other changes for now! 😉

[brettz9]

One important and one minor change, though both small and easy-to-change.

All the other recent changes look great.

[brettz9]

And this one too if you wouldn't mind--forgot there was this...

[renatho]

@brettz9 I updated the never temporary warning to be a report instead of a throw. Do you think it makes sense? 38b8b9d

At some point in the future, I'll try to implement the never too. It's easier than the current check. 🙂

[gajus]

🎉 This PR is included in version 30.5.0 🎉

The release is available on:

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

Your semantic-release bot 📦🚀

[brettz9]

Yes, you are correct, it should have been report.

And my apologies, I've just now quickly renamed the rule to check-line-alignment, as a "fix" (line being a generic adjective here). Thought I had merged that version, but hadn't pushed to the branch. I also included the docs in the main README template, removing the need for including the examples (since we auto-generate those from tests).