Fix abbreviation casing issues #254
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Reviewer's Guide by SourceryThis pull request addresses casing and formatting inconsistencies in headings across multiple MDX files. It updates the Updated class diagram for format-headings.tsclassDiagram
class format-headings.ts {
<<file>>
+restoreAbbreviations()
+toSentenceCase(text: string): string
+processLine(line: string): string
}
note for format-headings.ts "The toSentenceCase function now removes any remaining asterisks instead of handling markdown formatting."
note for format-headings.ts "The processLine function now uses a regex to handle all numbering patterns, but preserve existing formatting."
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @gyan-sharma - I've reviewed your changes - here's some feedback:
Overall Comments:
- The changes look good, but the regular expression in
format-headings.tscould be simplified. - Consider adding a test case for the
format-headings.tsfile to ensure the logic works as expected.
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Review instructions: all looks good
- 🟢 Testing: all looks good
- 🟡 Complexity: 1 issue found
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| } | ||
|
|
||
| // Function to process a single line | ||
| function processLine(line: string): string { |
There was a problem hiding this comment.
issue (complexity): Consider extracting heading parsing and reconstruction into helper functions to simplify the processLine function and improve readability and testability without altering functionality.
Consider extracting the heading parsing and reconstruction into small helper functions. This breaks the complexity in processLine down into focused responsibilities, making the code easier to read and test without altering functionality.
For example, you can start by creating a helper to parse headings:
function parseHeading(line: string) {
const headingRegex =
/^(#{1,6})\s*(\*\*)?(?:(\d{1,2}\.(?:\d{1,2})?)\.\s*)?([a-zA-Z].*?)(\*\*)?$/;
const match = line.match(headingRegex);
if (!match) return null;
const [_, hashes, startBold, numbers, content, endBold] = match;
return { hashes, startBold, numbers, content, endBold };
}Then refactor processLine to delegate parsing and formatting:
function processLine(line: string): string {
if (!line.startsWith("#")) {
return line;
}
const parsed = parseHeading(line);
if (!parsed) return line;
const { hashes, startBold, numbers, content, endBold } = parsed;
const processedContent = content.charAt(0).toUpperCase() + content.slice(1);
const header = numbers ? `${hashes} ${numbers}. ` : `${hashes} `;
if (startBold) {
return header + startBold + processedContent + (endBold || "**");
}
return header + processedContent;
}This approach reduces nesting and makes each part easier to manage.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary by Sourcery
Fix abbreviation and casing issues in documentation and code formatting
Enhancements:
Documentation: