To read -> Reading list

Author: brookback

Diff for: .github/workflows/cron-wishlist.yml

@@ -14,7 +14,7 @@ on:
 
 env:
     DENO_VERSION: v1.40.3
-    TO_READ_PATH: 'src/_data/toread.yml'
+    READING_LIST_PATH: 'src/_data/reading_list.yml'
 
 permissions:
     contents: write # to checkout repo and write back log file
@@ -32,14 +32,14 @@ jobs:
               with:
                   deno-version: ${{ env.DENO_VERSION }}
 
-            - name: Fetch and sync into toread.yml
+            - name: Fetch and sync into reading list
               run: |
                   output=$(deno run --allow-net --allow-read --allow-env ./script/fetch-kobo-wishlist.ts)
                   ec=$?
                   [[ $ec -eq 0 && -n "$output" ]] && \
-                    echo "$output" >> "$to_read" || ([[ $ec -eq 10 ]] && echo "$output")
+                    echo "$output" >> "$reading_list" || ([[ $ec -eq 10 ]] && echo "$output")
               env:
-                  to_read: ${{ env.TO_READ_PATH }}
+                  reading_list: ${{ env.READING_LIST_PATH }}
                   KOBO_ACCESS_TOKEN: ${{ secrets.KOBO_ACCESS_TOKEN }}
                   KOBO_REFRESH_TOKEN: ${{ secrets.KOBO_REFRESH_TOKEN }}
 
@@ -49,8 +49,8 @@ jobs:
                   git pull
                   git config user.name "Automated"
                   git config user.email "[email protected]"
-                  git add "$to_read"
-                  git commit -m "Update 'To Read' from Johan's Kobo wishlist" || exit 0
+                  git add "$reading_list"
+                  git commit -m "Update reading list from Johan's Kobo wishlist" || exit 0
                   git push
               env:
-                  to_read: ${{ env.TO_READ_PATH }}
+                  reading_list: ${{ env.READING_LIST_PATH }}

Diff for: api/model/to-read.ts renamed to api/model/reading-list.ts

@@ -4,25 +4,25 @@ import * as Yaml from 'jsr:@std/yaml';
 import { slug } from 'slug';
 import { join } from 'std/path/mod.ts';
 
-const TO_READ_PATH = 'src/_data/toread.yml';
+const READING_LIST_PATH = 'src/_data/reading_list.yml';
 
