flowmark 0.3.2__tar.gz → 0.4.0__tar.gz

{flowmark-0.3.2 → flowmark-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flowmark
-Version: 0.3.2
+Version: 0.4.0
 Summary: Better line wrapping and formatting for plaintext and Markdown
 Project-URL: Repository, https://github.com/jlevy/flowmark
 Author-email: Joshua Levy <joshua@cal.berkeley.edu>
@@ -18,10 +18,9 @@ Description-Content-Type: text/markdown
 Flowmark is a new Python implementation of **text and Markdown line wrapping and
 filling**, with an emphasis on making **git diffs** and **LLM edits** to text documents
 easier to diff and review.
-after updating
 
-In addition, it adds **support for Markdown** and offers **Markdown auto-formatting and
-normalization** as a library or from the command line.
+In addition, it offers **Markdown auto-formatting and normalization** as a library or
+from the command line.
 This is much like [markdownfmt](https://github.com/shurcooL/markdownfmt) or
 [prettier's Markdown support](https://prettier.io/blog/2017/11/07/1.8.0) but is pure
 Python and has (in my humble opinion) better options and defaults.
@@ -73,8 +72,7 @@ The `--auto` option is just the same as `--inplace --nobackup --semantic`.
 
 ## Use Cases
 
-- As a **command line formatter** to format text or Markdown files using the `flowmark`
-  command.
+The main ways to use Flowmark are:
 
 - To **autoformat Markdown on save in VSCode/Cursor** or any other editor that supports
   running a command on save.
@@ -83,6 +81,9 @@ The `--auto` option is just the same as `--inplace --nobackup --semantic`.
   formatting styles). This can be especially useful for documentation and editing
   workflows where clean diffs and minimal merge conflicts on GitHub are important.
 
+- As a **command line formatter** to format text or Markdown files using the `flowmark`
+  command.
+
 - As a **library to autoformat Markdown**. For example, it is great to normalize the
   outputs from LLMs to be consistent, or to run on the inputs and outputs of LLM
   transformations that edit text, so that the resulting diffs are clean.
@@ -95,6 +96,8 @@ The `--auto` option is just the same as `--inplace --nobackup --semantic`.
   subsequent indentation** and **when to split words and lines**, e.g. using a word
   splitter that won't break lines within HTML tags.
 
+Other features:
+
 - Flowmark has the option to to use **semantic line breaks** (using a heuristic to break
   lines on sentences sentences when that is reasonable), which is an underrated feature
   that can **make diffs on GitHub much more readable**. The the change may seem subtle
@@ -104,8 +107,11 @@ The `--auto` option is just the same as `--inplace --nobackup --semantic`.
   [Markdown source](https://github.com/jlevy/flowmark/blob/main/README.md?plain=1) of
   this readme file.)
 
-- Very, very simple and fast **regex-based sentence splitting**. This should work fine
-  for English and many other latin/Cyrillic languages but it hasn't been tested on CJK.
+- Very simple and fast **regex-based sentence splitting**. It's just based on letters
+  and punctuation so isn't perfect but works well for these purposes (and is much faster
+  and simpler than a proper sentence parser like SpaCy).
+  It should work fine for English and many other latin/Cyrillic languages but hasn't
+  been tested on CJK.
 
 It aims to be small and simple and have only a few dependencies, currently only
 [`marko`](https://github.com/frostming/marko),
@@ -163,7 +169,6 @@ Markdown content. It can:
 
 - Optionally break lines at sentence boundaries for better diff readability
 
-
 - Process plaintext with HTML-aware word splitting
 
 It is both a library and a command-line tool.

{flowmark-0.3.2 → flowmark-0.4.0}/README.md

@@ -3,10 +3,9 @@
 Flowmark is a new Python implementation of **text and Markdown line wrapping and
 filling**, with an emphasis on making **git diffs** and **LLM edits** to text documents
 easier to diff and review.
-after updating
 
-In addition, it adds **support for Markdown** and offers **Markdown auto-formatting and
-normalization** as a library or from the command line.
+In addition, it offers **Markdown auto-formatting and normalization** as a library or
+from the command line.
 This is much like [markdownfmt](https://github.com/shurcooL/markdownfmt) or
 [prettier's Markdown support](https://prettier.io/blog/2017/11/07/1.8.0) but is pure
 Python and has (in my humble opinion) better options and defaults.
@@ -58,8 +57,7 @@ The `--auto` option is just the same as `--inplace --nobackup --semantic`.
 
 ## Use Cases
 
-- As a **command line formatter** to format text or Markdown files using the `flowmark`
-  command.
+The main ways to use Flowmark are:
 
 - To **autoformat Markdown on save in VSCode/Cursor** or any other editor that supports
   running a command on save.
@@ -68,6 +66,9 @@ The `--auto` option is just the same as `--inplace --nobackup --semantic`.
   formatting styles). This can be especially useful for documentation and editing
   workflows where clean diffs and minimal merge conflicts on GitHub are important.
 
+- As a **command line formatter** to format text or Markdown files using the `flowmark`
+  command.
+
 - As a **library to autoformat Markdown**. For example, it is great to normalize the
   outputs from LLMs to be consistent, or to run on the inputs and outputs of LLM
   transformations that edit text, so that the resulting diffs are clean.
@@ -80,6 +81,8 @@ The `--auto` option is just the same as `--inplace --nobackup --semantic`.
   subsequent indentation** and **when to split words and lines**, e.g. using a word
   splitter that won't break lines within HTML tags.
 
+Other features:
+
 - Flowmark has the option to to use **semantic line breaks** (using a heuristic to break
   lines on sentences sentences when that is reasonable), which is an underrated feature
   that can **make diffs on GitHub much more readable**. The the change may seem subtle
@@ -89,8 +92,11 @@ The `--auto` option is just the same as `--inplace --nobackup --semantic`.
   [Markdown source](https://github.com/jlevy/flowmark/blob/main/README.md?plain=1) of
   this readme file.)
 
-- Very, very simple and fast **regex-based sentence splitting**. This should work fine
-  for English and many other latin/Cyrillic languages but it hasn't been tested on CJK.
+- Very simple and fast **regex-based sentence splitting**. It's just based on letters
+  and punctuation so isn't perfect but works well for these purposes (and is much faster
+  and simpler than a proper sentence parser like SpaCy).
+  It should work fine for English and many other latin/Cyrillic languages but hasn't
+  been tested on CJK.
 
 It aims to be small and simple and have only a few dependencies, currently only
 [`marko`](https://github.com/frostming/marko),
@@ -148,7 +154,6 @@ Markdown content. It can:
 
 - Optionally break lines at sentence boundaries for better diff readability
 
-
 - Process plaintext with HTML-aware word splitting
 
 It is both a library and a command-line tool.

{flowmark-0.3.2 → flowmark-0.4.0}/src/flowmark/__init__.py

@@ -1,9 +1,12 @@
 __all__ = (
     "fill_text",
     "fill_markdown",
+    "first_sentence",
+    "first_sentences",
     "html_md_word_splitter",
     "line_wrap_by_sentence",
     "line_wrap_to_width",
+    "split_sentences_regex",
     "wrap_paragraph",
     "wrap_paragraph_lines",
     "Wrap",
@@ -11,5 +14,6 @@ __all__ = (
 
 from .line_wrappers import line_wrap_by_sentence, line_wrap_to_width
 from .markdown_filling import fill_markdown
+from .sentence_split_regex import first_sentence, first_sentences, split_sentences_regex
 from .text_filling import Wrap, fill_text
 from .text_wrapping import html_md_word_splitter, wrap_paragraph, wrap_paragraph_lines

{flowmark-0.3.2 → flowmark-0.4.0}/src/flowmark/markdown_filling.py

@@ -17,10 +17,11 @@ from contextlib import contextmanager
 from textwrap import dedent
 from typing import Any, cast
 
-from marko import block, inline
+from marko import Renderer, block, inline
 from marko.block import HTMLBlock
+from marko.ext.gfm import GFM
+from marko.ext.gfm import elements as gfm_elements
 from marko.parser import Parser
-from marko.renderer import Renderer
 from marko.source import Source
 from typing_extensions import override
 
@@ -96,9 +97,14 @@ class CustomParser(Parser):
 
 class _MarkdownNormalizer(Renderer):
     """
-    Render Markdown in normalized form. This is the internal implementation.
+    Render Markdown in normalized form. This is the internal implementation
+    which overrides most of `MarkdownRenderer`.
+
     You likely want to use `normalize_markdown()` instead.
-    Based on: https://github.com/frostming/marko/blob/master/marko/md_renderer.py
+
+    Based on:
+    https://github.com/frostming/marko/blob/master/marko/md_renderer.py
+    https://github.com/frostming/marko/blob/master/marko/ext/gfm/renderer.py
     """
 
     def __init__(self, line_wrapper: LineWrapper) -> None:
@@ -126,7 +132,14 @@ class _MarkdownNormalizer(Renderer):
         # Suppress item breaks on list items following a top-level paragraph.
         if not self._prefix:
             self._suppress_item_break = True
+
         children: Any = self.render_children(element)
+
+        # GFM checkbox support.
+        if hasattr(element, "checked"):
+            children = f"[{'x' if element.checked else ' '}] {children}"  # pyright: ignore
+
+        # Wrap the text.
         wrapped_text = self._line_wrapper(
             children,
             self._prefix,
@@ -288,6 +301,33 @@ class _MarkdownNormalizer(Renderer):
             return f"`` {text} ``"
         return f"`{element.children}`"
 
+    # --- GFM Renderer Methods ---
+
+    def render_strikethrough(self, element: gfm_elements.Strikethrough) -> str:
+        return f"~~{self.render_children(element)}~~"
+
+    def render_table(self, element: gfm_elements.Table) -> str:
+        """Render a GFM table."""
+        lines: list[str] = []
+        head, *body = element.children
+        lines.append(self.render(head))
+        lines.append(f"| {' | '.join(element.delimiters)} |\n")
+        for row in body:
+            lines.append(self.render(row))
+        return "".join(lines)
+
+    def render_table_row(self, element: gfm_elements.TableRow) -> str:
+        """Render a row within a GFM table."""
+        return f"| {' | '.join(self.render(cell) for cell in element.children)} |\n"
+
+    def render_table_cell(self, element: gfm_elements.TableCell) -> str:
+        """Render a cell within a GFM table row."""
+        return self.render_children(element).replace("|", "\\|")
+
+    def render_url(self, element: gfm_elements.Url) -> str:
+        """For GFM autolink URLs, just output the URL directly."""
+        return element.dest
+
 
 def split_sentences_no_min_length(text: str) -> list[str]:
     return split_sentences_regex(text, min_length=0)
@@ -338,10 +378,19 @@ def fill_markdown(
     # If we want to normalize HTML blocks or comments.
     markdown_text = _normalize_html_comments(markdown_text)
 
-    # Normalize the markdown and wrap lines.
+    # Set up our custom parser, and mix in GFM elements.
+    # Using Marko's full extension system is tricky with our customizations so simpler
+    # to do this manually.
     parser = CustomParser()
+    for e in GFM.elements:
+        assert e not in parser.block_elements and e not in parser.inline_elements
+        parser.add_element(e)
+
+    renderer = _MarkdownNormalizer(line_wrapper)
+
+    # Parse and render.
     parsed = parser.parse(markdown_text)
-    result = _MarkdownNormalizer(line_wrapper).render(parsed)
+    result = renderer.render(parsed)
 
     # Reattach frontmatter if it was present
     if frontmatter:

{flowmark-0.3.2 → flowmark-0.4.0}/src/flowmark/sentence_split_regex.py

@@ -2,43 +2,43 @@ from collections.abc import Callable
 
 import regex
 
-# These heuristics are from Flowmark:
-# https://github.com/jlevy/atom-flowmark/blob/master/lib/remark-smart-word-wrap.js#L17-L33
-
-# They work pretty well when used for formatting and editing documents in English.
-# Note this is smarter than Python textwrap's simple heuristic:
-# https://github.com/python/cpython/blob/main/Lib/textwrap.py#L105-L110
-
-# Heuristic: End of sentence must be two letters or more, with the last letter lowercase,
-# followed by a period, exclamation point, question mark. A final or preceding parenthesis
-# or quote is allowed.
-#
-# Does not break on colon or semicolon currently as that seems to have false positives too
-# often with code or other syntax.
-#
 # XXX: Could also handle rare cases with both quotes and parentheses at sentence end
 # but may not be worth it. Also does not detect sentences ending in numerals, which
 # tends to cause too many false positives. Should be OK for most Latin languages but
 # may need to rethink the 2-letter restriction for some languages.
-SENTENCE_RE = regex.compile(r"(\b\p{L}+[\p{Ll}])([.?!]['\"’”)]?|['\"’”)][.?!]) *$")
+# See also:
+# https://github.com/jlevy/atom-flowmark/blob/master/lib/remark-smart-word-wrap.js#L17-L33
+SENTENCE_END_RE = regex.compile(r"(\b\p{L}+[\p{Ll}])([.?!]['\"’”)]?|['\"’”)][.?!]) *$")
 
 # Second heuristic: Very short sentences often not so useful.
 SENTENCE_MIN_LENGTH = 15
 
 
 def heuristic_end_of_sentence(word: str) -> bool:
-    return bool(SENTENCE_RE.search(word))
+    return bool(SENTENCE_END_RE.search(word))
 
 
 def split_sentences_regex(
     text: str,
-    heuristic: Callable[[str], bool] = heuristic_end_of_sentence,
     min_length: int = SENTENCE_MIN_LENGTH,
+    heuristic: Callable[[str], bool] = heuristic_end_of_sentence,
 ) -> list[str]:
     """
-    Split text into sentences using an approximate, fast regex heuristic. (English.)
+    Split text into sentences using an approximate, fast regex heuristic.
+
     Goal is to be conservative, not perfect, avoiding excessive breaks.
 
+    The default heuristic: End of sentence must be two letters or more,
+    with the last letter lowercase, followed by a period, exclamation point,
+    question mark. A final or preceding parenthesis or quote is allowed.
+    Does not break on colon or semicolon as that seems to have false
+    positives too often with code or other syntax.
+
+    They work pretty well when used for formatting and editing documents
+    in English. It should be reasonable for most Latin languages.
+    Note this is smarter than Python textwrap's simpler heuristic:
+    https://github.com/python/cpython/blob/main/Lib/textwrap.py#L105-L110
+
     :param text: The text to split into sentences.
     :param heuristic: A callable that returns True if text ends at the end of a sentence.
     :param min_length: The minimum length of a sentence in characters.
@@ -59,3 +59,28 @@ def split_sentences_regex(
     if sentence:
         sentences.append(" ".join(sentence))
     return sentences
+
+
+def first_sentences(
+    text: str,
+    n: int,
+    min_length: int = SENTENCE_MIN_LENGTH,
+    heuristic: Callable[[str], bool] = heuristic_end_of_sentence,
+) -> list[str]:
+    """
+    Return the first n sentences from the text.
+    """
+    return split_sentences_regex(text, min_length=min_length, heuristic=heuristic)[:n]
+
+
+def first_sentence(
+    text: str,
+    min_length: int = SENTENCE_MIN_LENGTH,
+    heuristic: Callable[[str], bool] = heuristic_end_of_sentence,
+) -> str:
+    """
+    Return the first sentence from the text. Returns input text unchanged if no
+    sentences are found.
+    """
+    sentences = split_sentences_regex(text, min_length=min_length, heuristic=heuristic)
+    return sentences[0] if sentences else text

flowmark-0.4.0/tests/test_ref_docs.py

@@ -0,0 +1,44 @@
+from dataclasses import dataclass
+from pathlib import Path
+
+from flowmark.markdown_filling import fill_markdown
+
+testdoc_dir = Path("tests/testdocs")
+
+
+def test_reference_doc_formats():
+    """
+    Test that the reference document is formatted correctly with both plain and semantic formats.
+    """
+    orig_path = testdoc_dir / "testdoc.orig.md"
+
+    # Check that original file exists
+    assert orig_path.exists(), f"Original test document not found at {orig_path}"
+
+    # Read the original content
+    with open(orig_path) as f:
+        orig_content = f.read()
+
+    @dataclass(frozen=True)
+    class TestCase:
+        name: str
+        filename: str
+        by_sentence: bool
+
+    test_cases: list[TestCase] = [
+        TestCase(name="plain", filename="testdoc.out.plain.md", by_sentence=False),
+        TestCase(name="semantic", filename="testdoc.out.semantic.md", by_sentence=True),
+    ]
+
+    for case in test_cases:
+        test_doc = testdoc_dir / case.filename
+        expected = test_doc.read_text()
+
+        actual = fill_markdown(orig_content, semantic=case.by_sentence)
+        if actual != expected:
+            actual_path = testdoc_dir / f"testdoc.actual.{case.name}.md"
+            print(f"actual was different from expected for {case.name}!")
+            print(f"Saving actual to: {actual_path}")
+            actual_path.write_text(actual)
+
+        assert expected == actual

flowmark-0.4.0/tests/test_sentences.py

@@ -0,0 +1,30 @@
+from flowmark import first_sentence, split_sentences_regex
+
+LONG_TEXT = """
+End of sentence must be two letters or more,
+with the last letter lowercase, followed by a period, exclamation point,
+question mark. A final or preceding parenthesis or quote is allowed.
+Does not break on colon or semicolon as that seems to have false
+positives too often with code or other syntax.
+"""
+
+FIRST_SENTENCE = "End of sentence must be two letters or more, with the last letter lowercase, followed by a period, exclamation point, question mark."
+
+
+def test_split_sentences():
+    assert split_sentences_regex("test!") == ["test!"]
+    assert split_sentences_regex("test! random words") == ["test! random words"]
+
+    split_sentences = split_sentences_regex(LONG_TEXT)
+    print(split_sentences)
+    assert len(split_sentences) == 3
+    assert split_sentences[0] == FIRST_SENTENCE
+
+
+def test_first_sentence():
+    assert first_sentence(LONG_TEXT) == FIRST_SENTENCE
+
+    assert first_sentence("") == ""
+    assert first_sentence(" ") == " "
+    assert first_sentence("hello") == "hello"
+    assert first_sentence(" hello\n") == "hello"

{flowmark-0.3.2 → flowmark-0.4.0}/tests/testdocs/testdoc.orig.md

@@ -78,15 +78,15 @@ If the noteholders had converted their $420K at the 20% discount, they would be
 ## Legalese
 
 > ⚖️
->
+> 
 > ↔️ CONVERTIBLE PROMISSORY NOTE
->
+> 
 > Note Series: `___________________________`
 >
 > e. **Amendment and Waiver.**
 > Any term of this Note may be amended or waived with the written consent of Company and
 > the Majority Holders.
->
+> 
 > f. **Governing Law; Venue.** This Note shall be governed by and construed under the laws of the State of `________`, as
 > applied to agreements among `_______` residents, made and to be performed entirely within the State of `______`, without giving effect to conflicts of laws principles. The venue for any dispute arising out of or related to this Note will lie exclusively in the state or federal courts located in King County, Washington, and the parties to this Note irrevocably waive any right to raise forum non conveniens or any other argument that King County, Washington is not the proper venue. The parties to this Note irrevocably consent to personal jurisdiction in the state and federal courts of the state of Washington.
 
@@ -94,7 +94,7 @@ If the noteholders had converted their $420K at the 20% discount, they would be
 > Without in any way limiting the representations set forth above, the Holder further
 > agrees not to make any disposition of all or any portion of the Securities unless and
 > until:
->
+> 
 > 1\. There is then in effect a registration statement under the Act covering such proposed
 > disposition and such disposition is made in accordance with such registration statement;
 > or
@@ -118,6 +118,7 @@ the Center for American Entrepreneurship.)
 
 A good heuristic is to assume your readers will be **100% intelligent and 100% ignorant**. Of course, in reality, varied experience exists within an individual reader. Most people may already know *something*, and some people are quicker learners than others. Even world class experts most likely only really know parts of a subject, and contributors may have practical experience in one role--perhaps they have been an entrepreneur, for example, but not an investor. So writing with the assumption that each reader could be both has a variety of advantages:  
 
+
 - Assuming 100% ignorance will help people who think they know a lot about a subject understand **what they didn't know they didn't know**, and fill in the gaps in their knowledge. It encourages contribution from experts and people with practical experience.
 - Assuming 100% intelligence makes readers feel respected, and feel proud to be associated with the material. It will incline beginners to contribute their feedback.
 - Ensures that each reader feels capable of tackling a problem, specific or general.
@@ -281,6 +282,34 @@ of General Social Survey data).
 - **Visionary projects.**
   Projects that were in a completely brand-new space without a precedent, going from 0 to 1.
 
+Recommendations:
+
+- Use `z` (zoxide) instead of `cd`.
+
+  ```shell
+  # Use z in place of cd: switch directories (first time):
+  z ~/some/long/path/to/foo
+  # Thereafter it's faster:
+  z foo
+  ```
+- Use `eza` instead of `ls`. It has color support, support for Nerd Font icons, and
+  other improvements.
+
+### **3.6 Comparative Features Matrix**
+
+The following table summarizes the native capabilities of the primary platforms evaluated against the core requirements:
+
+| **Feature** | **Vercel** | **Netlify** | **Cloudflare Pages** | **AWS (S3/CloudFront)** |
+| --- | --- | --- | --- | --- |
+| **CLI Tool Availability** | Yes (vercel) 1 | Yes (netlify) 2 | Yes (wrangler) 3 | Yes (aws) 4 |
+| **Primary CLI Auth Method** | User Access Token 9 | Personal Access Token (PAT) 2 | API Token 10 | IAM Credentials / STS Token 11 |
+| **Native Token/Key Scoping** | User/Team Level 24 | User/Site Level 30 | Account Level (for Pages Edit) 3 | Path/Prefix Level (via IAM) 4 |
+| **Path-Based Deploy Permissions** | No Native Support 14 | No Native Support 2 | No Native Support 3 | Yes (IAM Policies) 4 |
+| **Primary Native Isolation Method** | Project | Site | Project (but weak permissions) | Path Prefix (with IAM) 4 |
+| **Programmatic File Delete/Update** | Deployment API 14 | Deployment API 28 | Deployment API (via Wrangler) | Direct S3 Object API 12-55 |
+| **Programmatic Invalidation API** | Automatic / Limited | Automatic / Limited | Yes (Cloudflare API) | Yes (CloudFront API) 15-16 |
+| **Basic Cost Model** | Per User / Usage 5 | Per User / Usage 5 | Generous Free Tier / Usage | Usage-Based Components 20-64 |
+
 ### Boldface, italics, and links
 
 X [New York City](https://en.wikipedia.org/wiki/New_York_City).

{flowmark-0.3.2 → flowmark-0.4.0}/tests/testdocs/testdoc.out.plain.md

@@ -433,6 +433,35 @@ Social Survey data).
 - **Visionary projects.** Projects that were in a completely brand-new space without a
   precedent, going from 0 to 1.
 
+Recommendations:
+
+- Use `z` (zoxide) instead of `cd`.
+
+  ```shell
+  # Use z in place of cd: switch directories (first time):
+  z ~/some/long/path/to/foo
+  # Thereafter it's faster:
+  z foo
+  ```
+- Use `eza` instead of `ls`. It has color support, support for Nerd Font icons, and
+  other improvements.
+
+### **3.6 Comparative Features Matrix**
+
+The following table summarizes the native capabilities of the primary platforms
+evaluated against the core requirements:
+
+| **Feature** | **Vercel** | **Netlify** | **Cloudflare Pages** | **AWS (S3/CloudFront)** |
+| --- | --- | --- | --- | --- |
+| **CLI Tool Availability** | Yes (vercel) 1 | Yes (netlify) 2 | Yes (wrangler) 3 | Yes (aws) 4 |
+| **Primary CLI Auth Method** | User Access Token 9 | Personal Access Token (PAT) 2 | API Token 10 | IAM Credentials / STS Token 11 |
+| **Native Token/Key Scoping** | User/Team Level 24 | User/Site Level 30 | Account Level (for Pages Edit) 3 | Path/Prefix Level (via IAM) 4 |
+| **Path-Based Deploy Permissions** | No Native Support 14 | No Native Support 2 | No Native Support 3 | Yes (IAM Policies) 4 |
+| **Primary Native Isolation Method** | Project | Site | Project (but weak permissions) | Path Prefix (with IAM) 4 |
+| **Programmatic File Delete/Update** | Deployment API 14 | Deployment API 28 | Deployment API (via Wrangler) | Direct S3 Object API 12-55 |
+| **Programmatic Invalidation API** | Automatic / Limited | Automatic / Limited | Yes (Cloudflare API) | Yes (CloudFront API) 15-16 |
+| **Basic Cost Model** | Per User / Usage 5 | Per User / Usage 5 | Generous Free Tier / Usage | Usage-Based Components 20-64 |
+
 ### Boldface, italics, and links
 
 X [New York City](https://en.wikipedia.org/wiki/New_York_City). XX
@@ -862,16 +891,13 @@ valuation, shares, fundraising, and dilution (<a
 href="http://ownyourventure.com/equitySim.html">source</a>) <br> </div>
 
 | Specific AWS Services | Basics | Tips | Gotchas |
-|---------------------------------------|--------------------------------|-------------------------------|------------------------------------------------|
-| [Security and IAM](#security-and-iam) | [📗](#security-and-iam-basics) |
-[📘](#security-and-iam-tips) | [📙](#security-and-iam-gotchas-and-limitations) | |
-[S3](#s3) | [📗](#s3-basics) | [📘](#s3-tips) | [📙](#s3-gotchas-and-limitations) | |
-[EC2](#ec2) | [📗](#ec2-basics) | [📘](#ec2-tips) | [📙](#ec2-gotchas-and-limitations) | |
-[CloudWatch](#cloudwatch) | [📗](#cloudwatch-basics) | [📘](#cloudwatch-tips) |
-[📙](#cloudwatch-gotchas-and-limitations) | | [AMIs](#amis) | [📗](#ami-basics) |
-[📘](#ami-tips) | [📙](#ami-gotchas-and-limitations) | | [Auto Scaling](#auto-scaling) |
-[📗](#auto-scaling-basics) | [📘](#auto-scaling-tips) |
-[📙](#auto-scaling-gotchas-and-limitations) |
+| --------------------------------------- | -------------------------------- | ------------------------------- | ------------------------------------------------ |
+| [Security and IAM](#security-and-iam) | [📗](#security-and-iam-basics) | [📘](#security-and-iam-tips) | [📙](#security-and-iam-gotchas-and-limitations) |
+| [S3](#s3) | [📗](#s3-basics) | [📘](#s3-tips) | [📙](#s3-gotchas-and-limitations) |
+| [EC2](#ec2) | [📗](#ec2-basics) | [📘](#ec2-tips) | [📙](#ec2-gotchas-and-limitations) |
+| [CloudWatch](#cloudwatch) | [📗](#cloudwatch-basics) | [📘](#cloudwatch-tips) | [📙](#cloudwatch-gotchas-and-limitations) |
+| [AMIs](#amis) | [📗](#ami-basics) | [📘](#ami-tips) | [📙](#ami-gotchas-and-limitations) |
+| [Auto Scaling](#auto-scaling) | [📗](#auto-scaling-basics) | [📘](#auto-scaling-tips) | [📙](#auto-scaling-gotchas-and-limitations) |
 
 - 📒 [FAQ](https://aws.amazon.com/cloudwatch/faqs/) ∙
   [Pricing](https://aws.amazon.com/cloudwatch/pricing/) - 🔹Blahxxx - ❗Blahxxx

{flowmark-0.3.2 → flowmark-0.4.0}/tests/testdocs/testdoc.out.semantic.md

@@ -456,6 +456,35 @@ Social Survey data).
 - **Visionary projects.** Projects that were in a completely brand-new space without a
   precedent, going from 0 to 1.
 
+Recommendations:
+
+- Use `z` (zoxide) instead of `cd`.
+
+  ```shell
+  # Use z in place of cd: switch directories (first time):
+  z ~/some/long/path/to/foo
+  # Thereafter it's faster:
+  z foo
+  ```
+- Use `eza` instead of `ls`. It has color support, support for Nerd Font icons, and
+  other improvements.
+
+### **3.6 Comparative Features Matrix**
+
+The following table summarizes the native capabilities of the primary platforms
+evaluated against the core requirements:
+
+| **Feature** | **Vercel** | **Netlify** | **Cloudflare Pages** | **AWS (S3/CloudFront)** |
+| --- | --- | --- | --- | --- |
+| **CLI Tool Availability** | Yes (vercel) 1 | Yes (netlify) 2 | Yes (wrangler) 3 | Yes (aws) 4 |
+| **Primary CLI Auth Method** | User Access Token 9 | Personal Access Token (PAT) 2 | API Token 10 | IAM Credentials / STS Token 11 |
+| **Native Token/Key Scoping** | User/Team Level 24 | User/Site Level 30 | Account Level (for Pages Edit) 3 | Path/Prefix Level (via IAM) 4 |
+| **Path-Based Deploy Permissions** | No Native Support 14 | No Native Support 2 | No Native Support 3 | Yes (IAM Policies) 4 |
+| **Primary Native Isolation Method** | Project | Site | Project (but weak permissions) | Path Prefix (with IAM) 4 |
+| **Programmatic File Delete/Update** | Deployment API 14 | Deployment API 28 | Deployment API (via Wrangler) | Direct S3 Object API 12-55 |
+| **Programmatic Invalidation API** | Automatic / Limited | Automatic / Limited | Yes (Cloudflare API) | Yes (CloudFront API) 15-16 |
+| **Basic Cost Model** | Per User / Usage 5 | Per User / Usage 5 | Generous Free Tier / Usage | Usage-Based Components 20-64 |
+
 ### Boldface, italics, and links
 
 X [New York City](https://en.wikipedia.org/wiki/New_York_City). XX
@@ -903,16 +932,13 @@ valuation, shares, fundraising, and dilution (<a
 href="http://ownyourventure.com/equitySim.html">source</a>) <br> </div>
 
 | Specific AWS Services | Basics | Tips | Gotchas |
-|---------------------------------------|--------------------------------|-------------------------------|------------------------------------------------|
-| [Security and IAM](#security-and-iam) | [📗](#security-and-iam-basics) |
-[📘](#security-and-iam-tips) | [📙](#security-and-iam-gotchas-and-limitations) | |
-[S3](#s3) | [📗](#s3-basics) | [📘](#s3-tips) | [📙](#s3-gotchas-and-limitations) | |
-[EC2](#ec2) | [📗](#ec2-basics) | [📘](#ec2-tips) | [📙](#ec2-gotchas-and-limitations) | |
-[CloudWatch](#cloudwatch) | [📗](#cloudwatch-basics) | [📘](#cloudwatch-tips) |
-[📙](#cloudwatch-gotchas-and-limitations) | | [AMIs](#amis) | [📗](#ami-basics) |
-[📘](#ami-tips) | [📙](#ami-gotchas-and-limitations) | | [Auto Scaling](#auto-scaling) |
-[📗](#auto-scaling-basics) | [📘](#auto-scaling-tips) |
-[📙](#auto-scaling-gotchas-and-limitations) |
+| --------------------------------------- | -------------------------------- | ------------------------------- | ------------------------------------------------ |
+| [Security and IAM](#security-and-iam) | [📗](#security-and-iam-basics) | [📘](#security-and-iam-tips) | [📙](#security-and-iam-gotchas-and-limitations) |
+| [S3](#s3) | [📗](#s3-basics) | [📘](#s3-tips) | [📙](#s3-gotchas-and-limitations) |
+| [EC2](#ec2) | [📗](#ec2-basics) | [📘](#ec2-tips) | [📙](#ec2-gotchas-and-limitations) |
+| [CloudWatch](#cloudwatch) | [📗](#cloudwatch-basics) | [📘](#cloudwatch-tips) | [📙](#cloudwatch-gotchas-and-limitations) |
+| [AMIs](#amis) | [📗](#ami-basics) | [📘](#ami-tips) | [📙](#ami-gotchas-and-limitations) |
+| [Auto Scaling](#auto-scaling) | [📗](#auto-scaling-basics) | [📘](#auto-scaling-tips) | [📙](#auto-scaling-gotchas-and-limitations) |
 
 - 📒 [FAQ](https://aws.amazon.com/cloudwatch/faqs/) ∙
   [Pricing](https://aws.amazon.com/cloudwatch/pricing/) - 🔹Blahxxx - ❗Blahxxx

flowmark-0.3.2/tests/test_ref_docs.py

@@ -1,47 +0,0 @@
-from pathlib import Path
-from typing import TypedDict
-
-from flowmark.markdown_filling import fill_markdown
-
-testdoc_dir = Path("tests/testdocs")
-
-
-def test_reference_doc_formats():
-    """Test that the reference document is formatted correctly with both plain and semantic formats."""
-    orig_path = testdoc_dir / "testdoc.orig.md"
-
-    # Check that original file exists
-    assert orig_path.exists(), f"Original test document not found at {orig_path}"
-
-    # Read the original content
-    with open(orig_path) as f:
-        orig_content = f.read()
-
-    class TestCase(TypedDict):
-        name: str
-        filename: str
-        by_sentence: bool
-
-    # Test configurations
-    test_cases: list[TestCase] = [
-        {"name": "plain", "filename": "testdoc.out.plain.md", "by_sentence": False},
-        {"name": "semantic", "filename": "testdoc.out.semantic.md", "by_sentence": True},
-    ]
-
-    for case in test_cases:
-        output_path = testdoc_dir / case["filename"]
-        assert output_path.exists(), (
-            f"{case['name'].capitalize()}-processed document not found at {output_path}"
-        )
-
-        # Read the processed content
-        with open(output_path) as f:
-            processed_content = f.read()
-
-        # Process the original file using fill_markdown with appropriate option
-        expected_content = fill_markdown(orig_content, semantic=case["by_sentence"])
-
-        # Compare the processed content with the expected output
-        assert expected_content == processed_content, (
-            f"{case['name'].capitalize()} flowmark processing doesn't match expected output"
-        )