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.

Add a specific panel for TODO-style comments

See original GitHub issue

Other editors have a panel for TODO comments to keep them out of the normal Problems view. VS Code doesn’t, so some languages (including Dart) are providing them as Diagnostics.

Some users use generic TODO extensions that search across text. These might not be as accurate as those provided by a language server because they don’t understand the syntax (they’re also duplicating work by reading every file searching for TODOs).

Because language extensions can’t rely on users having TODO extensions, they might still produce diagnostics, giving the users duplicates (in their TODO extension and in Problems).

It seems like the best solution would be for VS Code to have some native concept for TODOs. This could be new, or it could simple be a new Diagnostic type, which can be filtered out of Problems and shown in another window (this reduces the need for new APIs, adding only a new diagnostic kind).

Having a seperate pane would also allow for seperate search/filters. For example in many repositories it’s common to use TODO(myname): as a prefix. Being able to filter to myname in a TODO pane (to avoid seeing other users TODOs) without also hiding all the errors/warnings would be very useful.

Issue Analytics

  • State:open
  • Created a year ago
  • Reactions:58
  • Comments:5 (1 by maintainers)

github_iconTop GitHub Comments

9reactions
VSCodeTriageBotcommented, Oct 8, 2022

🙂 This feature request received a sufficient number of community upvotes and we moved it to our backlog. To learn more about how we handle feature requests, please see our documentation.

Happy Coding!

7reactions
timsneathcommented, Sep 30, 2022

Just adding support here. TODO items are similar to Github Issues: they’re a representation of a backlog. Problems/Errors/Warnings aren’t a backlog: they’re immediate feedback on the current task at hand. If there’s anything in the problems window, I really should fix that before I can proceed. It would be nice to keep these two separate.

Read more comments on GitHub >

github_iconTop Results From Across the Web

TODO comments | IntelliJ IDEA Documentation - JetBrains
IntelliJ IDEA lets you add special types of comments that are highlighted in the editor, indexed, and listed in the TODO tool window....
Read more >
A LaTeX Editor Feature Requests - TeXstudio - SourceForge
I would personally prefer having the task list in the log panel, but it would be ok anywhere, as a preview replacement or...
Read more >
Collaborating in Real Time through the Comments Panel in ...
The panel allows all users who are working on the document to add comments and view all comments without actually modifying the document...
Read more >
Working with Onscreen Data in a Flutter Application | Google Cloud ...
Copy the Flutter Live Server address from the lab Panel ... Note: The onTap method is updated to add comment lines on the...
Read more >
RGB LED Pixel Touch Sensitive Games Table – Part 2
As you cannot create all your code in one go I like to use the Flowcode comment icon to add in simple TODO...
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