Document that eofline fix is not supported for single-line files.

[mxl]

PR checklist

• Addresses an existing issue: Autofix file should end with a newline #2186
• New feature, bugfix, or enhancement
  • Includes tests
• Documentation update

Overview of change:

I think we should clearly state that eofline fix is not supported for single-line files. It's not obvious without inspecting source code and looks like bug.

[palantirtech]

Thanks for your interest in palantir/tslint, @mxl! Before we can accept your pull request, you need to sign our contributor license agreement - just visit https://cla.palantir.com/ and follow the instructions. Once you sign, I'll automatically update this pull request.

[ajafff]

@mxl There are several rules that don't fix all violations and none of them state that explicitly. For example prefer-const doesn't fix uninitialized variables, align doesn't fix if it would remove code, ....

IMO this shouldn't be included in description or FAILURE_STRING. If you really want to have this documented, I'd suggest adding it to Rule.metadata.descriptionDetails.

[mxl]

@ajafff That's not good if rule says that it can fix some violation but in certain cases it does not do this and that's not documented anywhere. I will add this to descriptionDetails. Any suggestions on how can I improve it?

[adidahiya]

this looks fine; it's the best we can do for now; autofixing will never be perfect or address all scenarios