Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: Vitepress codeInContextPlugin #1668

Merged
merged 8 commits into from
Jan 26, 2024

Conversation

Torres-ssf
Copy link
Contributor

@Torres-ssf Torres-ssf commented Jan 19, 2024

This Pull Request introduces a refactor of the Vitepress codeInContextPlugin. The motivation for this refactor is to improve code readability and maintainability.

This has been done by splitting the plugin's code into smaller functions. Additionally, comments were added throughout the code for a better understanding of its operation.

A test suite was also added.

@Torres-ssf Torres-ssf added docs Requests pertinent to documentation chore Issue is a chore labels Jan 19, 2024
@Torres-ssf Torres-ssf added this to the 2 - Beetle milestone Jan 19, 2024
@Torres-ssf Torres-ssf self-assigned this Jan 19, 2024
Copy link
Contributor

github-actions bot commented Jan 19, 2024

Coverage report

St.
Category Percentage Covered / Total
🟢 Statements
86.96% (+0.05% 🔼)
6188/7116
🟡 Branches
71.05% (+0.15% 🔼)
972/1368
🟡 Functions
78.07% (+0.12% 🔼)
1018/1304
🟢 Lines
86.93% (+0.05% 🔼)
5927/6818
Show new covered files 🐣
St.
File Statements Branches Functions Lines
🟢
... / codeInContextPlugin.ts
100% 100% 100% 100%

Test suite run success

1498 tests passing in 264 suites.

Report generated by 🧪jest coverage report action from 7f10801

Copy link
Member

@arboleya arboleya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀

@petertonysmith94
Copy link
Contributor

V Nice ❤️

Copy link
Contributor

@danielbate danielbate left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit:

@Torres-ssf Torres-ssf enabled auto-merge (squash) January 24, 2024 15:46
@Torres-ssf Torres-ssf merged commit 2aed04d into master Jan 26, 2024
11 checks passed
@Torres-ssf Torres-ssf deleted the st/refactor/code-in-context-plugin branch January 26, 2024 09:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Issue is a chore docs Requests pertinent to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants