text-compositor 0.4.1__tar.gz → 0.4.2__tar.gz

{text_compositor-0.4.1 → text_compositor-0.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: text-compositor
-Version: 0.4.1
+Version: 0.4.2
 Summary: A tool for composing multiple text files into a PDF document.
 License-Expression: MIT
 Project-URL: Repository, https://github.com/tokudiro/text-compositor
@@ -87,13 +87,13 @@ This is only needed if your source documents use ` ```mermaid ` fences (or speci
 
 ```bash
 pipx install "text-compositor[mermaid]"
-# or, if already installed: pipx inject text-compositor playwright==1.62.0
+# or, if already installed: pipx inject text-compositor playwright==1.63.0
 ```
 
 With Option B (clone and run directly):
 
 ```bash
-pip install playwright==1.62.0
+pip install playwright==1.63.0
 ```
 
 - **A Google Chrome or Microsoft Edge installation already present on your system** (no new download by default; it's auto-detected and reused at build time)
@@ -175,7 +175,7 @@ with Session() as session:  # reuses the Mermaid browser and the Typst compiler
     print(result.ok, result.pdf_path, [d.message for d in result.diagnostics])
 ```
 
-`session.render_html("doc.md")` (experimental, [#161](https://github.com/tokudiro/text-compositor/issues/161)) writes a self-contained HTML file instead. Diagrams (Mermaid, PlantUML, D2, Structurizr, Graphviz, Pikchr, CeTZ, Fletcher, timeliney, `svg`) become images next to it. `typst-exec` and raw HTML are not supported yet and are shown as code with a warning. Graphviz, Pikchr, CeTZ, Fletcher and timeliney are drawn with the Typst packages `diagraph`, `kip`, `cetz`, `fletcher` and `timeliney`, the same as in the PDF (Graphviz's `shape=record` and a graph-level `label` cannot be drawn and produce a warning).
+`session.render_html("doc.md")` (experimental, [#161](https://github.com/tokudiro/text-compositor/issues/161)) writes a self-contained HTML file instead. Diagrams (Mermaid, PlantUML, D2, Structurizr, Graphviz, Pikchr, CeTZ, Fletcher, timeliney, Vega-Lite, Vega, `svg`) become images next to it. `typst-exec` and raw HTML are not supported yet and are shown as code with a warning. Graphviz, Pikchr, CeTZ, Fletcher and timeliney are drawn with the Typst packages `diagraph`, `kip`, `cetz`, `fletcher` and `timeliney`, the same as in the PDF (Graphviz's `shape=record` and a graph-level `label` cannot be drawn and produce a warning).
 
 See [sample/text-compositor.config.yaml](sample/text-compositor.config.yaml) for how to write the config file, and the [usage guide](doc/usage/) for details on `document:`/`plugins:`, front matter, Marp directives, and more. The Markdown files listed in `chapters` are concatenated in order to produce the PDF.
 

{text_compositor-0.4.1 → text_compositor-0.4.2}/README.md

@@ -69,13 +69,13 @@ This is only needed if your source documents use ` ```mermaid ` fences (or speci
 
 ```bash
 pipx install "text-compositor[mermaid]"
-# or, if already installed: pipx inject text-compositor playwright==1.62.0
+# or, if already installed: pipx inject text-compositor playwright==1.63.0
 ```
 
 With Option B (clone and run directly):
 
 ```bash
-pip install playwright==1.62.0
+pip install playwright==1.63.0
 ```
 
 - **A Google Chrome or Microsoft Edge installation already present on your system** (no new download by default; it's auto-detected and reused at build time)
@@ -157,7 +157,7 @@ with Session() as session:  # reuses the Mermaid browser and the Typst compiler
     print(result.ok, result.pdf_path, [d.message for d in result.diagnostics])
 ```
 
-`session.render_html("doc.md")` (experimental, [#161](https://github.com/tokudiro/text-compositor/issues/161)) writes a self-contained HTML file instead. Diagrams (Mermaid, PlantUML, D2, Structurizr, Graphviz, Pikchr, CeTZ, Fletcher, timeliney, `svg`) become images next to it. `typst-exec` and raw HTML are not supported yet and are shown as code with a warning. Graphviz, Pikchr, CeTZ, Fletcher and timeliney are drawn with the Typst packages `diagraph`, `kip`, `cetz`, `fletcher` and `timeliney`, the same as in the PDF (Graphviz's `shape=record` and a graph-level `label` cannot be drawn and produce a warning).
+`session.render_html("doc.md")` (experimental, [#161](https://github.com/tokudiro/text-compositor/issues/161)) writes a self-contained HTML file instead. Diagrams (Mermaid, PlantUML, D2, Structurizr, Graphviz, Pikchr, CeTZ, Fletcher, timeliney, Vega-Lite, Vega, `svg`) become images next to it. `typst-exec` and raw HTML are not supported yet and are shown as code with a warning. Graphviz, Pikchr, CeTZ, Fletcher and timeliney are drawn with the Typst packages `diagraph`, `kip`, `cetz`, `fletcher` and `timeliney`, the same as in the PDF (Graphviz's `shape=record` and a graph-level `label` cannot be drawn and produce a warning).
 
 See [sample/text-compositor.config.yaml](sample/text-compositor.config.yaml) for how to write the config file, and the [usage guide](doc/usage/) for details on `document:`/`plugins:`, front matter, Marp directives, and more. The Markdown files listed in `chapters` are concatenated in order to produce the PDF.
 

{text_compositor-0.4.1 → text_compositor-0.4.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "text-compositor"
-version = "0.4.1"
+version = "0.4.2"
 description = "A tool for composing multiple text files into a PDF document."
 readme = "README.md"
 license = "MIT"

{text_compositor-0.4.1 → text_compositor-0.4.2}/tests/test_bundled_diagram_tools.py

@@ -143,3 +143,9 @@ def test_build_dist_pins_the_same_java_plantuml_d2_structurizr_and_mermaid_as_th
 
     assert deps_mod.MERMAID_JS_URL in script
     assert deps_mod.MERMAID_JS_SHA256 in script
+
+    # Vega・Vega-Lite（#351）
+    assert deps_mod.VEGA_JS_URL in script
+    assert deps_mod.VEGA_JS_SHA256 in script
+    assert deps_mod.VEGA_LITE_JS_URL in script
+    assert deps_mod.VEGA_LITE_JS_SHA256 in script

text_compositor-0.4.2/tests/test_cli_single_markdown.py

@@ -0,0 +1,129 @@
+"""CLI: 単一のMarkdownファイルを直接指定してPDFにする（`text-compositor FILE.md`、#179）のテスト。"""
+import os
+import sys
+
+import pytest
+
+import text_compositor.build as build_mod
+from text_compositor import log
+import text_compositor.project as project_mod
+from text_compositor.build import _single_markdown_output, parse_args
+
+
+@pytest.fixture(autouse=True)
+def _restore_verbosity():
+    """`build()`は、-q/-vを、プロセスグローバルへ反映する。他のテストへ、残さない。"""
+    yield
+    log.set_verbosity(False, False)
+
+
+def parse(monkeypatch, *argv):
+    monkeypatch.setattr(sys, "argv", ["text-compositor", *argv])
+    return parse_args()
+
+
+class TestParseArgs:
+    def test_a_single_file_with_output_and_template(self, monkeypatch):
+        args = parse(monkeypatch, "doc.md", "-o", "out.pdf", "-t", "slide", "-q", "--keep-temp")
+        assert (args.markdown, args.output, args.template, args.quiet, args.keep_temp) == ("doc.md", "out.pdf", "slide", True, True)
+
+    def test_existing_usage_without_a_file_is_unchanged(self, monkeypatch):
+        args = parse(monkeypatch, "--config", "c.yaml", "--if-changed")
+        assert args.markdown is None and args.config == "c.yaml" and args.if_changed
+
+    @pytest.mark.parametrize("flags", [
+        ["--config", "c.yaml"], ["--config-list", "l.txt"], ["--check-env"], ["--watch"], ["--if-changed"],
+        ["--clean"], ["--clean-cache"],
+    ])
+    def test_options_that_need_a_config_cannot_be_combined_with_a_file(self, monkeypatch, capsys, flags):
+        with pytest.raises(SystemExit) as e:
+            parse(monkeypatch, "doc.md", *flags)
+        assert e.value.code == 2
+        assert "同時に指定できません" in capsys.readouterr().err
+
+    @pytest.mark.parametrize("flags", [["-o", "out.pdf"], ["-t", "slide"]])
+    def test_output_and_template_need_a_file(self, monkeypatch, capsys, flags):
+        with pytest.raises(SystemExit) as e:
+            parse(monkeypatch, *flags)
+        assert e.value.code == 2 and "FILE.md" in capsys.readouterr().err
+
+    def test_only_markdown_files_are_accepted(self, monkeypatch, capsys):
+        with pytest.raises(SystemExit) as e:
+            parse(monkeypatch, "notes.txt")
+        assert e.value.code == 2
+        assert parse(monkeypatch, "A.MD").markdown == "A.MD" and parse(monkeypatch, "a.markdown").markdown == "a.markdown"
+
+
+class TestOutputPath:
+    def test_the_default_is_next_to_the_manuscript(self, tmp_path):
+        md = str(tmp_path / "sub" / "note.md")
+        assert _single_markdown_output(md, None) == str(tmp_path / "sub" / "note.pdf")
+
+    def test_an_explicit_file_and_a_folder(self, tmp_path, monkeypatch):
+        monkeypatch.chdir(tmp_path)
+        md = str(tmp_path / "note.md")
+        assert _single_markdown_output(md, "out.pdf") == str(tmp_path / "out.pdf")
+        (tmp_path / "existing").mkdir()
+        assert _single_markdown_output(md, "existing") == str(tmp_path / "existing" / "note.pdf")
+        assert _single_markdown_output(md, "new" + os.sep) == str(tmp_path / "new" / "note.pdf")
+
+
+class TestBuildSingleMarkdown:
+    @pytest.fixture
+    def calls(self, monkeypatch):
+        recorded = []
+        monkeypatch.setattr(project_mod, "_build_project", lambda *a, **k: recorded.append((a, k)))
+        return recorded
+
+    def run(self, tmp_path, *argv, monkeypatch):
+        monkeypatch.setattr(build_mod, "check_typst_version", lambda *a: None)
+        monkeypatch.setattr(build_mod, "ensure_fonts", lambda: "fonts")
+        monkeypatch.setattr(sys, "argv", ["text-compositor", *argv])
+        build_mod.build()
+
+    def test_it_builds_the_api_config_and_writes_next_to_the_manuscript(self, tmp_path, calls, monkeypatch):
+        md = tmp_path / "note.md"
+        md.write_text("# T\n", encoding="utf-8")
+        self.run(tmp_path, str(md), monkeypatch=monkeypatch)
+        (args, kwargs), = calls
+        project_dir, config, chapters = args[3], args[4], args[5]
+        assert project_dir == str(tmp_path) and chapters == ["note.md"]
+        assert config["document"]["cover"] == "markdown" and config["document"]["title"] == "note"   # APIと同じ既定
+        assert config["template"]["path"] == "template"
+        assert kwargs["out_pdf"] == str(tmp_path / "note.pdf")
+
+    def test_the_template_name_and_a_typ_path_relative_to_the_cwd(self, tmp_path, calls, monkeypatch):
+        md = tmp_path / "note.md"
+        md.write_text("# T\n", encoding="utf-8")
+        monkeypatch.chdir(tmp_path)
+        self.run(tmp_path, "note.md", "-t", "paper", monkeypatch=monkeypatch)
+        self.run(tmp_path, "note.md", "-t", "my/own.typ", "-o", "build/o.pdf", monkeypatch=monkeypatch)
+        assert calls[0][0][4]["template"]["path"] == "paper"
+        assert calls[1][0][4]["template"]["path"] == str(tmp_path / "my" / "own.typ")
+        assert calls[1][1]["out_pdf"] == str(tmp_path / "build" / "o.pdf") and (tmp_path / "build").is_dir()
+
+    def test_a_missing_file_and_an_unknown_template_fail_with_exit_code_1(self, tmp_path, calls, monkeypatch, capsys):
+        with pytest.raises(SystemExit) as e:
+            self.run(tmp_path, str(tmp_path / "nope.md"), monkeypatch=monkeypatch)
+        assert e.value.code == 1 and "Markdown file not found" in capsys.readouterr().out
+        md = tmp_path / "note.md"
+        md.write_text("# T\n", encoding="utf-8")
+        with pytest.raises(SystemExit) as e:
+            self.run(tmp_path, str(md), "-t", "nosuch", monkeypatch=monkeypatch)
+        assert e.value.code == 1 and "Unknown template" in capsys.readouterr().out
+        assert calls == []
+
+
+def test_a_real_pdf_is_built_without_a_config(tmp_path, monkeypatch):
+    """実際に、configなしで、PDFができる（Typstとフォントが、ある環境）。先頭の見出しは、表紙に落とされず、本文に残る。"""
+    from text_compositor.deps import ensure_fonts
+    try:
+        ensure_fonts()
+    except SystemExit:
+        pytest.skip("fonts are not available")
+    md = tmp_path / "note.md"
+    md.write_text("# 見出し\n\n本文です。\n", encoding="utf-8")
+    monkeypatch.setattr(sys, "argv", ["text-compositor", str(md), "-q"])
+    build_mod.build()
+    pdf = tmp_path / "note.pdf"
+    assert pdf.is_file() and pdf.read_bytes().startswith(b"%PDF")

{text_compositor-0.4.1 → text_compositor-0.4.2}/tests/test_emphasis_lint.py

@@ -93,7 +93,7 @@ class TestHtmlOutput:
     def test_the_text_is_still_shown(self, tmp_path):
         result, _ = _html_warnings(tmp_path, "これは**「重要」**です。\n")
         with open(result.html_path, encoding="utf-8") as f:
-            assert "<p>これは**「重要」**です。</p>" in f.read()
+            assert '<p data-line="1">これは**「重要」**です。</p>' in f.read()
 
     def test_a_table_cell_and_a_list_item_are_checked(self, tmp_path):
         text = "| a | b |\n| - | - |\n| **「x」**です | y |\n\n- 項目**（仮）**です\n"

text_compositor-0.4.2/tests/test_html_line_numbers.py

@@ -0,0 +1,94 @@
+"""HTML出力の、ブロック要素の`data-line`（原稿の行番号。Viewerが、ツールバーに出す。#328・#357）のテスト。"""
+import re
+
+import pytest
+
+from text_compositor.api import render_html
+from text_compositor.html_output import DOCUMENT_CSS, _with_data_line
+
+PLAIN = {"mermaid": False, "plantuml": False, "d2": False}
+
+DOC = """# 見出し
+
+段落その1です。
+続きの行。
+
+- 項目A
+- 項目B
+  - 入れ子B1
+
+1. 番号1
+
+   ゆるい段落
+
+> 引用の段落
+
+| a | b |
+| - | - |
+| 1 | 2 |
+
+```python
+print(1)
+```
+
+$$
+a=b
+$$
+
+最後の段落。
+"""
+
+
+def lines_by_tag(tmp_path, markdown):
+    md = tmp_path / "doc.md"
+    md.write_text(markdown, encoding="utf-8")
+    result = render_html(str(md), plugins=PLAIN)
+    assert result.ok, result.diagnostics
+    html = open(result.html_path, encoding="utf-8").read()
+    body = html[html.index("<body"):]
+    return [(m.group(1), int(m.group(2))) for m in re.finditer(r'<(\w+)[^>]*\sdata-line="(\d+)"', body)], body
+
+
+def test_block_elements_carry_their_manuscript_line(tmp_path):
+    found, _ = lines_by_tag(tmp_path, DOC)
+    assert found == [
+        ("h1", 1), ("p", 3),
+        ("li", 6), ("li", 7), ("li", 8),      # 緊密なリスト: 項目が持つ（中の段落は、隠れている）
+        ("p", 10), ("p", 12),                 # ゆるいリスト: 項目ではなく、中の段落が持つ
+        ("p", 14),                            # 引用: 中の段落が持つ
+        ("table", 16), ("pre", 20), ("div", 24),   # 表・フェンス・数式
+        ("p", 28),
+    ]
+
+
+def test_a_diagram_fence_carries_the_line_on_its_wrapper(tmp_path):
+    svg = tmp_path / "x.svg"
+    svg.write_text('<svg xmlns="http://www.w3.org/2000/svg" width="10" height="10"></svg>', encoding="utf-8")
+    found, body = lines_by_tag(tmp_path, "# T\n\n```svg\n" + svg.read_text(encoding="utf-8") + "\n```\n")
+    assert ("div", 3) in found and '<div data-line="3" class="diagram diagram-svg">' in body
+
+
+def test_a_line_is_not_added_twice_or_to_the_wrong_element(tmp_path):
+    _, body = lines_by_tag(tmp_path, DOC)
+    assert len(re.findall(r'data-line="10"', body)) == 1 and len(re.findall(r'data-line="6"', body)) == 1
+    assert "<hr" not in body or 'hr data-line' not in body
+
+
+class TestWithDataLine:
+    def test_it_adds_the_line_to_the_first_tag_only(self):
+        assert _with_data_line('<div class="a"><p>x</p></div>\n', 7) == '<div data-line="7" class="a"><p>x</p></div>\n'
+
+    @pytest.mark.parametrize("html,line", [('<pre>x</pre>', None), ('<pre>x</pre>', 0), ('text', 3), ('', 3)])
+    def test_it_leaves_html_without_a_line_or_a_leading_tag_alone(self, html, line):
+        assert _with_data_line(html, line) == html
+
+
+class TestNoBadgeCss:
+    """行番号は、ツールバーに出す（#357）。文書のCSSには、バッジ（疑似要素）を、持たせない。"""
+
+    def test_the_document_css_has_no_badge(self):
+        assert "data-line-badge" not in DOCUMENT_CSS and "attr(data-line)" not in DOCUMENT_CSS
+
+    def test_the_document_still_has_no_script(self, tmp_path):
+        _, body = lines_by_tag(tmp_path, DOC)
+        assert "<script" not in body

{text_compositor-0.4.1 → text_compositor-0.4.2}/tests/test_html_output.py

@@ -76,7 +76,7 @@ class TestApi:
         assert result.html_path == str(tmp_path / ".text-compositor" / "preview.html")
         assert html.startswith("<!DOCTYPE html>")
         assert "<title>見出し</title>" in html
-        assert "<h1>見出し</h1>" in html
+        assert '<h1 data-line="1">見出し</h1>' in html
         assert "<script" not in html
         # スクリプトは、ブラウザ側でも禁止する（Viewerは、JavaScriptを有効にしたビューで開く）
         assert "script-src 'none'" in html and "object-src 'none'" in html
@@ -142,7 +142,7 @@ class TestMarkdown:
         assert "<strong>b</strong>" in b and "<em>i</em>" in b and "<s>s</s>" in b and "<code>c</code>" in b
         assert '<a href="https://example.com">l</a>' in b
         assert "<ul>" in b and "<ol>" in b
-        assert '<pre><code class="language-python">print(1)\n</code></pre>' in b
+        assert re.search(r'<pre data-line="\d+"><code class="language-python">print\(1\)\n</code></pre>', b)
 
     def test_line_breaks_are_kept_like_the_pdf(self, tmp_path):
         _, html = convert(tmp_path, "one\ntwo\n")
@@ -467,12 +467,12 @@ class TestFences:
 
     def test_a_disabled_plugin_falls_back_to_code_without_a_warning(self, tmp_path):
         result, html = convert(tmp_path, "```mermaid\ngraph TD\n A-->B\n```\n\n```plantuml\n@startuml\n@enduml\n```\n\n```d2\na -> b\n```\n")
-        assert body(html).count("<pre>") == 3 and "<img" not in html
+        assert len(re.findall(r"<pre[ >]", body(html))) == 3 and "<img" not in html
         assert not result.warnings
 
     def test_other_languages_are_plain_code_blocks(self, tmp_path):
         _, html = convert(tmp_path, "```\n<b>&\n```\n")
-        assert "<pre><code>&lt;b&gt;&amp;\n</code></pre>" in html
+        assert '<pre data-line="1"><code>&lt;b&gt;&amp;\n</code></pre>' in html
 
     def test_a_diagram_source_file_is_a_page_with_that_diagram(self, tmp_path):
         result, html = convert(tmp_path, "graph TD\n A-->B\n", name="flow.mmd")