question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

`no-warning-comments` should include the comment itself in the report (UX only)

See original GitHub issue

I think the point of this rule is to keep track of TODO comments, however this is hard to follow; I’d have to open each file separately to see if I can handle a task.

  source/globals.d.ts:1:1
  ⚠    1:1   Unexpected todo comment.                                                                   no-warning-comments
  ⚠    2:1   Unexpected todo comment.                                                                   no-warning-comments

  source/libs/post-form.ts:9:3
  ⚠    9:3   Unexpected todo comment.                                                                   no-warning-comments

  source/features/hidden-review-comments-indicator.tsx:37:2
  ⚠   37:2   Unexpected todo comment.                                                                   no-warning-comments

  source/features/revert-file.tsx:89:4
  ⚠   89:4   Unexpected todo comment.                                                                   no-warning-comments

What rule do you want to change?

no-warning-comments

Does this change cause the rule to produce more or fewer warnings?

Unchanged. It’s only about UX

How will the change be implemented? (New option, new default behavior, etc.)?

New default

What does the rule currently do for this code?

Shown above

What will the rule do after it’s changed?

  source/globals.d.ts:1:1
  ⚠    1:1   FIXME: Drop ignore after #9.                                                                  no-warning-comments
  ⚠    2:1   FIXME: Find this info on the page.                                                                   no-warning-comments

  source/libs/post-form.ts:9:3
  ⚠    9:3   TODO: Improve JSX types for event listeners so we can use... [clipped]                                                                   no-warning-comments

  source/features/hidden-review-comments-indicator.tsx:37:2
  ⚠   37:2   TODO: Drop some definitions when their related bugs are resolved                                                                   no-warning-comments

  source/features/revert-file.tsx:89:4
  ⚠   89:4   TODO: Drop `as` after https://github.com/microsoft/TSJS-lib-generator/issues/741                                                                   no-warning-comments

Issue Analytics

  • State:closed
  • Created 4 years ago
  • Reactions:13
  • Comments:13 (13 by maintainers)

github_iconTop GitHub Comments

3reactions
g-planecommented, Sep 27, 2019

I’ll champion this.

1reaction
g-planecommented, Jul 21, 2020

Sure. Feel free to do it.

Read more comments on GitHub >

github_iconTop Results From Across the Web

UX, now what? Why your report needs impact and how to ...
If we're not careful, our UX reports contain too much data and not enough consequence. Simon Jones explores his experience delivering reports and...
Read more >
Display your results more effectively: Tips from a UX Designer
Here are a few tips on creating better dashboards and web reports, ... it should also provide a manageable foundation for the report...
Read more >
First Rule of Usability? Don't Listen to Users
Summary: To design the best UX, pay attention to what users do, not what they say. Self-reported claims are unreliable, as are user...
Read more >
The 10 UX Deliverables Top Designers Use - Toptal
Regardless of the environment, UX professionals need a set of deliverables to help facilitate communication, document work, and provide artifacts.
Read more >
What is Usability - The Ultimate Guide | IxDF
According to the Nielsen Norman Group—a leader in the UX field—usability is the ... Error Tolerance—It supports a range of user actions and...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found