Comments get lost when generating annotations

Question

Comments get lost when generating annotations

Opened this issue 2 years ago · 7 comments

cmer commented 2 years ago

When there are already comments above a class definition, AnnotateModels deletes them when regenerating annotations.

Here's a short video showing the issue: https://cln.sh/Iw7NsPk7yEfmkyPWtIim

Version

annotate version: 3.2
rails version: 5.2.6.2
ruby version: 2.7.5

Answer 1 · 2022-07-05T21:20:59.000Z

running into this as well

Answer 2 · 2022-07-29T12:30:38.000Z

It works to add a blank line above the comment before annotating, but you need to find them first (I spotted it accidentally when reviewing a PR).

Answer 3 · 2022-07-29T12:33:27.000Z

Yes but obviously nobody remembers to do that on a large team :)

…

On Jul 29, 2022, 8:30 AM -0400, alexeyr-ci1 ***@***.***>, wrote: It works to add a blank line above the comment before annotating, but you need to find them first (I spotted it accidentally when reviewing a PR). — Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you authored the thread.Message ID: ***@***.***>

Answer 4 · 2022-07-29T16:35:49.000Z

Sorry, it's actually worse than I thought. It looked like it worked only because the comment wasn't getting regenerated. If I use --force (or do a schema change which forces a regeneration), then the first time eats the empty line and leaves the comment intact (so really hard to note in code review), and the next time eats the comment 🤣.

Answer 5 · 2024-01-22T13:46:52.000Z

Is there a workaround for this?

Answer 6 · 2024-02-17T16:55:54.000Z

Hey folks, I believe I was able to solve this bug in my gem drwl/annotaterb#72

Answer 7 · 2024-02-17T19:54:11.000Z

I wasn't aware of the fork. I'll definitely check it out. Thanks!