Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Highlight TODO and FIXME. #2634

Closed
MickaToast opened this issue Dec 18, 2019 · 11 comments
Closed

Highlight TODO and FIXME. #2634

MickaToast opened this issue Dec 18, 2019 · 11 comments

Comments

@MickaToast
Copy link

MickaToast commented Dec 18, 2019

Would be nice to have a way to easily find/see TODO and FIXME written in files.

i.e: See if a Pull Request stills contain new TODO/FIXME.

@sindresorhus
Copy link
Member

Can you elaborate more on how you imagine it would look? For example, would TODO comments be bolded or something.

@fregante
Copy link
Member

It could also be shown in #2579, e.g. "This PR adds 2 TODOs" but it would require a fetch of all the changes, which might be heavy (or heavy PRs could be excluded, if possible)

@MickaToast
Copy link
Author

MickaToast commented Dec 19, 2019

Can you elaborate more on how you imagine it would look? For example, would TODO comments be bolded or something.

Not sure here what could be the best, either write it somewhere to show the total added TODO, or something like this:

Capture d’écran 2019-12-19 à 14 24 30

Maybe also make it available in header of file description:
Capture d’écran 2019-12-19 à 14 39 30
And on view changes from PR:
Capture d’écran 2019-12-19 à 14 41 37

And finally in the code highlight the TODOs

@Zeko369
Copy link

Zeko369 commented Dec 19, 2019

Maybe also show FIXMEs

@MickaToast
Copy link
Author

Maybe also show FIXMEs

Indeed, will change the title

@MickaToast MickaToast changed the title Highlight TODOs. Highlight TODO and FIXME. Dec 20, 2019
@fregante
Copy link
Member

fregante commented Aug 8, 2020

Note: I think eslint can automatically show this information inline as GitHub annotations. Example:

Screen Shot 2020-04-18 at 12 13 32

Hopefully XO will soon too. xojs/xo#465

@ocarreterom
Copy link
Contributor

ocarreterom commented Oct 25, 2020

What do you think about something like this?

Captura de pantalla 2020-10-25 a las 19 37 02 2

Captura de pantalla 2020-10-25 a las 19 37 02

@fregante
Copy link
Member

fregante commented Oct 26, 2020

Too complex, plus that line is already super crowded and we had to disable a feature on it already.

On the files tab, I think XO or eslint already takes care of that via GitHub Actions annotations.

On the Conversation tab it would be useful to show this piece of information before the Mergeability box as suggested. I wonder if it’s useful to just show a compact list of GitHub annotations as a generic feature.

@MickaToast
Copy link
Author

MickaToast commented Oct 26, 2020

Not sure what's actually the idea behind the project, but handling features via Github Actions (or any other CI application) would add some restrictions to the project. For instance, I don't use and don't intend to use Github Actions, such features wouldn't be accessible to me if it's handled this way.

@fregante
Copy link
Member

Indeed. Adding this piece of information is actually not too difficult on the Files tab since the content is already there; the problem is finding a way to place it other than inline/per-file like you showed in your mockup in December.

Perhaps this feature can initially be just that since it doesn’t require any API calls.

@fregante
Copy link
Member

Tracked in #2579

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

5 participants