fix(check-line-alignment): avoid adding whitespace if hyphen at end of line

[brettz9]

fixes #983

[github-actions]

🎉 This PR is included in version 39.9.1 🎉

The release is available on:

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

Your semantic-release bot 📦🚀

[thernstig]

@brettz9 thank you for looking into this.

I tested this and the bug fix did not work. Did you test it and it removed the white-space for you?

Here is another example where it does not complain about the white-space at the end of line when it should (notice the - ):

  /**
   * Flat selectedFiles to an array.
   *
   * @returns {{ nodeType: string, startDate: Date, fileName: string }[]} - 
   * list of selected files, ascending sorted by startDate
   */

[brettz9]

The issue you reported that this fixes, and which this PR adds a test case for, is that a terminal hyphen will no longer get whitespace added to it.

What you are mentioning now is an opposite issue where whitespace is already present and you want it removed. I guess we could handle that too, but that is really a separate issue.

[thernstig]

@brettz9 my issue was about that it added a whitespace.

We had this at 39.6.4:

   * @param {string|string[]|TemplateResult|TemplateResult[]} event.detail.description -
   *    Notification description

It turned it into this at 39.8.0 when running --fix:

   * @param {string|string[]|TemplateResult|TemplateResult[]} event.detail.description - 
   *    Notification description

I also tried 39.9.1 and using --fix again made no change, it made it still look like the last one above with the added white space.

The rationale for reporting this is that it breaks Prettier and many other linters/formatters that remove spaces at end of line.

EDIT:

Or I see now what is going on here. I did the upgrade to 39.8.0 and applied the --fix. It added a whitespace after the terminal hyphen.

I then upgraded to 39.9.1 and ran --fix and it never removed the hyphen.

So in a sense yes, you are absolutely correct there. In my unlucky streak of upgrades I ended up with a trailing whitespace. So I suppose removing a trailing whitespace should also happen then possibly. Up to you of course.