checkmarks 0.2.0__tar.gz → 0.3.0__tar.gz

checkmarks-0.3.0/MANIFEST.in

@@ -0,0 +1,2 @@
+graft tests
+global-exclude __pycache__ *.py[cod]

{checkmarks-0.2.0/src/checkmarks.egg-info → checkmarks-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: checkmarks
-Version: 0.2.0
+Version: 0.3.0
 Summary: Progress dashboard for Markdown checklists
 Author-email: menisadi <menisadi@gmail.com>
 License: MIT License
@@ -39,10 +39,10 @@ A small command-line dashboard for your progress. Point it at a folder of Markdo
 
 ```
 $ checkmarks ~/progress
-Thinking, Fast and Slow  [████------]  143/320 pages   45%
-Gödel, Escher, Bach      [██--------]  180/777 pages   23%
-Rust tutorial            [████------]   12/28  tasks   43%
-NN hands-on              [██--------]    2/8   tasks   25%
+Thinking, Fast and Slow  [████------]  17/38 chapters   45%
+Gödel, Escher, Bach      [██--------]   5/22 chapters   23%
+Rust tutorial            [████------]  12/28 tasks      43%
+NN hands-on              [██--------]   2/8  tasks      25%
 ```
 
 Your Markdown files are the source of truth: checkmarks only reads and reports. It never changes your files and keeps no state of its own.
@@ -96,27 +96,30 @@ By default, checkmarks counts checkboxes:
 - List items can start with `-`, `*`, `+`, `1.` or `1)`.
 - Checkboxes inside fenced code blocks are ignored.
 
-### Counters
+### Big things: break them down
 
-For things that aren't a list of tasks, like the pages of a book, add frontmatter with a `progress` key. It replaces the checkbox count:
+checkmarks only counts checkboxes. To track a book, split it into chapters or page ranges, each one a task small enough to finish in a sitting:
 
 ```markdown
 ---
-progress: 143/320
-unit: pages
+unit: chunks
 ---
 # Dune
+
+- [x] pp. 1–40
+- [x] pp. 41–80
+- [ ] pp. 81–120
+- [ ] pp. 121–160
 ```
 
-Supported keys:
+Supported frontmatter keys:
 
-| Key        | Meaning                                                            |
-|------------|--------------------------------------------------------------------|
-| `progress` | `done/total`, e.g. `143/320`                                       |
-| `unit`     | Label after the count (default `tasks`, or `units` with `progress`) |
-| `title`    | Row title                                                          |
+| Key     | Meaning                                  |
+|---------|------------------------------------------|
+| `unit`  | Label after the count (default `tasks`)  |
+| `title` | Row title                                |
 
-`unit` and `title` also work in checklist files. Other keys are ignored.
+Other keys are ignored.
 
 ### Titles
 
@@ -129,7 +132,7 @@ On a terminal, checkmarks prints the aligned table shown above. Rows at 100% are
 When output is piped, it switches to tab-separated rows with no header:
 
 ```
-title  done  total  pct  unit  mode  status  path
+title  done  total  pct  unit  status  path
 ```
 
 Use `--json` for a JSON array:
@@ -139,18 +142,17 @@ $ checkmarks --json dune.md
 [
   {
     "title": "Dune",
-    "done": 143,
-    "total": 320,
-    "pct": 44.7,
-    "unit": "pages",
-    "mode": "counter",
+    "done": 9,
+    "total": 22,
+    "pct": 40.9,
+    "unit": "chapters",
     "status": "ok",
     "path": "dune.md"
   }
 ]
 ```
 
-`status` is `ok`, `empty` (no checkboxes) or `error` (e.g. an invalid `progress` value). Problems are reported on stderr, and the row is still shown.
+`status` is `ok`, `empty` (no checkboxes) or `error` (the file can't be read). Problems are reported on stderr, and the row is still shown.
 
 Empty files found in folders are hidden; pass `--all` to show them. Files you name directly are always shown.
 
@@ -167,6 +169,11 @@ Empty files found in folders are hidden; pass `--all` to show them. Files you na
 
 Exit code is `0` if at least one file has progress to show, `1` if none does, and `2` for usage errors.
 
+## Upgrading from 0.2
+
+- The `progress: N/M` frontmatter key (counter mode) is gone. Replace it with a checklist of chapters or page ranges.
+- The `mode` column (TSV) and field (JSON) are removed.
+
 ## Upgrading from 0.1
 
 - Output is now a table row per file instead of the old "📊 Progress for:" block.

{checkmarks-0.2.0 → checkmarks-0.3.0}/README.md

@@ -4,10 +4,10 @@ A small command-line dashboard for your progress. Point it at a folder of Markdo
 
 ```
 $ checkmarks ~/progress
-Thinking, Fast and Slow  [████------]  143/320 pages   45%
-Gödel, Escher, Bach      [██--------]  180/777 pages   23%
-Rust tutorial            [████------]   12/28  tasks   43%
-NN hands-on              [██--------]    2/8   tasks   25%
+Thinking, Fast and Slow  [████------]  17/38 chapters   45%
+Gödel, Escher, Bach      [██--------]   5/22 chapters   23%
+Rust tutorial            [████------]  12/28 tasks      43%
+NN hands-on              [██--------]   2/8  tasks      25%
 ```
 
 Your Markdown files are the source of truth: checkmarks only reads and reports. It never changes your files and keeps no state of its own.
@@ -61,27 +61,30 @@ By default, checkmarks counts checkboxes:
 - List items can start with `-`, `*`, `+`, `1.` or `1)`.
 - Checkboxes inside fenced code blocks are ignored.
 
-### Counters
+### Big things: break them down
 
-For things that aren't a list of tasks, like the pages of a book, add frontmatter with a `progress` key. It replaces the checkbox count:
+checkmarks only counts checkboxes. To track a book, split it into chapters or page ranges, each one a task small enough to finish in a sitting:
 
 ```markdown
 ---
-progress: 143/320
-unit: pages
+unit: chunks
 ---
 # Dune
+
+- [x] pp. 1–40
+- [x] pp. 41–80
+- [ ] pp. 81–120
+- [ ] pp. 121–160
 ```
 
-Supported keys:
+Supported frontmatter keys:
 
-| Key        | Meaning                                                            |
-|------------|--------------------------------------------------------------------|
-| `progress` | `done/total`, e.g. `143/320`                                       |
-| `unit`     | Label after the count (default `tasks`, or `units` with `progress`) |
-| `title`    | Row title                                                          |
+| Key     | Meaning                                  |
+|---------|------------------------------------------|
+| `unit`  | Label after the count (default `tasks`)  |
+| `title` | Row title                                |
 
-`unit` and `title` also work in checklist files. Other keys are ignored.
+Other keys are ignored.
 
 ### Titles
 
@@ -94,7 +97,7 @@ On a terminal, checkmarks prints the aligned table shown above. Rows at 100% are
 When output is piped, it switches to tab-separated rows with no header:
 
 ```
-title  done  total  pct  unit  mode  status  path
+title  done  total  pct  unit  status  path
 ```
 
 Use `--json` for a JSON array:
@@ -104,18 +107,17 @@ $ checkmarks --json dune.md
 [
   {
     "title": "Dune",
-    "done": 143,
-    "total": 320,
-    "pct": 44.7,
-    "unit": "pages",
-    "mode": "counter",
+    "done": 9,
+    "total": 22,
+    "pct": 40.9,
+    "unit": "chapters",
     "status": "ok",
     "path": "dune.md"
   }
 ]
 ```
 
-`status` is `ok`, `empty` (no checkboxes) or `error` (e.g. an invalid `progress` value). Problems are reported on stderr, and the row is still shown.
+`status` is `ok`, `empty` (no checkboxes) or `error` (the file can't be read). Problems are reported on stderr, and the row is still shown.
 
 Empty files found in folders are hidden; pass `--all` to show them. Files you name directly are always shown.
 
@@ -132,6 +134,11 @@ Empty files found in folders are hidden; pass `--all` to show them. Files you na
 
 Exit code is `0` if at least one file has progress to show, `1` if none does, and `2` for usage errors.
 
+## Upgrading from 0.2
+
+- The `progress: N/M` frontmatter key (counter mode) is gone. Replace it with a checklist of chapters or page ranges.
+- The `mode` column (TSV) and field (JSON) are removed.
+
 ## Upgrading from 0.1
 
 - Output is now a table row per file instead of the old "📊 Progress for:" block.

{checkmarks-0.2.0 → checkmarks-0.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "checkmarks"
-version = "0.2.0"
+version = "0.3.0"
 description = "Progress dashboard for Markdown checklists"
 authors = [
   { name = "menisadi", email = "menisadi@gmail.com" }

{checkmarks-0.2.0 → checkmarks-0.3.0}/src/checkmarks/parse.py

@@ -7,7 +7,6 @@ from typing import Literal
 CHECKBOX_RE = re.compile(r"^\s*(?:[-*+]|\d+[.)])\s+\[( |x|X)\](?:\s|$)")
 FENCE_RE = re.compile(r"^\s*(`{3,}|~{3,})")
 HEADING_RE = re.compile(r"^#\s+(.+)")
-PROGRESS_RE = re.compile(r"^(\d+)\s*/\s*(\d+)$")
 
 
 @dataclass
@@ -17,7 +16,6 @@ class Item:
     done: int | None
     total: int | None
     unit: str
-    mode: Literal["checklist", "counter"]
     status: Literal["ok", "empty", "error"]
     message: str | None = None
 
@@ -89,20 +87,6 @@ def parse_frontmatter(lines: list[str]) -> tuple[dict[str, str], int]:
     return meta, end + 1
 
 
-def parse_progress(value: str) -> tuple[int, int] | str:
-    """Returns (done, total), or an error message if the value is invalid."""
-    progress_match = PROGRESS_RE.match(value)
-    if not progress_match:
-        return f"unparseable progress: {value!r}"
-
-    done, total = int(progress_match.group(1)), int(progress_match.group(2))
-    if total == 0:
-        return "progress total is 0"
-    if done > total:
-        return f"progress {done}/{total} exceeds total"
-    return done, total
-
-
 def parse_file(path: Path) -> Item:
     """Parses a Markdown file into an Item."""
     try:
@@ -114,7 +98,6 @@ def parse_file(path: Path) -> Item:
             done=None,
             total=None,
             unit="tasks",
-            mode="checklist",
             status="error",
             message=str(e),
         )
@@ -124,18 +107,8 @@ def parse_file(path: Path) -> Item:
     body = lines[body_start:]
     title = meta.get("title") or find_heading(body) or path.stem
 
-    if "progress" in meta:
-        unit = meta.get("unit") or "units"
-        progress = parse_progress(meta["progress"])
-        if isinstance(progress, str):
-            return Item(path, title, None, None, unit, "counter", "error", progress)
-        done, total = progress
-        return Item(path, title, done, total, unit, "counter", "ok")
-
     unit = meta.get("unit") or "tasks"
     done, total = count_checkboxes("\n".join(body))
     if total == 0:
-        return Item(
-            path, title, None, None, unit, "checklist", "empty", "no checkboxes found"
-        )
-    return Item(path, title, done, total, unit, "checklist", "ok")
+        return Item(path, title, None, None, unit, "empty", "no checkboxes found")
+    return Item(path, title, done, total, unit, "ok")

{checkmarks-0.2.0 → checkmarks-0.3.0}/src/checkmarks/render.py

@@ -33,7 +33,6 @@ def render_tsv(items: list[Item]) -> str:
             str(item.total) if ok else "",
             f"{p:.1f}" if ok else "",
             clean(item.unit),
-            item.mode,
             item.status,
             str(item.path),
         ]
@@ -53,7 +52,6 @@ def render_json(items: list[Item]) -> str:
             "total": item.total if ok else None,
             "pct": round(p, 1) if p is not None else None,
             "unit": item.unit,
-            "mode": item.mode,
             "status": item.status,
             "path": str(item.path),
         }

{checkmarks-0.2.0 → checkmarks-0.3.0/src/checkmarks.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: checkmarks
-Version: 0.2.0
+Version: 0.3.0
 Summary: Progress dashboard for Markdown checklists
 Author-email: menisadi <menisadi@gmail.com>
 License: MIT License
@@ -39,10 +39,10 @@ A small command-line dashboard for your progress. Point it at a folder of Markdo
 
 ```
 $ checkmarks ~/progress
-Thinking, Fast and Slow  [████------]  143/320 pages   45%
-Gödel, Escher, Bach      [██--------]  180/777 pages   23%
-Rust tutorial            [████------]   12/28  tasks   43%
-NN hands-on              [██--------]    2/8   tasks   25%
+Thinking, Fast and Slow  [████------]  17/38 chapters   45%
+Gödel, Escher, Bach      [██--------]   5/22 chapters   23%
+Rust tutorial            [████------]  12/28 tasks      43%
+NN hands-on              [██--------]   2/8  tasks      25%
 ```
 
 Your Markdown files are the source of truth: checkmarks only reads and reports. It never changes your files and keeps no state of its own.
@@ -96,27 +96,30 @@ By default, checkmarks counts checkboxes:
 - List items can start with `-`, `*`, `+`, `1.` or `1)`.
 - Checkboxes inside fenced code blocks are ignored.
 
-### Counters
+### Big things: break them down
 
-For things that aren't a list of tasks, like the pages of a book, add frontmatter with a `progress` key. It replaces the checkbox count:
+checkmarks only counts checkboxes. To track a book, split it into chapters or page ranges, each one a task small enough to finish in a sitting:
 
 ```markdown
 ---
-progress: 143/320
-unit: pages
+unit: chunks
 ---
 # Dune
+
+- [x] pp. 1–40
+- [x] pp. 41–80
+- [ ] pp. 81–120
+- [ ] pp. 121–160
 ```
 
-Supported keys:
+Supported frontmatter keys:
 
-| Key        | Meaning                                                            |
-|------------|--------------------------------------------------------------------|
-| `progress` | `done/total`, e.g. `143/320`                                       |
-| `unit`     | Label after the count (default `tasks`, or `units` with `progress`) |
-| `title`    | Row title                                                          |
+| Key     | Meaning                                  |
+|---------|------------------------------------------|
+| `unit`  | Label after the count (default `tasks`)  |
+| `title` | Row title                                |
 
-`unit` and `title` also work in checklist files. Other keys are ignored.
+Other keys are ignored.
 
 ### Titles
 
@@ -129,7 +132,7 @@ On a terminal, checkmarks prints the aligned table shown above. Rows at 100% are
 When output is piped, it switches to tab-separated rows with no header:
 
 ```
-title  done  total  pct  unit  mode  status  path
+title  done  total  pct  unit  status  path
 ```
 
 Use `--json` for a JSON array:
@@ -139,18 +142,17 @@ $ checkmarks --json dune.md
 [
   {
     "title": "Dune",
-    "done": 143,
-    "total": 320,
-    "pct": 44.7,
-    "unit": "pages",
-    "mode": "counter",
+    "done": 9,
+    "total": 22,
+    "pct": 40.9,
+    "unit": "chapters",
     "status": "ok",
     "path": "dune.md"
   }
 ]
 ```
 
-`status` is `ok`, `empty` (no checkboxes) or `error` (e.g. an invalid `progress` value). Problems are reported on stderr, and the row is still shown.
+`status` is `ok`, `empty` (no checkboxes) or `error` (the file can't be read). Problems are reported on stderr, and the row is still shown.
 
 Empty files found in folders are hidden; pass `--all` to show them. Files you name directly are always shown.
 
@@ -167,6 +169,11 @@ Empty files found in folders are hidden; pass `--all` to show them. Files you na
 
 Exit code is `0` if at least one file has progress to show, `1` if none does, and `2` for usage errors.
 
+## Upgrading from 0.2
+
+- The `progress: N/M` frontmatter key (counter mode) is gone. Replace it with a checklist of chapters or page ranges.
+- The `mode` column (TSV) and field (JSON) are removed.
+
 ## Upgrading from 0.1
 
 - Output is now a table row per file instead of the old "📊 Progress for:" block.

{checkmarks-0.2.0 → checkmarks-0.3.0}/src/checkmarks.egg-info/SOURCES.txt

@@ -1,4 +1,5 @@
 LICENSE
+MANIFEST.in
 README.md
 pyproject.toml
 src/checkmarks/__init__.py
@@ -14,4 +15,8 @@ src/checkmarks.egg-info/top_level.txt
 tests/test_cli.py
 tests/test_collect.py
 tests/test_parse.py
-tests/test_render.py
+tests/test_render.py
+tests/fixtures/empty.md
+tests/fixtures/heading_in_fence.md
+tests/fixtures/quoted_title.md
+tests/fixtures/unclosed_frontmatter.md

checkmarks-0.3.0/tests/fixtures/empty.md

@@ -0,0 +1,3 @@
+# Notes
+
+Just prose, no checkboxes.

checkmarks-0.3.0/tests/fixtures/heading_in_fence.md

@@ -0,0 +1,6 @@
+```bash
+# not a title
+- [x] in code
+```
+# Real title
+- [ ] a

checkmarks-0.3.0/tests/fixtures/quoted_title.md

@@ -0,0 +1,6 @@
+---
+title: "Dune: Part One"
+unit: 'chapters'
+---
+# Ignored heading
+- [x] a

checkmarks-0.3.0/tests/fixtures/unclosed_frontmatter.md

@@ -0,0 +1,4 @@
+---
+title: Never closed
+- [x] a
+- [ ] b

{checkmarks-0.2.0 → checkmarks-0.3.0}/tests/test_cli.py

@@ -12,10 +12,10 @@ def tree(tmp_path: Path, monkeypatch: pytest.MonkeyPatch) -> Path:
     """A progress folder, used as the current directory."""
     (tmp_path / "a.md").write_text("# Alpha\n- [x] a\n- [ ] b\n", encoding="utf-8")
     (tmp_path / "b.md").write_text(
-        "---\nprogress: 5/5\n---\n# Beta\n", encoding="utf-8"
+        "---\nunit: chapters\n---\n# Beta\n- [x] a\n", encoding="utf-8"
     )
     (tmp_path / "notes.md").write_text("# Notes\nprose\n", encoding="utf-8")
-    (tmp_path / "bad.md").write_text("---\nprogress: x\n---\n", encoding="utf-8")
+    (tmp_path / "bad.md").write_bytes(b"- [x] caf\xe9\n")
     monkeypatch.chdir(tmp_path)
     monkeypatch.delenv("CHECKMARKS_DIR", raising=False)
     monkeypatch.delenv("NO_COLOR", raising=False)
@@ -31,11 +31,11 @@ def test_default_is_tsv_when_piped(tree: Path, capsys: pytest.CaptureFixture) ->
     assert main([]) == 0
     out, err = capsys.readouterr()
     assert out.splitlines() == [
-        "Alpha\t1\t2\t50.0\ttasks\tchecklist\tok\ta.md",
-        "Beta\t5\t5\t100.0\tunits\tcounter\tok\tb.md",
-        "bad\t\t\t\tunits\tcounter\terror\tbad.md",
+        "Alpha\t1\t2\t50.0\ttasks\tok\ta.md",
+        "Beta\t1\t1\t100.0\tchapters\tok\tb.md",
+        "bad\t\t\t\ttasks\terror\tbad.md",
     ]
-    assert err == "checkmarks: bad.md: unparseable progress: 'x'\n"
+    assert err.startswith("checkmarks: bad.md: ")
 
 
 def test_default_is_pretty_on_tty(
@@ -86,7 +86,7 @@ def test_directory_hides_empty_unless_all(
     main(["."])
     assert "Notes" not in capsys.readouterr().out
     main([".", "--all"])
-    assert "Notes\t\t\t\ttasks\tchecklist\tempty\tnotes.md" in capsys.readouterr().out
+    assert "Notes\t\t\t\ttasks\tempty\tnotes.md" in capsys.readouterr().out
 
 
 def test_explicit_empty_file_shown(tree: Path, capsys: pytest.CaptureFixture) -> None:

{checkmarks-0.2.0 → checkmarks-0.3.0}/tests/test_parse.py

@@ -3,12 +3,10 @@ from pathlib import Path
 import pytest
 
 from checkmarks.parse import (
-    Item,
     count_checkboxes,
     find_heading,
     parse_file,
     parse_frontmatter,
-    parse_progress,
 )
 
 
@@ -93,8 +91,8 @@ FIXTURES = Path(__file__).parent / "fixtures"
 
 
 def test_parse_frontmatter_basic() -> None:
-    meta, body_start = parse_frontmatter(["---", "progress: 1/2", "---", "# T"])
-    assert meta == {"progress": "1/2"}
+    meta, body_start = parse_frontmatter(["---", "unit: pages", "---", "# T"])
+    assert meta == {"unit": "pages"}
     assert body_start == 3
 
 
@@ -124,44 +122,11 @@ def test_parse_frontmatter_quotes(value: str, expected: str) -> None:
     assert meta["title"] == expected
 
 
-@pytest.mark.parametrize(
-    "value,expected",
-    [
-        ("143/320", (143, 320)),
-        ("143 / 320", (143, 320)),
-        ("0/5", (0, 5)),
-        ("5/5", (5, 5)),
-    ],
-)
-def test_parse_progress_valid(value: str, expected: tuple[int, int]) -> None:
-    assert parse_progress(value) == expected
-
-
-@pytest.mark.parametrize("value", ["", "half", "1/", "/2", "-1/5", "1.5/3", "1/2/3"])
-def test_parse_progress_unparseable(value: str) -> None:
-    assert isinstance(parse_progress(value), str)
-
-
-def test_parse_progress_zero_total() -> None:
-    assert parse_progress("0/0") == "progress total is 0"
-
-
-def test_parse_progress_done_exceeds_total() -> None:
-    assert parse_progress("6/5") == "progress 6/5 exceeds total"
-
-
 def test_find_heading_skips_fences() -> None:
     assert find_heading(["```", "# comment", "```", "# Real"]) == "Real"
     assert find_heading(["## Sub", "no heading"]) is None
 
 
-def test_file_counter_mode() -> None:
-    item = parse_file(FIXTURES / "counter.md")
-    assert item == Item(
-        FIXTURES / "counter.md", "Dune", 143, 320, "pages", "counter", "ok"
-    )
-
-
 def test_file_bom_and_crlf(tmp_path: Path) -> None:
     # Written here, not as a fixture, so git's autocrlf can't strip the CRLFs
     md_file = tmp_path / "bom_crlf.md"
@@ -175,33 +140,18 @@ def test_file_bom_and_crlf(tmp_path: Path) -> None:
 def test_file_unclosed_frontmatter_is_markdown() -> None:
     item = parse_file(FIXTURES / "unclosed_frontmatter.md")
     assert item.title == "unclosed_frontmatter"
-    assert (item.done, item.total, item.mode) == (1, 2, "checklist")
+    assert (item.done, item.total) == (1, 2)
 
 
 def test_file_frontmatter_title_wins_over_heading() -> None:
     item = parse_file(FIXTURES / "quoted_title.md")
     assert item.title == "Dune: Part One"
     assert item.unit == "chapters"
-    assert item.mode == "checklist"
-
-
-def test_file_bad_progress_is_error() -> None:
-    item = parse_file(FIXTURES / "bad_progress.md")
-    assert (item.mode, item.status) == ("counter", "error")
-    assert (item.done, item.total) == (None, None)
-    assert item.title == "Bad progress"
-    assert item.unit == "units"
-    assert item.message is not None
 
 
 def test_file_without_checkboxes_is_empty() -> None:
     item = parse_file(FIXTURES / "empty.md")
-    assert (item.mode, item.status, item.done, item.total) == (
-        "checklist",
-        "empty",
-        None,
-        None,
-    )
+    assert (item.status, item.done, item.total) == ("empty", None, None)
     assert item.unit == "tasks"
 
 
@@ -213,7 +163,7 @@ def test_file_heading_inside_fence_is_not_title() -> None:
 
 def test_file_missing_is_error(tmp_path: Path) -> None:
     item = parse_file(tmp_path / "missing.md")
-    assert (item.mode, item.status, item.title) == ("checklist", "error", "missing")
+    assert (item.status, item.title) == ("error", "missing")
 
 
 def test_file_invalid_utf8_is_error(tmp_path: Path) -> None:
@@ -221,10 +171,3 @@ def test_file_invalid_utf8_is_error(tmp_path: Path) -> None:
     md_file.write_bytes(b"- [x] caf\xe9\n")
     item = parse_file(md_file)
     assert item.status == "error"
-
-
-def test_file_empty_progress_value_is_error(tmp_path: Path) -> None:
-    md_file = tmp_path / "p.md"
-    md_file.write_text("---\nprogress:\n---\n- [x] a\n", encoding="utf-8")
-    item = parse_file(md_file)
-    assert (item.mode, item.status) == ("counter", "error")

{checkmarks-0.2.0 → checkmarks-0.3.0}/tests/test_render.py

@@ -14,11 +14,9 @@ from checkmarks.render import (
     truncate,
 )
 
-OK = Item(Path("books/dune.md"), "Dune", 143, 320, "pages", "counter", "ok")
-EMPTY = Item(
-    Path("notes.md"), "Notes", None, None, "tasks", "checklist", "empty", "no boxes"
-)
-ERROR = Item(Path("bad.md"), "Bad", None, None, "units", "counter", "error", "oops")
+OK = Item(Path("books/dune.md"), "Dune", 143, 320, "pages", "ok")
+EMPTY = Item(Path("notes.md"), "Notes", None, None, "tasks", "empty", "no boxes")
+ERROR = Item(Path("bad.md"), "Bad", None, None, "tasks", "error", "oops")
 
 
 def bar_of(line: str) -> str:
@@ -30,15 +28,15 @@ def bar_of(line: str) -> str:
 
 def test_tsv_rows() -> None:
     assert render_tsv([OK, EMPTY, ERROR]).splitlines() == [
-        "Dune\t143\t320\t44.7\tpages\tcounter\tok\tbooks/dune.md",
-        "Notes\t\t\t\ttasks\tchecklist\tempty\tnotes.md",
-        "Bad\t\t\t\tunits\tcounter\terror\tbad.md",
+        "Dune\t143\t320\t44.7\tpages\tok\tbooks/dune.md",
+        "Notes\t\t\t\ttasks\tempty\tnotes.md",
+        "Bad\t\t\t\ttasks\terror\tbad.md",
     ]
 
 
 def test_tsv_cleans_title_and_unit() -> None:
-    item = Item(Path("a.md"), "A\tB\nC\r", 1, 2, "x\ty", "checklist", "ok")
-    assert render_tsv([item]) == "A B C \t1\t2\t50.0\tx y\tchecklist\tok\ta.md\n"
+    item = Item(Path("a.md"), "A\tB\nC\r", 1, 2, "x\ty", "ok")
+    assert render_tsv([item]) == "A B C \t1\t2\t50.0\tx y\tok\ta.md\n"
 
 
 def test_tsv_empty_list() -> None:
@@ -56,7 +54,6 @@ def test_json_rows() -> None:
         "total": 320,
         "pct": 44.7,
         "unit": "pages",
-        "mode": "counter",
         "status": "ok",
         "path": "books/dune.md",
     }
@@ -66,7 +63,7 @@ def test_json_rows() -> None:
 
 
 def test_json_keeps_unicode() -> None:
-    item = Item(Path("g.md"), "Gödel", 1, 2, "pages", "counter", "ok")
+    item = Item(Path("g.md"), "Gödel", 1, 2, "pages", "ok")
     assert "Gödel" in render_json([item])
 
 
@@ -106,11 +103,11 @@ def test_pretty_pct(done: int, total: int, expected: int) -> None:
 
 def test_pretty_spec_example() -> None:
     items = [
-        Item(Path("a"), "Thinking, Fast and Slow", 143, 320, "pages", "counter", "ok"),
-        Item(Path("b"), "Gödel, Escher, Bach", 180, 777, "pages", "counter", "ok"),
-        Item(Path("c"), "Rust tutorial", 12, 28, "tasks", "checklist", "ok"),
-        Item(Path("d"), "NN hands-on", 2, 8, "tasks", "checklist", "ok"),
-        Item(Path("e"), "Broken file", None, None, "units", "counter", "error"),
+        Item(Path("a"), "Thinking, Fast and Slow", 143, 320, "pages", "ok"),
+        Item(Path("b"), "Gödel, Escher, Bach", 180, 777, "pages", "ok"),
+        Item(Path("c"), "Rust tutorial", 12, 28, "tasks", "ok"),
+        Item(Path("d"), "NN hands-on", 2, 8, "tasks", "ok"),
+        Item(Path("e"), "Broken file", None, None, "tasks", "error"),
     ]
     assert render_pretty(items, 50, False).splitlines() == [
         "Thinking, Fast…  [████------]  143/320 pages   45%",
@@ -126,7 +123,7 @@ def test_pretty_lines_fit_width() -> None:
         OK,
         EMPTY,
         ERROR,
-        Item(Path("w"), "日本語の本" * 5, 1, 2, "p", "counter", "ok"),
+        Item(Path("w"), "日本語の本" * 5, 1, 2, "p", "ok"),
     ]
     for width in (50, 60, 80):
         lines = render_pretty(items, width, False).splitlines()
@@ -134,7 +131,7 @@ def test_pretty_lines_fit_width() -> None:
 
 
 def test_pretty_columns_align() -> None:
-    items = [OK, EMPTY, ERROR, Item(Path("w"), "日本", 1, 2, "p", "counter", "ok")]
+    items = [OK, EMPTY, ERROR, Item(Path("w"), "日本", 1, 2, "p", "ok")]
     lines = render_pretty(items, 80, False).splitlines()
     starts = {display_width(line[: line.index("[")]) for line in lines}
     widths = {display_width(line) for line in lines}
@@ -153,7 +150,7 @@ def test_pretty_bar_min_width() -> None:
 
 
 def test_pretty_bar_is_floored() -> None:
-    item = Item(Path("a"), "A", 319, 320, "pages", "counter", "ok")
+    item = Item(Path("a"), "A", 319, 320, "pages", "ok")
     line = render_pretty([item], 200, False).splitlines()[0]
     assert bar_of(line) == "█" * 39 + "-"
     assert line.endswith(" 99%")
@@ -173,14 +170,14 @@ def test_pretty_only_non_ok_rows() -> None:
 
 
 def test_pretty_color_only_when_complete() -> None:
-    complete = Item(Path("a"), "A", 5, 5, "tasks", "checklist", "ok")
+    complete = Item(Path("a"), "A", 5, 5, "tasks", "ok")
     out = render_pretty([OK, complete, ERROR], 60, True).splitlines()
     assert out[1].startswith(GREEN)
     assert "\033[" not in out[0] + out[2]
 
 
 def test_pretty_no_color() -> None:
-    complete = Item(Path("a"), "A", 5, 5, "tasks", "checklist", "ok")
+    complete = Item(Path("a"), "A", 5, 5, "tasks", "ok")
     assert "\033[" not in render_pretty([complete], 60, False)