add csv decks support

README.md

@@ -12,14 +12,16 @@ https://docs.deno.com/runtime/manual/getting_started/installation/
 
 It uses a simple deck format to create flashcards:
 
-```yaml
-cards:
-  - f: Front side
-    b: Back side
-  - f: Front side
-    b: Back side
+```csv
+Question,Answer
+Front side,Back side
+Front side,Back side
 ```
 
+> [!TIP]\
+> This is the format of Brainscape CSV export, so they can be used by Termilingo
+> directly.
+
 ## Scoring system
 
 Termilingo does not rely on self-assessed scores. Instead, it uses an automated
@@ -85,20 +87,10 @@ plt.show()
 Run with an example deck:
 
 ```sh
-deno task run --deck example-deck.yaml
+deno task run --deck example-swedish.csv
 ```
 
 Provide a path to your own deck and start practicing.
 
 On the first run, the app will create a complimentary review file following a
 convention `<deck-name>.review.yaml` to keep track of the state.
-
-## Tools
-
-### Brainscape importer
-
-To convert a CSV exported from Brainscape, run:
-
-```sh
-deno task brainscape-importer
-```

deno.json

@@ -2,6 +2,7 @@
   "tasks": {
     "run": "deno run --allow-read --allow-write --allow-env=NODE_ENV src/cli.ts",
     "brainscape-importer": "deno run --allow-read src/tools/brainscape/importer.ts",
+    "test": "deno test src/",
     "test-lcov": "./scripts/test-lcov.sh"
   },
   "imports": {

example-swedish.csv

@@ -0,0 +1,7 @@
+Question,Answer
+a dog,en hund
+the dog,hunden
+a cat,en katt
+the cat,katten
+a house,ett hus
+the house,huset

src/card.ts

@@ -1,5 +1,3 @@
-import { parse as parseYaml } from "@std/yaml";
-
 interface CardYaml {
   f: string;
   b: string;
@@ -10,14 +8,4 @@ interface Card {
   back: string;
 }
 
-async function loadDeck(filename: string): Promise<Card[]> {
-  const s = await Deno.readTextFile(filename);
-
-  const { cards } = parseYaml(s) as { cards: CardYaml[] };
-
-  return cards.map(({ f, b }) => ({ front: f, back: b }));
-}
-
 export type { Card, CardYaml };
-
-export { loadDeck };

src/cli.ts

@@ -2,7 +2,7 @@ import { Input } from "@cliffy/prompt";
 import { parseArgs } from "@std/cli/parse-args";
 import { green, red, yellow } from "@std/fmt/colors";
 import { basename, dirname, join } from "@std/path";
-import { loadDeck } from "./card.ts";
+import { loadDeck } from "./deck.ts";
 import { shuffle } from "./collections.ts";
 import { ratio } from "./levenshtein.ts";
 import {

src/deck.ts

@@ -0,0 +1,49 @@
+import { extname } from "@std/path";
+import { parse as parseYaml } from "@std/yaml";
+import { Card, CardYaml } from "./card.ts";
+import { parse as parseCsv } from "@std/csv";
+
+async function loadDeck(filename: string): Promise<Card[]> {
+  const ext = extname(filename);
+
+  switch (ext) {
+    case ".yaml":
+      return await loadYamlDeck(filename);
+    case ".csv":
+      return await loadCsvDeck(filename);
+    default:
+      throw `unsupported extension: ${ext}`;
+  }
+}
+
+async function loadYamlDeck(filename: string): Promise<Card[]> {
+  const s = await Deno.readTextFile(filename);
+
+  const { cards } = parseYaml(s) as { cards: CardYaml[] };
+
+  return cards.map(({ f, b }) => ({ front: f, back: b }));
+}
+
+type CsvCard = {
+  Question: string;
+  Answer: string;
+};
+
+async function loadCsvDeck(filename: string): Promise<Card[]> {
+  const csvContent = await Deno.readTextFile(filename);
+
+  const parsedCsv = parseCsv(
+    csvContent,
+    {
+      header: true,
+      skipFirstRow: true,
+    },
+  ) as CsvCard[];
+
+  return parsedCsv.map((row) => ({
+    front: row.Question,
+    back: row.Answer,
+  }));
+}
+
+export { loadDeck };