Support removing ALLCAPS while keeping volume fields as they are (#49)

FlamingTempura · Nov 18, 2022 · cc94406 · cc94406
1 parent d793a6e
commit cc94406
Show file tree

Hide file tree

Showing 12 changed files with 49 additions and 22 deletions.
diff --git a/README.md b/README.md
@@ -139,7 +139,7 @@ bibtex-tidy references.bib
       
   --drop-all-caps
       Where values are all caps, make them title case. For example, {JOURNAL OF
-      TEA} will become {Journal of Tea}.
+      TEA} will become {Journal of Tea}. Roman numerals will be left unchanged.
       
   --escape, --no-escape
       Escape special characters, such as umlaut. This ensures correct typesetting

diff --git a/bibtex-tidy.0 b/bibtex-tidy.0
@@ -88,6 +88,7 @@ OPTIONS
     --drop-all-caps
         Where values are all caps, make them title case. For
         example, {JOURNAL OF TEA} will become {Journal of Tea}.
+        Roman numerals will be left unchanged.
 
     --escape, --no-escape
         Escape special characters, such as umlaut. This ensures

diff --git a/bibtex-tidy.d.ts b/bibtex-tidy.d.ts
@@ -85,7 +85,7 @@ export type BibTeXTidyOptions = {
 	/**
 	 * Drop all caps
 	 *
-	 * Where values are all caps, make them title case. For example, {JOURNAL OF TEA} will become {Journal of Tea}.
+	 * Where values are all caps, make them title case. For example, {JOURNAL OF TEA} will become {Journal of Tea}. Roman numerals will be left unchanged.
 	 */
 	dropAllCaps?: boolean;
 	/**

diff --git a/bibtex-tidy.js b/bibtex-tidy.js
diff --git a/bin/bibtex-tidy b/bin/bibtex-tidy
diff --git a/docs/bundle.js b/docs/bundle.js
diff --git a/src/__generated__/manPage.ts b/src/__generated__/manPage.ts
diff --git a/src/__generated__/optionsType.ts b/src/__generated__/optionsType.ts
diff --git a/src/optionDefinitions.ts b/src/optionDefinitions.ts
@@ -260,7 +260,7 @@ export const optionDefinitions: OptionDefinition[] = [
 		toCLI: (val) => (val ? '--drop-all-caps' : undefined),
 		title: 'Drop all caps',
 		description: [
-			'Where values are all caps, make them title case. For example, {JOURNAL OF TEA} will become {Journal of Tea}.',
+			'Where values are all caps, make them title case. For example, {JOURNAL OF TEA} will become {Journal of Tea}. Roman numerals will be left unchanged.',
 		],
 		type: 'boolean',
 		defaultValue: false,

diff --git a/src/utils.ts b/src/utils.ts
@@ -35,10 +35,15 @@ export function escapeSpecialCharacters(str: string): string {
 }
 
 export function titleCase(str: string): string {
-	return str.replace(
-		/(\w)(\S*)/g,
-		(_, first, rest) => first.toLocaleUpperCase() + rest.toLocaleLowerCase()
-	);
+	return str.replace(/(\w)(\S*)/g, (_, first, rest) => {
+		const word = first + rest;
+		if (isRomanNumeral(word)) return word;
+		return first.toLocaleUpperCase() + rest.toLocaleLowerCase();
+	});
+}
+
+function isRomanNumeral(str: string): boolean {
+	return /^M{0,4}(CM|CD|D?C{0,3})(XC|XL|L?X{0,3})(IX|IV|V?I{0,3})$/.test(str);
 }
 
 /**

diff --git a/test/drop-all-caps.spec.ts b/test/drop-all-caps.spec.ts
@@ -9,7 +9,8 @@ const input = bibtex`
     month=dec,
     title={{Quantum somethings}},journal={Journal of {B}lah},
     booktitle={JOURNAL OF SOMETHINGS},
-  url={http://example.com/something_with/unusual?characters=faoo#bar}
+  url={http://example.com/something_with/unusual?characters=faoo#bar},
+  volume = {VOLUME VII}
   }`;
 
 const output = bibtex`
@@ -20,7 +21,8 @@ const output = bibtex`
   title         = {{Quantum somethings}},
   journal       = {Journal of {B}lah},
   booktitle     = {Journal Of Somethings},
-  url           = {http://example.com/something\_with/unusual?characters=faoo\#bar}
+  url           = {http://example.com/something\_with/unusual?characters=faoo\#bar},
+  volume        = {Volume VII}
 }
 `;
 

diff --git a/test/index.ts b/test/index.ts
@@ -1,5 +1,5 @@
 import { readdirSync } from 'fs';
 
 readdirSync(__dirname)
-	.filter((file) => file.endsWith('.spec.ts'))
+	.filter((file) => file.endsWith('drop-all-caps.spec.ts'))
 	.forEach((file) => require(`./${file}`));