improve auto-capitalization for title generation

Author: jjallaire

src/core/text.ts

@@ -20,10 +20,49 @@ export {
   normalizeNewlines,
 } from "./lib/text.ts";
 
-export function capitalize(str: string) {
+export function capitalizeWord(str: string) {
   return str.slice(0, 1).toUpperCase() + str.slice(1);
 }
 
+export function capitalizeTitle(str: string) {
+  return str.split(/\s+/).map((str, index, arr) => {
+    if (
+      index === 0 || index === (arr.length - 1) || !isNotCapitalized(str)
+    ) {
+      return capitalizeWord(str);
+    } else {
+      return str;
+    }
+  }).join(" ");
+}
+
+function isNotCapitalized(str: string) {
+  return [
+    // articles
+    "a",
+    "an",
+    "the",
+    // coordinating conjunctions
+    "for",
+    "and",
+    "nor",
+    "but",
+    "or",
+    "yet",
+    "so",
+    // prepositions
+    "with",
+    "at",
+    "by",
+    "to",
+    "in",
+    "for",
+    "from",
+    "of",
+    "on",
+  ].includes(str);
+}
+
 export function formatLineRange(
   text: string,
   firstLine: number,

src/project/types/website/website-sidebar-auto.ts

@@ -16,6 +16,7 @@ import {
   pathWithForwardSlashes,
   safeExistsSync,
 } from "../../../core/path.ts";
+import { capitalizeTitle } from "../../../core/text.ts";
 import { engineValidExtensions } from "../../../execute/engine.ts";
 import { inputTargetIndex, resolveInputTarget } from "../../project-index.ts";
 
@@ -151,7 +152,7 @@ async function nodesToEntries(
           });
         } else {
           entries.push({
-            title: basename(href),
+            title: titleFromPath(href),
             children: await nodesToEntries(
               project,
               `${root}${node}/`,
@@ -182,19 +183,28 @@ async function nodesToEntries(
     }
   });
 }
-
 async function entryFromHref(project: ProjectContext, href: string) {
   const index = await inputTargetIndex(project, href);
   return {
     title: index?.title ||
       (await resolveInputTarget(project, href))?.title ||
-      dirAndStem(href)[1],
+      titleFromPath(dirAndStem(href)[1]),
     href: href,
     order: asNumber(index?.markdown.yaml?.[kOrder]),
     empty: index?.markdown.markdown.trim().length == 0,
   };
 }
 
+function titleFromPath(path: string) {
+  const name = basename(path);
+  // if there are no spaces then try to split on dashes/underscoes and autocapitalize
+  if (!name.includes(" ")) {
+    return capitalizeTitle(name.replaceAll(/[_\-]+/g, " "));
+  } else {
+    return name;
+  }
+}
+
 function sidebarItemsFromEntries(entries: Entry[]): SidebarItem[] {
   return entries.map((entry) => {
     if (entry.children) {

src/publish/common/publish.ts

@@ -24,7 +24,6 @@ import { fileProgress } from "../../core/progress.ts";
 
 import { PublishRecord } from "../types.ts";
 import { PublishFiles } from "../provider.ts";
-import { capitalize } from "../../core/text.ts";
 import { gfmAutoIdentifier } from "../../core/pandoc/pandoc-id.ts";
 import { randomHex } from "../../core/random.ts";
 import { copyTo } from "../../core/copy.ts";
@@ -33,6 +32,7 @@ import { globalTempContext } from "../../core/temp.ts";
 import { formatResourcePath } from "../../core/resources.ts";
 import { encodeAttributeValue } from "../../core/html.ts";
 import { haveArrowKeys } from "../../core/platform.ts";
+import { capitalizeWord } from "../../core/text.ts";
 
 export interface PublishSite {
   id?: string;
@@ -421,5 +421,5 @@ async function promptForSlug(
 }
 
 function typeName(type: string) {
-  return capitalize(type);
+  return capitalizeWord(type);
 }