Update to Prettier v3 and fix promise error

Author: Cactooz

package.json

@@ -11,15 +11,14 @@
 		"format": "prettier --write dist songs src test README.md .prettierrc jest.config.js package.json tsconfig.json",
 		"github": "ts-node src/github"
 	},
-	"dependencies": {},
 	"devDependencies": {
 		"@types/jest": "^29.5.14",
 		"@types/node": "^22.13.10",
 		"dayjs": "^1.11.13",
 		"gray-matter": "^4.0.3",
 		"jest": "^29.7.0",
 		"jest-expect-message": "^1.1.3",
-		"prettier": "^2.8.8",
+		"prettier": "^3.5.3",
 		"ts-jest": "^29.2.6",
 		"ts-node": "^10.9.2",
 		"typescript": "^5.8.2"

src/scripts/build.ts

@@ -11,14 +11,14 @@ import { isoDateRegex } from '../util/regex';
 import createSongs from '../util/createSongs';
 import dayjs from 'dayjs';
 
-export default function build(customUpdatedAt: string | undefined): void {
+export default async function build(customUpdatedAt: string | undefined): Promise<void> {
 	const updatedAt = customUpdatedAt?.match(isoDateRegex)
 		? customUpdatedAt
 		: dayjs().format('YYYY-MM-DD');
 
 	const buildSongs = createSongs(updatedAt);
 
-	writeJson(buildSongs.json);
+	writeJson(await buildSongs.json);
 	writeXml(buildSongs.xml);
 	writeXmlWithoutIds(buildSongs.xmlNoIds);
 	console.log('Build complete and saved');
@@ -31,7 +31,7 @@ export default function build(customUpdatedAt: string | undefined): void {
 	});
 	if (filesToRemove.length)
 		console.log(
-			`Removed ${filesToRemove.length} unneeded file${filesToRemove.length !== 1 ? 's' : ''}`
+			`Removed ${filesToRemove.length} unneeded file${filesToRemove.length !== 1 ? 's' : ''}`,
 		);
 }
 

src/scripts/create.ts

@@ -8,7 +8,7 @@ import { SONGS_FOLDER_PATH } from '../definitions/paths';
 import pushIds from '../util/pushIds';
 import { getAllSongPaths } from '../util/songs';
 
-export default function create(title: string, ...args: string[]): void {
+export default async function create(title: string, ...args: string[]): Promise<void> {
 	if (!title) return console.error('A title for the new song must be provided!');
 	const { id, ...parsedArgs } = parseArgs(args);
 
@@ -18,23 +18,23 @@ export default function create(title: string, ...args: string[]): void {
 
 	if (id !== undefined) pushIds(id);
 
-	writeFileSync(join(SONGS_FOLDER_PATH, newTitle), newContent);
+	writeFileSync(join(SONGS_FOLDER_PATH, newTitle), await newContent);
 }
 
 function nextId(): number {
 	return getAllSongPaths().length;
 }
 
-function generateDefaultSongFileContent(
+async function generateDefaultSongFileContent(
 	title: string,
 	{
 		author,
 		melody,
 		composer,
 		tags = [],
 		content,
-	}: Omit<Song, 'id' | 'title' | 'deleted' | 'content'> & { content?: string }
-): string {
+	}: Omit<Song, 'id' | 'title' | 'deleted' | 'content'> & { content?: string },
+): Promise<string> {
 	let contentBuilder = `---\ntitle: ${title}\n`;
 	contentBuilder += `author: ${author || ''}\n`;
 	contentBuilder += `melody: ${melody || ''}\n`;
@@ -43,11 +43,11 @@ function generateDefaultSongFileContent(
 	contentBuilder += '---\n';
 	if (content) contentBuilder += content;
 
-	return format(contentBuilder, { parser: 'markdown' });
+	return await format(contentBuilder, { parser: 'markdown' });
 }
 
 function parseArgs(
-	args: string[]
+	args: string[],
 ): Partial<Omit<Song, 'title' | 'deleted' | 'tags'>> & { tags: Tag[] } {
 	const [idString] = getArgValues(args, 'id');
 	const [author] = getArgValues(args, 'author');

src/util/songs.ts

@@ -81,7 +81,7 @@ export function sortXmlifyableSongs(songs: XmlifyableSong[]): XmlifyableSong[] {
 		.sort(
 			(a, b) =>
 				LEGACY_ORDER.findIndex((category) => a.category === category) -
-				LEGACY_ORDER.findIndex((category) => b.category === category)
+				LEGACY_ORDER.findIndex((category) => b.category === category),
 		)
 		.sort((a, b) => (b.sorting || 0) - (a.sorting || 0));
 }
@@ -91,7 +91,7 @@ export function sortSongs(songs: Song[]): Song[] {
 		.sort(
 			(a, b) =>
 				CATEGORY_ORDER.findIndex((category) => a.tags[0] === category) -
-				CATEGORY_ORDER.findIndex((category) => b.tags[0] === category)
+				CATEGORY_ORDER.findIndex((category) => b.tags[0] === category),
 		)
 		.sort((a, b) => (b.sorting || 0) - (a.sorting || 0));
 }

src/util/xml.ts

@@ -35,7 +35,7 @@ function songContentToXml(content: Song['content']): string {
 				paragraph
 					.split('\n')
 					.map((s) => s.substring(2))
-					.join('\n')
+					.join('\n'),
 			)}</comment>\n`;
 		} else {
 			xml += `\t\t<p>${xmlifyParagraph(paragraph)}</p>\n`;

test/songFiles.test.ts

@@ -20,7 +20,7 @@ describe('All songs have valid data', () => {
 			Object.keys(metaKeys).forEach((metaKey) => {
 				expect(
 					validMetaKeys,
-					`Value ${metaKey} not a valid metadata property (found in ${path})`
+					`Value ${metaKey} not a valid metadata property (found in ${path})`,
 				).toContain(metaKey);
 			});
 		});
@@ -43,7 +43,7 @@ describe('All songs have valid data', () => {
 			const invalidTag = song.tags.find((tag) => !TAGS.includes(tag));
 			expect(
 				invalidTag,
-				`Song with ID=${song.id} and title '${song.title}' contains the invalid tag '${invalidTag}'`
+				`Song with ID=${song.id} and title '${song.title}' contains the invalid tag '${invalidTag}'`,
 			).toBeUndefined();
 		});
 	});

test/validIds.test.ts

@@ -48,7 +48,7 @@ describe('All IDs are valid', () => {
 		songs.forEach((song) => {
 			expect(
 				song.id,
-				`No song ID can be greater than 4095 (found in song with title ${song.title})`
+				`No song ID can be greater than 4095 (found in song with title ${song.title})`,
 			).toBeLessThanOrEqual(4095);
 		});
 	});

yarn.lock

@@ -1927,10 +1927,10 @@ pkg-dir@^4.2.0:
   dependencies:
     find-up "^4.0.0"
 
-prettier@^2.8.8:
-  version "2.8.8"
-  resolved "https://registry.yarnpkg.com/prettier/-/prettier-2.8.8.tgz#e8c5d7e98a4305ffe3de2e1fc4aca1a71c28b1da"
-  integrity sha512-tdN8qQGvNjw4CHbY+XXk0JgCXn9QiF21a55rBe5LJAU+kDyC4WQn4+awm2Xfk2lQMk5fKup9XgzTZtGkjBdP9Q==
+prettier@^3.5.3:
+  version "3.5.3"
+  resolved "https://registry.yarnpkg.com/prettier/-/prettier-3.5.3.tgz#4fc2ce0d657e7a02e602549f053b239cb7dfe1b5"
+  integrity sha512-QQtaxnoDJeAkDvDKWCLiwIXkTgRhwYDEQCghU9Z6q03iyek/rxRh/2lC3HB7P8sWT2xC/y5JDctPLBIGzHKbhw==
 
 pretty-format@^29.0.0, pretty-format@^29.7.0:
   version "29.7.0"