-export interface ToReadBook {
+export interface ReadingListBook {
     title: string;
     author: string;
     notes?: string;
     addedAt?: Date;
     isbn?: string;
 }
 
-export const findAll = async (store: FileHost): Promise<ToReadBook[]> => {
-    const raw = await store.getFile(TO_READ_PATH);
+export const findAll = async (store: FileHost): Promise<ReadingListBook[]> => {
+    const raw = await store.getFile(READING_LIST_PATH);
 
     if (!raw) return [];
 
     return booksArrayOf(raw);
 };
 
-export const add = async (store: FileHost, input: ToReadBook): Promise<[ToReadBook, string]> => {
+export const add = async (store: FileHost, input: ReadingListBook): Promise<[ReadingListBook, string]> => {
     const books = await findAll(store);
 
     if (books.find((b) => slug(b.title) == slug(input.title))) {
@@ -32,43 +32,43 @@ export const add = async (store: FileHost, input: ToReadBook): Promise<[ToReadBo
         );
     }
 
-    const raw = await store.getFile(TO_READ_PATH);
+    const raw = await store.getFile(READING_LIST_PATH);
 
     const str = Yaml.stringify([input]);
 
     const final = raw + '\n' + str;
 
     const fullPath = await store.putFile(
         final,
-        join(TO_READ_PATH),
+        join(READING_LIST_PATH),
     );
 
     return [input, fullPath];
 };
 
-export const addMany = async (store: FileHost, todo: ToReadBook[]) => {
+export const addMany = async (store: FileHost, todo: ReadingListBook[]) => {
     if (!todo.length) return 0;
 
-    const raw = await store.getFile(TO_READ_PATH);
+    const raw = await store.getFile(READING_LIST_PATH);
 
     const str = Yaml.stringify(todo);
 
     const final = raw + '\n' + str;
 
     await store.putFile(
         final,
-        join(TO_READ_PATH),
+        join(READING_LIST_PATH),
     );
 
     return todo.length;
 };
 
-const booksArrayOf = (raw: string): ToReadBook[] => {
+const booksArrayOf = (raw: string): ReadingListBook[] => {
     const books = Yaml.parse(raw);
 
     if (!Array.isArray(books)) {
-        throw new ProblemError(ProblemKind.InconsistentFile, `${TO_READ_PATH} isn't a YAML array`);
+        throw new ProblemError(ProblemKind.InconsistentFile, `${READING_LIST_PATH} isn't a YAML array`);
     }
 
-    return books as ToReadBook[];
+    return books as ReadingListBook[];
 };

Diff for: script/fetch-kobo-wishlist.ts

@@ -2,9 +2,9 @@ import { encodeBase64 } from 'jsr:@std/encoding/base64';
 import { slug } from 'slug';
 import * as Yaml from 'jsr:@std/yaml';
 import { join } from 'jsr:@std/path';
-import { type ToReadBook } from '../api/model/to-read.ts';
+import { type ReadingListBook } from '../api/model/reading-list.ts';
 
-const TO_READ_PATH = 'src/_data/toread.yml';
+const READING_LIST_PATH = 'src/_data/reading_list.yml';
 
 // Rewritten from Python (https://github.com/subdavis/kobo-book-downloader/blob/main/kobodl/kobo.py) by Johan.
 // Huge props to the great reverse engineering by them.
@@ -52,15 +52,15 @@ interface WishlistItem {
 }
 
 const diffOf = async (wishlist: WishlistItem[]) => {
-    const books = wishlist.map<ToReadBook>((w) => ({
+    const books = wishlist.map<ReadingListBook>((w) => ({
         title: w.ProductMetadata.Book.Title,
         author: w.ProductMetadata.Book.Contributors,
         addedAt: new Date(w.DateAdded),
         isbn: w.ProductMetadata.Book.ISBN,
     })).sort((b1, b2) => b1.addedAt!.getTime() - b2.addedAt!.getTime());
 
-    const yml = await Deno.readTextFile(join(Deno.cwd(), TO_READ_PATH));
-    const all = Yaml.parse(yml) as ToReadBook[];
+    const yml = await Deno.readTextFile(join(Deno.cwd(), READING_LIST_PATH));
+    const all = Yaml.parse(yml) as ReadingListBook[];
 
     const diff = books.filter((b1) => !all.find((b2) => slug(b1.title.trim()) == slug(b2.title.trim())));
 

Diff for: src/_data/toread.yml renamed to src/_data/reading_list.yml

@@ -1,7 +1,7 @@
 ---
-title: Want to read
+title: Reading list
 layout: layouts/page.njk
-description: Books which are on my reading list.
+description: Books I want to read.
 ---
 
 <table>
@@ -12,7 +12,7 @@ description: Books which are on my reading list.
     		<th scope="column">Notes</th>
     	</tr>
     </thead>
-  {% for book in toread | reverse %}
+  {% for book in reading_list | reverse %}
     <tr id="{{ book.slug }}">
     	<th scope="row">
 			{{ book.title }}

Diff for: src/to-read.njk renamed to src/reading-list.njk

@@ -28,7 +28,7 @@ menu:
 	   <h1 class="title p-name">{{ title }}</h1>
 
 		<p class="subhead">
-  		    Non-exhaustive list of books I've read and am reading, in reverse chronological order. You can also check out what I <a href="/to-read">want to read next.</a>
+  		    Non-exhaustive list of books I've read and am reading, in reverse chronological order. You can also check out what I <a href="/reading-list">want to read next.</a>
 		</p>
 	</header>