ci: add codecov (st3v3nmw#1131)

open-spaced-repetition · Oct 15, 2024 · b0b5b84 · b0b5b84
1 parent 1c0f685
commit b0b5b84
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 7 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -24,3 +24,8 @@ jobs:
 
             - name: Test
               run: pnpm test
+
+            - name: Upload results to Codecov
+              uses: codecov/codecov-action@v4
+              with:
+                  token: ${{ secrets.CODECOV_TOKEN }}
diff --git a/README.md b/README.md
@@ -1,8 +1,8 @@
-# Flashcard-Based and Note-Based Spaced Repetition Plugin
+# Obsidian Spaced Repetition Plugin
 
-<img src="https://img.shields.io/github/downloads/st3v3nmw/obsidian-spaced-repetition/total" /> <img src="https://img.shields.io/github/downloads/st3v3nmw/obsidian-spaced-repetition/latest/total?style=flat-square" /> <img src="https://img.shields.io/github/manifest-json/v/st3v3nmw/obsidian-spaced-repetition?style=flat-square" />
+<img src="https://img.shields.io/github/downloads/st3v3nmw/obsidian-spaced-repetition/total" /> <img src="https://img.shields.io/github/downloads/st3v3nmw/obsidian-spaced-repetition/latest/total?style=flat-square" /> <img src="https://img.shields.io/github/manifest-json/v/st3v3nmw/obsidian-spaced-repetition?style=flat-square" /> <img alt="Codecov" src="https://img.shields.io/codecov/c/gh/st3v3nmw/obsidian-spaced-repetition">
 
-Fight the forgetting curve & note aging by reviewing flashcards & notes using spaced repetition on Obsidian.md
+Fight the forgetting curve by reviewing flashcards & notes using spaced repetition.
 
 -   Check the documentation [here](https://www.stephenmwangi.com/obsidian-spaced-repetition/).
 -   Check the [roadmap](https://github.com/st3v3nmw/obsidian-spaced-repetition/projects/3/) for upcoming features & fixes.

diff --git a/codecov.yml b/codecov.yml
@@ -0,0 +1,12 @@
+coverage:
+    range: 90..100
+    round: down
+    precision: 2
+    status:
+        project: off
+        patch:
+            default:
+                target: 100
+                threshold: 0.0
+                only_pulls: true
+        changes: off
diff --git a/src/parser.ts b/src/parser.ts
@@ -112,12 +112,12 @@ export function parse(text: string, options: ParserOptions): ParsedQuestionInfo[
             continue;
         }
 
-        // Have we reached a card end marker?
+        // Have we reached the end of a card?
         const isEmptyLine = currentTrimmed.length == 0;
         const hasMultilineCardEndMarker =
             options.multilineCardEndMarker && currentTrimmed == options.multilineCardEndMarker;
         if (
-            // We've possibly reached the end of a card
+            // We've probably reached the end of a card
             (isEmptyLine && !options.multilineCardEndMarker) ||
             // Empty line & we're not picking up any card
             (isEmptyLine && cardText.length == 0) ||

diff --git a/tests/unit/parser.test.ts b/tests/unit/parser.test.ts
@@ -636,14 +636,14 @@ test("Test parsing cards with codeblocks", () => {
     expect(
         parseT(
             "How do you ... Python?\n?\n" +
-                "```\nprint('Hello World!')\n\n\nprint('Howdy?')\n\nlambda x: x[0]\n```",
+                "```python\nprint('Hello World!')\n\n\nprint('Howdy?')\n\nlambda x: x[0]\n```",
             parserOptions,
         ),
     ).toEqual([
         [
             CardType.MultiLineBasic,
             "How do you ... Python?\n?\n" +
-                "```\nprint('Hello World!')\n\n\nprint('Howdy?')\n\nlambda x: x[0]\n```",
+                "```python\nprint('Hello World!')\n\n\nprint('Howdy?')\n\nlambda x: x[0]\n```",
             0,
             9,
         ],