Unpack todo/warning comments

[jamestalmage]

Show the warning comments right in the terminal.

Also, will truncate all messages now based on terminal width.
For unpacked warning comments, will drop the ruleId before truncating.

Fixes: #27

[jamestalmage]

Truncates messages according to terminal width.

Will drop the ruleId for no-warning-comments to display more of the message.

[sindresorhus]

The .source property is not always in the result:

{ ruleId: 'no-warning-comments',
  severity: 1,
  message: 'Unexpected \'todo\' comment.',
  line: 197,
  column: 61,
  nodeType: 'Line',
  endLine: 197,
  endColumn: 118 }

From linting: https://github.com/avajs/ava/blob/c3bcbf2a568c12017fe0da041dc247a226019001/lib/babel-pipeline.js#L197

[jamestalmage]

The .source property is not always in the result:

Interesting. Is there a rhym or reason to that? Should we try to recover the comment in that case?

feedback incorporated

[sindresorhus]

Seems you're using an undocumented property. The .source property is documented to be on the result object, not the message object: https://eslint.org/docs/developer-guide/working-with-custom-formatters#the-result-object

[sindresorhus]

Also note:

source: The source code for the given file. This property is omitted if this file has no errors/warnings or if the output property is present.
- https://eslint.org/docs/developer-guide/working-with-custom-formatters#the-result-object

So if there's no .source, try .output.

[sindresorhus]

Confirmed: eslint/eslint@27e3f24

[jamestalmage]

Oh crap.
I guess I should have at least attempted to read documentation.

Unfortunately, our existing test fixtures don't have what I need to test this properly.

I've got a busy next week and a half, but I'll try to get to it next weekend.

Come on GitHub. We need reminders!

[sindresorhus]

Come on GitHub. We need reminders!

Agreed! For now, you can go to https://github.com/notifications/read, find the notification for this issue, and click "Save for later". Or click "Mark as unread" here if you use Refined GitHub.

[sindresorhus]

Ping :)

(If you're busy, no worries. Just pinging in case you just forgot about it)

[sindresorhus]

Closing in favor of sindresorhus/eslint-plugin-unicorn#401. Better and easier to fix the rules instead.