search

haberdashPI / vscode-master-key

Master your keybindings with documentation, discoverability, modal bindings, macros and expressive configuration
Other
7 stars 1 forks source link

Fix bug in markdown documentation generation #8

Closed haberdashPI closed 2 months ago

haberdashPI commented 2 months ago

Release 0.2.0 had a bug in the final implementation that was not caught by unit tests, but did show up for Larkin. This bug removed all binding tables from Larkin's markdown documentation. The root cause was that the older implementation assumed all bindings would be provided in the order of their index, which was not the case. They are sorted by priority.

This PR implements moves to an easier to follow implementation that 1.) indexes all resolved bindings by their index and 2.) includes an index field for documentation bindings. We can get then straightforwardly match resolved bindings to documentation bindings.

codecov[bot] commented 2 months ago

Codecov Report

Attention: Patch coverage is 85.71429% with 3 lines in your changes missing coverage. Please review.

Project coverage is 75.58%. Comparing base (3243ffd) to head (c87beae). Report is 1 commits behind head on main.

Files Patch % Lines
src/web/keybindings/processing.ts 84.61% 1 Missing and 1 partial :warning:
src/web/keybindings/docParsing.ts 87.50% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #8 +/- ## ========================================== + Coverage 75.20% 75.58% +0.38% ========================================== Files 24 24 Lines 2210 2216 +6 Branches 442 442 ========================================== + Hits 1662 1675 +13 + Misses 374 370 -4 + Partials 174 171 -3 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.