fix: don't brace abbreviated months

Author: FlamingTempura

bibtex-tidy.d.ts

@@ -226,94 +226,6 @@ export type BibTeXTidyOptions = {
 };
 export type Options = Omit<BibTeXTidyOptions, "help" | "version" | "quiet" | "backup">;
 export type DuplicateRule = Exclude<BibTeXTidyOptions["duplicates"], boolean | undefined>[number];
-declare class RootNode {
-	children: (TextNode | BlockNode)[];
-	type: "root";
-	constructor(children?: (TextNode | BlockNode)[]);
-}
-declare class TextNode {
-	parent: RootNode;
-	text: string;
-	type: "text";
-	constructor(parent: RootNode, text: string);
-}
-declare class BlockNode {
-	parent: RootNode;
-	type: "block";
-	command: string;
-	block?: CommentNode | PreambleNode | StringNode | EntryNode;
-	constructor(parent: RootNode);
-}
-declare class CommentNode {
-	parent: BlockNode;
-	raw: string;
-	braces: number;
-	parens: number;
-	type: "comment";
-	constructor(parent: BlockNode, raw: string, braces: number, parens: number);
-}
-declare class PreambleNode {
-	parent: BlockNode;
-	raw: string;
-	braces: number;
-	parens: number;
-	type: "preamble";
-	constructor(parent: BlockNode, raw: string, braces: number, parens: number);
-}
-declare class StringNode {
-	parent: BlockNode;
-	raw: string;
-	braces: number;
-	parens: number;
-	type: "string";
-	constructor(parent: BlockNode, raw: string, braces: number, parens: number);
-}
-declare class EntryNode {
-	parent: BlockNode;
-	wrapType: "{" | "(";
-	type: "entry";
-	key?: string;
-	keyEnded?: boolean;
-	fields: FieldNode[];
-	constructor(parent: BlockNode, wrapType: "{" | "(");
-}
-declare class FieldNode {
-	parent: EntryNode;
-	name: string;
-	type: "field";
-	/** Each value is concatenated */
-	value: ConcatNode;
-	constructor(parent: EntryNode, name?: string);
-}
-declare class ConcatNode {
-	parent: FieldNode;
-	type: "concat";
-	concat: (LiteralNode | BracedNode | QuotedNode)[];
-	canConsumeValue: boolean;
-	constructor(parent: FieldNode);
-}
-declare class LiteralNode {
-	parent: ConcatNode;
-	value: string;
-	type: "literal";
-	constructor(parent: ConcatNode, value: string);
-}
-declare class BracedNode {
-	parent: ConcatNode;
-	type: "braced";
-	value: string;
-	/** Used to count opening and closing braces */
-	depth: number;
-	constructor(parent: ConcatNode);
-}
-declare class QuotedNode {
-	parent: ConcatNode;
-	type: "quoted";
-	value: string;
-	/** Used to count opening and closing braces */
-	depth: number;
-	constructor(parent: ConcatNode);
-}
 export type Warning = ({
 	code: "MISSING_KEY";
 } | {
@@ -328,6 +240,5 @@ export type BibTeXTidyResult = {
 	count: number;
 };
 export declare function tidy(input: string, options_?: Options): BibTeXTidyResult;
-export declare function getEntries(ast: RootNode): EntryNode[];
 
 export {};

bibtex-tidy.js

@@ -2,7 +2,15 @@ import type { ASTProxy } from "../ASTProxy";
 import { type FieldNode, LiteralNode } from "../parsers/bibtexParser";
 import type { Transform } from "../types";
 
-const monthAliases: Record<string, string[]> = {
+/**
+ * It’s generally recommended to store months in BibTeX files using the macros jan, feb,
+ * and so on. Whether they’re recognised depends on the particular BibTeX style, but most
+ * of them do support those macros. Biber also supports these macros.
+ * - https://www.bibtex.com/f/month-field/
+ * - https://texdoc.org/serve/biber.pdf/0
+ */
+
+export const monthAliases: Record<string, string[]> = {
 	jan: ["1", "jan", "january"],
 	feb: ["2", "feb", "february"],
 	mar: ["3", "mar", "march"],

bin/bibtex-tidy

@@ -1,10 +1,17 @@
 import type { Transform } from "../types";
+import { monthAliases } from "./abbreviateMonths";
 
 export function createPreferCurlyTransform(): Transform {
 	return {
 		name: "prefer-curly",
 		apply: (ast) => {
 			for (const field of ast.fields()) {
+				if (
+					field.name.toLowerCase() === "month" &&
+					monthAliases[ast.lookupRenderedEntryValue(field)]
+				) {
+					continue;
+				}
 				for (const child of field.value.concat) {
 					child.type = "braced";
 				}

docs/bundle.js

@@ -31,3 +31,18 @@ test("curly (enforce braced values)", async () => {
 	const tidied = await bibtexTidy(input, { curly: true });
 	strictEqual(tidied.bibtex, output);
 });
+
+test("do not brace abbreviated months", async () => {
+	const input = bibtex`@article{foo, title={Foo}, month = mar }`;
+
+	const expected = bibtex`
+@article{foo,
+  title         = {Foo},
+  month         = mar
+}
+`;
+
+	const tidied = await bibtexTidy(input, { curly: true });
+	strictEqual(tidied.bibtex, expected);
+});
+//bibtex-tidy --curly --numeric --months --tab --align=13 --duplicates=key --no-escape --sort-fields --no-remove-dupe-fields YOUR_FILE.bib