-
Notifications
You must be signed in to change notification settings - Fork 6
feat: update title capitalization rules #318
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
Open
jwalterss
wants to merge
2
commits into
main
Choose a base branch
from
HNT-682-capitalization-rules-cleanup
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -56,7 +56,10 @@ export const sanitizeText = (input: string, maxLength: number): string => { | |
| export const lowercaseAfterApostrophe = (input: string): string => { | ||
| // Match either an ASCII or curly apostrophe followed by a letter, after a word character. | ||
| const regex = /(?<=\w)(['\u2018\u2019])(\w)/g; | ||
| return input.replace(regex, (_, apostrophe, letter) => `${apostrophe}${letter.toLowerCase()}`); | ||
| return input.replace( | ||
| regex, | ||
| (_, apostrophe, letter) => `${apostrophe}${letter.toLowerCase()}`, | ||
| ); | ||
| }; | ||
|
|
||
| /** | ||
|
|
@@ -89,22 +92,65 @@ export const applyApTitleCase = (value: string): string => { | |
|
|
||
| const result = allWords | ||
| .map((word, index, all) => { | ||
| // Check if the previous non-empty element is a sentence-ending punctuation | ||
| const isAfterSentenceEnd = | ||
| index > 0 && | ||
| (() => { | ||
| // Look for the previous non-empty element | ||
| for (let i = index - 1; i >= 0; i--) { | ||
| const prev = all[i].trim(); | ||
| if (prev) { | ||
| // Check if it ends with sentence-ending punctuation | ||
| return ( | ||
| /[.!?]$/.test(prev) || | ||
| // Or if it's a closing quote after sentence-ending punctuation | ||
| (i > 0 && | ||
| (prev === '"' || | ||
| prev === '\u201D' || | ||
| prev === "'" || | ||
| prev === '\u2019') && | ||
| /[.!?]$/.test(all[i - 1].trim())) | ||
| ); | ||
| } | ||
| } | ||
| return false; | ||
| })(); | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Not totally sure, but I think this for loop might be replaced with a regex. Here's what ChatGPT suggests: We may also want to cover cases where the quote is after the punctuation:
|
||
|
|
||
| const isAfterColon = index > 0 && all[index - 1].trim() === ':'; | ||
|
|
||
| const isAfterQuote = | ||
| index > 0 && | ||
| (allWords[index - 1] === "'" || | ||
| allWords[index - 1] === '"' || | ||
| allWords[index - 1] === '\u2018' || // Opening single quote ’ | ||
| allWords[index - 1] === '\u201C'); // Opening double quote “ | ||
| allWords[index - 1] === '\u2018' || // Opening single quote ' | ||
| allWords[index - 1] === '\u201C'); // Opening double quote " | ||
|
|
||
| // Special case handling for specific words | ||
| const lowerWord = word.toLowerCase(); | ||
|
|
||
| // Handle iPhone | ||
| if (lowerWord === 'iphone') { | ||
| return 'iPhone'; | ||
| } | ||
|
|
||
| // Handle vs. | ||
| if (lowerWord === 'vs.' || lowerWord === 'vs') { | ||
| return 'vs.'; | ||
| } | ||
|
|
||
| // Check if we should capitalize this word | ||
| if ( | ||
| index === 0 || // first word | ||
| index === all.length - 1 || // last word | ||
| isAfterColon || // capitalize the first word after a colon | ||
| isAfterQuote || // capitalize the first word after a quote | ||
| !stop.includes(word.toLowerCase()) // not a stop word | ||
| isAfterSentenceEnd || // capitalize after sentence-ending punctuation | ||
| (!stop.includes(lowerWord) && lowerWord !== 'as') // not a stop word and not 'as' | ||
| ) { | ||
| // Special handling for 'a' and 'the' after sentence-ending punctuation | ||
| if (isAfterSentenceEnd && (lowerWord === 'a' || lowerWord === 'the')) { | ||
| return capitalize(word); | ||
| } | ||
| return capitalize(word); | ||
| } | ||
|
|
||
|
|
||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.