Prettier lint results #415
Conversation
Added carrot back
# Conflicts: # package-lock.json # package.json
There was a problem hiding this comment.
Thanks for your wonderful work!
Using Step Summary to display Lint results looks like a great idea.
However, I think that Annotation and Summary have different purposes.
Annotation is excellent for confirming remarks in review.
Since there are different use cases, I think it is better to support to each method.
src/report/lint-report.ts
Outdated
| idData.summary, | ||
| `${getSeverityIcon(idData)}` | ||
| ]) | ||
| const nameLink = `<a id="${lintSlug.id}" href="${baseUrl + lintSlug.link}">${idData.summary}</a>` |
There was a problem hiding this comment.
I feel it is redundant to insert Explanation into Summary.
There was a problem hiding this comment.
🤷♂️ I thought it was nice to have in the markdown, as it has a more detailed explanation than just the "summary" text you normally see, but to each his own. I was basically following the format of the lint html file that gets generated when running lint (more or less). I suppose it could be an optional thing.
I was originally just doing this work for myself, but when I was done, figured I would offer this up to you for PR (otherwise I wouldn't have changed the main run function like I did here). Let me know if you would like me to make any changes. |
I wasn't happy with what github annotations gives you (especially the limit of 10!), so I went ahead and implemented a new way to display the results, which creates markdown. This has a limitation as well (65k), but its much better than the annotations. This is quite a large change, so I understand if you don't want to bother. I got it done and working, so I figured I would offer it up.
Summary Example:
Lint issue Example: