@chriswiegman/hugo-tools 0.2.1 → 0.2.2

package/CHANGELOG.md

@@ -5,6 +5,17 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html),
 and is generated by [Changie](https://github.com/miniscruff/changie).
 
+## 0.2.2 - 2026-07-19
+
+### Bug Fixes
+
+* book: update rating from Goodreads only when it differs and Goodreads has an actual rating, so manually-set ratings in markdown aren't overwritten by an unrated (0) Goodreads entry
+
+### Chores
+
+* Update project dependencies.
+* Fix no-console warnings during linting.
+
 ## 0.2.1 - 2026-07-04
 
 ### Chores

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chriswiegman/hugo-tools",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "A set of tools to make blogging easier with Hugo.",
   "keywords": [
     "hugo",
@@ -47,7 +47,7 @@
     "@eslint/js": "^10.0.1",
     "@stylistic/eslint-plugin": "^5.10.0",
     "changie": "^1.25.0",
-    "eslint": "^10.6.0",
+    "eslint": "^10.7.0",
     "globals": "^17.7.0"
   }
 }

package/src/book.mjs

@@ -12,7 +12,10 @@
  * - Existing files are matched by Goodreads Book ID first, then ISBN, then title slug.
  * - When a match is found at a different path (title changed in Goodreads), the file is
  *   renamed to the new slug and the title in front matter is updated automatically.
- * - For an existing book file, finished dates are merged; other fields are left untouched
+ * - For an existing book file, finished dates are merged and the rating is updated when the
+ *   Goodreads rating differs from the file's rating — but only when Goodreads has a rating
+ *   (> 0). A Goodreads rating of 0 (unrated) never overwrites a rating already in the file,
+ *   since you may have rated the book only in the markdown. Other fields are left untouched
  *   unless a rename occurs (in which case the title is also updated).
  *
  * Usage:
@@ -244,11 +247,13 @@ function authorDirFromAuthorLF(authorLF) {
  *     - "YYYY-MM-DD"
  *     - "YYYY-MM-DD"
  * - finished: "YYYY-MM-DD"   (legacy scalar; included as one date)
+ *
+ * Also extracts the existing `rating:` value (or null if absent/unparseable).
  */
 function parseExistingMarkdown(md) {
 	const m = md.match(/^---\s*\n([\s\S]*?)\n---\s*\n?([\s\S]*)$/);
 
-	if (!m) return { finished: [] };
+	if (!m) return { finished: [], rating: null };
 
 	const fm = m[1];
 	const lines = fm.split('\n');
@@ -280,7 +285,18 @@ function parseExistingMarkdown(md) {
 		}
 	}
 
-	return { finished: uniqSortedDates(finished) };
+	let rating = null;
+
+	for (const line of lines) {
+		const mm = line.match(/^rating:\s*(\d+)\s*$/);
+
+		if (mm) {
+			rating = Number(mm[1]);
+			break;
+		}
+	}
+
+	return { finished: uniqSortedDates(finished), rating };
 }
 
 async function fileExists(p) {
@@ -334,6 +350,13 @@ function updateTitleInFrontMatter(md, newTitle) {
 	return md.replace(/^title:.*$/m, `title: "${escapeYAMLString(newTitle)}"`);
 }
 
+/**
+ * Update the rating field in front matter, leaving everything else untouched.
+ */
+function updateRatingInFrontMatter(md, newRating) {
+	return md.replace(/^rating:.*$/m, `rating: ${newRating}`);
+}
+
 // -------------------- Existing-file index --------------------
 
 /**
@@ -638,6 +661,7 @@ async function main() {
 	let mergedExisting = 0;
 	let renamedFiles = 0;
 	let skippedUnchanged = 0;
+	let ratingsUpdated = 0;
 
 	for (const b of bookList) {
 		const authorDir = authorDirFromAuthorLF(b.authorLF);
@@ -651,14 +675,19 @@ async function main() {
 
 			// Read the existing file
 			const existingContent = await fs.readFile(existingPath, 'utf8');
-			const { finished: existingFinished } = parseExistingMarkdown(existingContent);
+			const { finished: existingFinished, rating: existingRating } = parseExistingMarkdown(existingContent);
 			const finishedMerged = uniqSortedDates([...existingFinished, ...b.finished]);
 
 			const hasNewDates =
 				finishedMerged.length !== existingFinished.length ||
         finishedMerged.some((d, i) => d !== existingFinished[i]);
 
-			if (!titleChanged && !hasNewDates) {
+			// Only let Goodreads override the file's rating when Goodreads actually has one (> 0).
+			// A rating of 0 usually means "not rated on Goodreads" — the file may carry a rating
+			// entered by hand there instead, so leave it alone rather than clobbering it with 0.
+			const hasRatingChange = b.rating > 0 && existingRating !== null && b.rating !== existingRating;
+
+			if (!titleChanged && !hasNewDates && !hasRatingChange) {
 				skippedUnchanged++;
 				continue;
 			}
@@ -670,6 +699,15 @@ async function main() {
 				patched = replaceFinishedBlock(patched, finishedMerged);
 			}
 
+			if (hasRatingChange) {
+				patched = updateRatingInFrontMatter(patched, b.rating);
+				ratingsUpdated++;
+
+				const rel = path.relative(OUTPUT_ROOT, existingPath);
+
+				console.log(`  RATING UPDATED: ${rel} (${existingRating} -> ${b.rating})`);
+			}
+
 			if (titleChanged) {
 				patched = updateTitleInFrontMatter(patched, b.title);
 			}
@@ -746,6 +784,7 @@ async function main() {
       `  New files created:       ${createdNew}\n` +
       `  Existing files updated:  ${mergedExisting}\n` +
       `  Files renamed:           ${renamedFiles}\n` +
+      `  Ratings updated:         ${ratingsUpdated}\n` +
       `  Existing files skipped:  ${skippedUnchanged}\n` +
       `  Content output:          ${OUTPUT_ROOT}\n`,
 	);
@@ -778,6 +817,7 @@ export {
 	parseExistingMarkdown,
 	replaceFinishedBlock,
 	updateTitleInFrontMatter,
+	updateRatingInFrontMatter,
 	extractGoodreadsId,
 	extractFileIsbns,
 	toFrontMatter,

package/src/book.test.mjs

@@ -20,6 +20,7 @@ import {
 	parseExistingMarkdown,
 	replaceFinishedBlock,
 	updateTitleInFrontMatter,
+	updateRatingInFrontMatter,
 	extractGoodreadsId,
 	extractFileIsbns,
 	toFrontMatter,
@@ -433,6 +434,26 @@ test('parseExistingMarkdown: returns empty array for invalid front matter', () =
 	assert.deepEqual(finished, []);
 });
 
+test('parseExistingMarkdown: extracts rating', () => {
+	const md = sampleMarkdown({ rating: 5 });
+	const { rating } = parseExistingMarkdown(md);
+
+	assert.equal(rating, 5);
+});
+
+test('parseExistingMarkdown: returns null rating when field is absent', () => {
+	const md = ['---', 'title: "Test"', 'finished:', '  - "2023-01-15"', '---', ''].join('\n');
+	const { rating } = parseExistingMarkdown(md);
+
+	assert.equal(rating, null);
+});
+
+test('parseExistingMarkdown: returns null rating for invalid front matter', () => {
+	const { rating } = parseExistingMarkdown('no front matter here');
+
+	assert.equal(rating, null);
+});
+
 // ---------------------------------------------------------------------------
 // replaceFinishedBlock
 // ---------------------------------------------------------------------------
@@ -508,6 +529,26 @@ test('updateTitleInFrontMatter: preserves all other front matter', () => {
 	assert.ok(result.includes('goodreads:'));
 });
 
+// ---------------------------------------------------------------------------
+// updateRatingInFrontMatter
+// ---------------------------------------------------------------------------
+
+test('updateRatingInFrontMatter: replaces rating line', () => {
+	const md = sampleMarkdown({ rating: 3 });
+	const result = updateRatingInFrontMatter(md, 5);
+
+	assert.ok(result.includes('rating: 5'));
+	assert.ok(!result.includes('rating: 3'));
+});
+
+test('updateRatingInFrontMatter: preserves all other front matter', () => {
+	const md = sampleMarkdown({ title: 'Keep Me', rating: 2 });
+	const result = updateRatingInFrontMatter(md, 4);
+
+	assert.ok(result.includes('title: "Keep Me"'));
+	assert.ok(result.includes('goodreads:'));
+});
+
 // ---------------------------------------------------------------------------
 // extractGoodreadsId
 // ---------------------------------------------------------------------------