no-undefined-references: Add GFM table support #326
Conversation
github-actions
bot
added
👋 phase/new
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #326 +/- ##
===========================================
Coverage 100.00% 100.00%
===========================================
Files 72 88 +16
Lines 14745 21184 +6439
===========================================
+ Hits 14745 21184 +6439 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
| ```text | ||
| 1:16-1:26: Unexpected reference to undefined definition, expected corresponding definition (`header 2`) for a link or escaped opening bracket (`\[`) for regular text | ||
| 3:16-3:21: Unexpected reference to undefined definition, expected corresponding definition (`bar`) for a link or escaped opening bracket (`\[`) for regular text | ||
| ``` |
There was a problem hiding this comment.
Docs and tests are generated from the code.
The docs you wrote will be automatically changed.
You can remove the manual test.
And turn this, what you added manually in the docs, into an actual test, see the code: at the top of the index.js file, there are examples.
Please then run the npm scripts provided by this package. Thank you
There was a problem hiding this comment.
Thanks, didn't realise this. I did think the coverage of the rule was low, makes sense that the examples (docs) are the tests! Fixed in 5fa9f25.
| * | ||
| * [Neptune][neptune][more] is the eighth and farthest planet from the Sun. | ||
| * | ||
| * - [Pluto], once considered the ninth planet, is now classified as a [dwarf planet][Pluto]. |
There was a problem hiding this comment.
I've undone it. I was trying to cover lists, but probably unnecessary
| * | [Planet] | [Radius] | | ||
| * |---------------------|------------| | ||
| * | [Mercury] | 2,439.7 km | | ||
| * | [Venus][venus-docs] | 6,051.8 km | | ||
| * | [Earth] | 6,378 km | | ||
| * | ||
| * [Planet]: https://example.com/planet/ | ||
| * [Mercury]: https://example.com/mercury/ | ||
| * [Venus]: https://example.com/venus/ |
There was a problem hiding this comment.
All other tests are as minimal as can be. Is it needed to be this big, this many references? Or can it be smaller. Such as:
| * | [Planet] | [Radius] | | |
| * |---------------------|------------| | |
| * | [Mercury] | 2,439.7 km | | |
| * | [Venus][venus-docs] | 6,051.8 km | | |
| * | [Earth] | 6,378 km | | |
| * | |
| * [Planet]: https://example.com/planet/ | |
| * [Mercury]: https://example.com/mercury/ | |
| * [Venus]: https://example.com/venus/ | |
| * | [Planet] | [Radius] | | |
| * | ----------------- | --------- | | |
| * | Mercury | 2439.7 km | | |
| * | |
| * [planet]: https://example.com/planet/ |
(Also some small changes such as padding and no casing in definition ID, which are the more common used styles in these projects!)
There was a problem hiding this comment.
I've simplified to almost this, with an extra link to Mercury to cover table cells (as well as headers)
This comment has been minimized.
This comment has been minimized.
|
Released in |
3 participants
Initial checklist
Description of changes
Resolves #325 by running the existing logic inside
tableCell, plus tests