Skip to content

Commit

Permalink
Change order to ensure compound word check happens earlier
Browse files Browse the repository at this point in the history
  • Loading branch information
@ajayyy
ajayyy committed Dec 16, 2024
1 parent b881fce commit e6a4065
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 33 deletions.
63 changes: 33 additions & 30 deletions src/titles/titleFormatter.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -176,10 +176,35 @@ async function wordToTitleCase(word: string, index: number, words: string[], par
const trustCaps = shouldTrustCaps(mostlyAllCaps, words, index);

if (forceKeepFormatting(word)
|| (isCustom && isWordCustomCapitalization(word))
|| (!isAllCaps(word) && (isWordCustomCapitalization(word) || isNumberThenLetter(word)))
|| isYear(word)
|| (!isGreek && await greekLetterAllowed(word))) {
return word;
} else if (isCompoundWord(word)) {
// If this is hyphenated or dashed, run title case on it again
let result = "";
let newIndex = 0;

const wordsInWord = word.split(/([-/])/g);
const wordsArray = words.slice(0, index).concat(word.split(/[-/]/)).concat(words.slice(index + 1));
for (const wordInWord of wordsInWord) {
if (wordInWord.match(/[-/]/)) {
result += wordInWord;
} else {
result += await wordToTitleCase(wordInWord, index + newIndex, wordsArray, {
isCustom,
mostlyAllCaps,
isGreek,
isTurkiq,
isEnglish
});

newIndex++;
}
}

return result;
} else if ((isCustom && isWordCustomCapitalization(word))
|| (!isAllCaps(word) && (isWordCustomCapitalization(word) || isNumberThenLetter(word)))) {
// For custom titles, allow any not just first capital
// For non-custom, allow any that isn't all caps
return word;
Expand All @@ -193,33 +218,7 @@ async function wordToTitleCase(word: string, index: number, words: string[], par
// Trust it with capitalization
return word;
} else {
// If this is hyphenated or dashed, run title case on it again
if (word.match(/.-.|.\/./)) {
let result = "";
let newIndex = 0;

const wordsInWord = word.split(/([-/])/g);
const wordsArray = words.slice(0, index).concat(word.split(/[-/]/)).concat(words.slice(index + 1));
for (const wordInWord of wordsInWord) {
if (wordInWord.match(/[-/]/)) {
result += wordInWord;
} else {
result += await wordToTitleCase(wordInWord, index + newIndex, wordsArray, {
isCustom,
mostlyAllCaps,
isGreek,
isTurkiq,
isEnglish
});

newIndex++;
}
}

return result;
} else {
return await capitalizeFirstLetter(word, isTurkiq);
}
return await capitalizeFirstLetter(word, isTurkiq);
}

return "";
Expand Down Expand Up @@ -329,7 +328,7 @@ function startsWithEmojiLetter(word: string): boolean {
* Not just capital at start
*/
export function isWordCustomCapitalization(word: string): boolean {
if (word.match(/[-/]/)) {
if (isCompoundWord(word)) {
return word.split(/[-/]/).some((w) => isWordCustomCapitalization(w));
}

Expand All @@ -340,6 +339,10 @@ export function isWordCustomCapitalization(word: string): boolean {
return capitalNumber > 1 || (capitalNumber === 1 && !isFirstLetterCapital(word));
}

function isCompoundWord(word: string): boolean {
return !!word.match(/.-.|.\/./);
}

/**
* 3rd, 45th
*/
Expand Down
7 changes: 4 additions & 3 deletions test/titleFormatter.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -137,11 +137,12 @@ describe("toTitleCase", () => {
["The quick brown fox jumps over the lazy/sleepy dog is a sentence", "The Quick Brown Fox Jumps Over the Lazy/Sleepy Dog Is a Sentence"],
["The quick brown fox jumps over the lazy/Sleepy dog is a sentence", "The Quick Brown Fox Jumps Over the Lazy/Sleepy Dog Is a Sentence"],
["The quick brown fox jumps OVER THE LAZY/SLEEPY DOG is a sentence", "The Quick Brown Fox Jumps Over the Lazy/Sleepy Dog Is a Sentence"],
["The quick brown fox jumps over the lazy/SLEEPY dog is a sentence", "The Quick Brown Fox Jumps Over the Lazy/Sleepy Dog Is a Sentence"],
["The Quick Brown Fox Jumps Over the Lazy/Sleepy Dog Is a Sentence", "The Quick Brown Fox Jumps Over the Lazy/Sleepy Dog Is a Sentence"],
["The quick brown fox jumps over the lazy/first-of-it's-kind dog is a sentence", "The Quick Brown Fox Jumps Over the Lazy/First-of-It's-Kind Dog Is a Sentence"],
["The quick brown fox jumps over the first-of-it's-kind is a sentence", "The Quick Brown Fox Jumps Over the First-of-It's-Kind Is a Sentence"],
["The quick brown fox jumps over the first-of-it's-Kind is a sentence", "The Quick Brown Fox Jumps Over the First-of-It's-Kind Is a Sentence"],
["The quick brown fox jumps over the first-of-it's-kInd is a sentence", "The Quick Brown Fox Jumps Over the first-of-it's-kInd Is a Sentence"],
["The quick brown fox jumps over the first-of-it's-kInd is a sentence", "The Quick Brown Fox Jumps Over the First-of-It's-kInd Is a Sentence"],
["The quick brown fox jumps over the go-to dog is a sentence", "The Quick Brown Fox Jumps Over the Go-to Dog Is a Sentence"],
["The quick brown fox jumps over the go-word dog is a sentence", "The Quick Brown Fox Jumps Over the Go-Word Dog Is a Sentence"],

Expand Down Expand Up @@ -269,7 +270,7 @@ describe("titleFormatter custom cases", () => {
["Bill Swearingen - HAKC THE POLICE - DEF CON 27 conference", "Bill Swearingen - HAKC THE POLICE - DEF CON 27 Conference", "Bill Swearingen - HAKC THE POLICE - DEF CON 27 conference"], // preserve delibrate uppercases
["NA/TURALS: FINAL/LAP ft. Cloud9 meL & Jazzyk1ns | VCT NA game changers", "NA/TURALS: FINAL/LAP ft. Cloud9 meL & Jazzyk1ns | VCT NA Game Changers", "NA/TURALS: FINAL/LAP ft. Cloud9 meL & Jazzyk1ns | VCT NA game changers"], // keep titles, prefixes, lowercase usernames
["[MV] SEVENTEEN(세븐틴), >Ailee(에일리) _ Q&A", "[MV] SEVENTEEN(세븐틴), Ailee(에일리) _ Q&A", "[MV] SEVENTEEN(세븐틴), Ailee(에일리) _ Q&A"], // keep all caps in title for SEVENTEEN and [MV]
["AH-dventures in LA - >4K", "AH-dventures in LA - 4K", "AH-dventures in LA - 4K"], // capitalization for pun, 4K
["AH-dventures in LA - >4K", "AH-Dventures in LA - 4K", "AH-dventures in LA - 4K"], // capitalization for pun, 4K
["Welcome to the cunderground - GTA V: cunning stunts", "Welcome to the Cunderground - GTA V: Cunning Stunts", "Welcome to the cunderground - GTA V: Cunning stunts"], // GTA V:
["Achievement City, plan G(mod) - Gmod: TTT | let's play", "Achievement City, Plan G(mod) - Gmod: TTT | Let's Play", "Achievement City, plan G(mod) - Gmod: TTT | Let's play"], // Proper place, G(mod)
["Mad vs T1 - game 1 | round 1 Lol MSI 2023", "Mad vs T1 - Game 1 | Round 1 Lol MSI 2023", "Mad vs T1 - Game 1 | Round 1 Lol MSI 2023"], // LoL, MSI and T1
Expand All @@ -278,7 +279,7 @@ describe("titleFormatter custom cases", () => {
["Snapshot >23w14a", "Snapshot 23w14a", "Snapshot 23w14a"], // 23W14A
["Is the F-15EX secretly the best fighter jet ever made?", "Is the F-15EX Secretly the Best Fighter Jet Ever Made?", "Is the F-15EX secretly the best fighter jet ever made?"], // F-15EX
["US F-15s nose dive against each other | DCS", "US F-15s Nose Dive Against Each Other | DCS", "US F-15s nose dive against each other | DCS"], // DCS, F-15s
["F/A-18C Hornets execute no knock raid | DCS", "F/A-18C Hornets Execute No Knock Raid | DCS", "F/A-18C Hornets execute no knock raid | DCS"], // F/A-18C, DCS
["F/A-18C Hornets execute no knock raid | DCS", "F/a-18C Hornets Execute No Knock Raid | DCS", "F/A-18C Hornets execute no knock raid | DCS"], // F/A-18C, DCS
["CS 1.6 - zombie plague / >zm_cubeworld_mini [küplere biniyoruz]", "CS 1.6 - Zombie Plague / zm_cubeworld_mini [Küplere Biniyoruz]", "CS 1.6 - Zombie plague / zm_cubeworld_mini [küplere biniyoruz]"], // preserve zm_cubeworld_mini
[">f0rest vs. >x6tence @IEM IV european championship", "f0rest vs. x6tence @IEM IV European Championship", "f0rest vs. x6tence @IEM IV european championship"], // two lowercase names
[">markeloff vs SK.swe (ESWC 2010 final)", "markeloff vs SK.swe (ESWC 2010 Final)", "markeloff vs SK.swe (ESWC 2010 final)"], // keep markeloff, keep SK.swe
Expand Down

0 comments on commit e6a4065

Please # to comment.