docs: show red underlines in examples in rules docs #273
Conversation
✅ Deploy Preview for eslint-stylistic ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #273 +/- ##
=======================================
Coverage 99.79% 99.79%
=======================================
Files 114 114
Lines 26699 26699
Branches 4490 4490
=======================================
Hits 26645 26645
Misses 54 54 ☔ View full report in Codecov by Sentry. |
|
Very cool! 🔥 |
docs/package.json
Outdated
| @@ -4,23 +4,24 @@ | |||
| "private": true, | |||
| "scripts": { | |||
| "docs:dev": "vitepress dev", | |||
| "docs:build": "vitepress build", | |||
| "docs:build": "cd .. && pnpm run build && cd docs && vitepress build", | |||
There was a problem hiding this comment.
I modified the script so that it can be built with Netlify. There may be a better way than that.
|
That's a very interesting idea and I think it's even deserved to be a general transformer/integration similar to TwoSlash - where it could be possible to us as a part of tests as well. I'll think about the design a bit |
|
Made a few changes to Shiki core to make this easier, and now we have: 
Again, thanks for the amazing idea! Do you expect to use this in the docs of your other plugins? If so, we could make a package for it. |
Description
This PR implements ShikijiTransformer to indicate with a red marker where an error occurs in the example rules document.
Example:
Linked Issues
None.
Additional context
I would like to hear your opinion on displaying markers in documents.
This is my first time implementing ShikijiTransformer, so I'm still not sure if this PR will work.
I have submitted a PR to ESLint that does something similar.
eslint/eslint#18041
I would like to hear your opinion on the marker style.