yaml-sort 0.2.1__tar.gz

yaml_sort-0.2.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

yaml_sort-0.2.1/PKG-INFO

@@ -0,0 +1,81 @@
+Metadata-Version: 2.4
+Name: yaml-sort
+Version: 0.2.1
+Summary: Deterministic YAML key sorter — sorts mapping keys alphabetically while preserving comments and byte-for-byte formatting.
+Author: Soren L. Hansen
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/sorenisanerd/yaml-sort
+Keywords: yaml,sort,deterministic,chezmoi,diff
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Text Processing :: Markup
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# yaml-sort
+
+Deterministic YAML key ordering. Sorts mapping keys alphabetically (bottom-up)
+while preserving comments and byte-for-byte formatting, so running it produces
+no diff when a file is already sorted.
+
+Designed to keep `chezmoi`-managed config diffs clean.
+
+## Why not just `yaml.load` → sort → `yaml.dump`?
+
+A library round-trip rewrites the whole file: it drops comments, re-quotes
+strings, re-indents everything, and normalizes flow/block style. That adds
+diff noise on every run. `yaml-sort` instead parses the *block structure* and
+re-emits it verbatim, moving only what it needs to (mapping keys).
+
+## Features
+
+- Sorts mapping keys alphabetically, bottom-up — including inside list items
+  and nested maps.
+- Never reorders list items (sequence order is meaningful).
+- A comment that is the *last* thing in a file (a footer) stays pinned at the
+  very bottom — it is not dragged into the middle when the neighbouring key
+  re-sorts.
+- For a list item that opens a map (`- api_key: none` then `base_url:`…), the
+  anchor key fused to the `- ` is sorted with its siblings and the `- `
+  re-fuses to whichever key sorts first, keeping every list entry fully
+  alphabetical.
+- `--list-indent keep` (default): preserve existing indentation byte-for-byte.
+- `--list-indent N`: re-indent sequence items N spaces right of their parent key
+  (0 = aligned, 2 = conventional indented style).
+- `--check`, `--diff`, `--stdin` modes.
+
+## Install
+
+```sh
+pip install yaml-sort        # from PyPI (once published)
+# or, from a checkout:
+pip install -e .
+```
+
+## Usage
+
+```
+yaml-sort <file>                  Sort file in-place
+yaml-sort <file> --check          Exit 0 if sorted, 1 if not
+yaml-sort <file> --diff           Show what would change
+yaml-sort <file> --list-indent 2  Also re-indent lists 2 spaces under their key
+yaml-sort --stdin                 Read stdin, write sorted to stdout
+```
+
+## Library use
+
+```python
+from yaml_sort import sort_text
+
+sorted_yaml = sort_text(raw_text)            # byte-preserving
+sorted_yaml = sort_text(raw_text, 2)         # re-indent lists to 2 spaces
+```
+
+## Development
+
+```sh
+pip install -e .[dev]
+pytest
+```

yaml_sort-0.2.1/README.md

@@ -0,0 +1,65 @@
+# yaml-sort
+
+Deterministic YAML key ordering. Sorts mapping keys alphabetically (bottom-up)
+while preserving comments and byte-for-byte formatting, so running it produces
+no diff when a file is already sorted.
+
+Designed to keep `chezmoi`-managed config diffs clean.
+
+## Why not just `yaml.load` → sort → `yaml.dump`?
+
+A library round-trip rewrites the whole file: it drops comments, re-quotes
+strings, re-indents everything, and normalizes flow/block style. That adds
+diff noise on every run. `yaml-sort` instead parses the *block structure* and
+re-emits it verbatim, moving only what it needs to (mapping keys).
+
+## Features
+
+- Sorts mapping keys alphabetically, bottom-up — including inside list items
+  and nested maps.
+- Never reorders list items (sequence order is meaningful).
+- A comment that is the *last* thing in a file (a footer) stays pinned at the
+  very bottom — it is not dragged into the middle when the neighbouring key
+  re-sorts.
+- For a list item that opens a map (`- api_key: none` then `base_url:`…), the
+  anchor key fused to the `- ` is sorted with its siblings and the `- `
+  re-fuses to whichever key sorts first, keeping every list entry fully
+  alphabetical.
+- `--list-indent keep` (default): preserve existing indentation byte-for-byte.
+- `--list-indent N`: re-indent sequence items N spaces right of their parent key
+  (0 = aligned, 2 = conventional indented style).
+- `--check`, `--diff`, `--stdin` modes.
+
+## Install
+
+```sh
+pip install yaml-sort        # from PyPI (once published)
+# or, from a checkout:
+pip install -e .
+```
+
+## Usage
+
+```
+yaml-sort <file>                  Sort file in-place
+yaml-sort <file> --check          Exit 0 if sorted, 1 if not
+yaml-sort <file> --diff           Show what would change
+yaml-sort <file> --list-indent 2  Also re-indent lists 2 spaces under their key
+yaml-sort --stdin                 Read stdin, write sorted to stdout
+```
+
+## Library use
+
+```python
+from yaml_sort import sort_text
+
+sorted_yaml = sort_text(raw_text)            # byte-preserving
+sorted_yaml = sort_text(raw_text, 2)         # re-indent lists to 2 spaces
+```
+
+## Development
+
+```sh
+pip install -e .[dev]
+pytest
+```

yaml_sort-0.2.1/pyproject.toml

@@ -0,0 +1,42 @@
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "yaml-sort"
+version = "0.2.1"
+description = "Deterministic YAML key sorter — sorts mapping keys alphabetically while preserving comments and byte-for-byte formatting."
+readme = "README.md"
+requires-python = ">=3.9"
+license = "Apache-2.0"
+authors = [{ name = "Soren L. Hansen" }]
+keywords = ["yaml", "sort", "deterministic", "chezmoi", "diff"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+    "Topic :: Text Processing :: Markup",
+]
+dependencies = []
+
+[project.scripts]
+yaml-sort = "yaml_sort.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/sorenisanerd/yaml-sort"
+
+[dependency-groups]
+dev = [
+    "pytest>=8",
+    "PyYAML>=6",
+    "trove-classifiers>=2024.1",
+]
+
+[tool.setuptools]
+package-dir = { "" = "src" }
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-q"

yaml_sort-0.2.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

yaml_sort-0.2.1/src/yaml_sort/__init__.py

@@ -0,0 +1,9 @@
+"""yaml-sort — deterministic YAML key ordering.
+
+Public API: :func:`yaml_sort.core.sort_text`.
+"""
+
+from .core import parse_document, sort_text
+
+__all__ = ["parse_document", "sort_text"]
+__version__ = "0.2.1"

yaml_sort-0.2.1/src/yaml_sort/cli.py

@@ -0,0 +1,91 @@
+"""yaml-sort command-line interface."""
+
+from __future__ import annotations
+
+import argparse
+import difflib
+import os
+import sys
+
+from .core import sort_text
+
+
+def _parse_list_indent(value: str):
+    if value == "keep":
+        return None
+    try:
+        n = int(value)
+    except ValueError:
+        sys.exit(f"error: --list-indent must be 'keep' or an integer, got {value!r}")
+    if n < 0:
+        sys.exit("error: --list-indent must be >= 0")
+    return n
+
+
+def normalize(path: str, list_indent) -> bytes:
+    with open(path, "rb") as f:
+        return sort_text(f.read().decode("utf-8"), list_indent).encode("utf-8")
+
+
+def _build_parser() -> argparse.ArgumentParser:
+    ap = argparse.ArgumentParser(
+        description="Deterministic YAML key sorter — eliminates merge-conflict noise.",
+    )
+    ap.add_argument("files", nargs="*", metavar="FILE", help="YAML file(s) to sort")
+    ap.add_argument("--check", action="store_true", help="Exit 0 if sorted, 1 if not")
+    ap.add_argument("--diff", action="store_true", help="Show diff without writing")
+    ap.add_argument("--stdin", action="store_true", help="Read stdin, write sorted to stdout")
+    ap.add_argument("--list-indent", default="keep", metavar="N|keep",
+                    help="Sequence item indent relative to parent key "
+                         "(0=aligned, 2=indented). 'keep' preserves existing "
+                         "indentation (default).")
+    return ap
+
+
+def main(argv=None) -> None:
+    ap = _build_parser()
+    args = ap.parse_args(argv)
+
+    list_indent = _parse_list_indent(args.list_indent)
+
+    if args.stdin:
+        if args.check or args.diff:
+            sys.exit("error: --stdin incompatible with --check / --diff")
+        sys.stdout.write(sort_text(sys.stdin.read(), list_indent))
+        return
+
+    if not args.files:
+        ap.print_help()
+        sys.exit(1)
+
+    exit_code = 0
+    for path in args.files:
+        if not os.path.isfile(path):
+            print(f"error: not a file — {path}", file=sys.stderr)
+            exit_code = 1
+            continue
+        normalized = normalize(path, list_indent)
+        with open(path, "rb") as f:
+            original = f.read()
+        if args.check:
+            if original != normalized:
+                print(f"not sorted — {path}", file=sys.stderr)
+                exit_code = 1
+            continue
+        if args.diff:
+            if original != normalized:
+                t1 = original.decode("utf-8").splitlines(keepends=True)
+                t2 = normalized.decode("utf-8").splitlines(keepends=True)
+                sys.stdout.writelines(difflib.unified_diff(t1, t2,
+                    fromfile=f"a/{path}", tofile=f"b/{path}"))
+            continue
+        if original == normalized:
+            continue
+        with open(path, "wb") as f:
+            f.write(normalized)
+        print(f"sorted — {path}")
+    sys.exit(exit_code)
+
+
+if __name__ == "__main__":
+    main()

yaml_sort-0.2.1/src/yaml_sort/core.py

@@ -0,0 +1,469 @@
+"""
+yaml_sort — deterministic YAML key ordering.
+
+Reads a YAML document, parses it into a block-structure tree (mappings and
+sequences), sorts sibling mapping keys alphabetically bottom-up, and re-emits.
+In the default ``list_indent=None`` ("keep") mode every byte is preserved
+exactly. Passing ``list_indent=N`` re-indents sequence items so they sit N
+spaces to the right of their parent mapping key (0 = aligned, 2 = indented).
+
+The parser understands lists, folded plain scalars, quoted scalars, and
+comments/gaps, and preserves them verbatim. It is deliberately *not* a
+`yaml.load`/`yaml.dump` round-trip, because that would rewrite the whole file
+(re-quoting, re-indenting, dropping comments) and destroy the diff-cleanliness
+the tool exists to provide.
+
+Notable behaviour:
+
+* Mapping keys are sorted alphabetically, bottom-up, including inside list
+  items and nested maps.
+* List items are *ordered* — a sequence's order is meaningful and is never
+  changed.
+* For a list item that opens a mapping (e.g. ``- api_key: none`` followed by
+  ``base_url:``…), the "anchor" key fused to the ``- `` is sorted along with
+  its siblings, and the ``- `` re-fuses to whichever key sorts first, keeping
+  every list entry fully alphabetical.
+"""
+
+from __future__ import annotations
+
+import re
+
+
+# ── line helpers ─────────────────────────────────────────────────────────────
+
+def _indent(line: str) -> int:
+    return len(line) - len(line.lstrip(" "))
+
+
+def _is_gap(line: str) -> bool:
+    """Blank, comment, document marker, or directive line."""
+    s = line.strip()
+    if not s:
+        return True
+    if s.startswith("#"):
+        return True
+    if s in ("---", "..."):
+        return True
+    if s.startswith("%"):
+        return True
+    return False
+
+
+_KEY_RE = re.compile(r"^(?:['\"]([^'\"]+)['\"]|([^#:\s][^:]*?))\s*:")
+
+
+def _is_key_line(line: str) -> bool:
+    """True if *line* is a mapping key line (not a list item, comment, etc.)."""
+    stripped = line.lstrip()
+    if not stripped or stripped.startswith("- "):
+        return False
+    return bool(_KEY_RE.match(stripped))
+
+
+def _extract_key(line: str) -> str:
+    stripped = line.lstrip()
+    m = _KEY_RE.match(stripped)
+    return (m.group(1) or m.group(2)) if m else stripped.rstrip(":\n")
+
+
+def _strip_indent(line: str) -> str:
+    """Return the line with its leading whitespace removed (keeps the rest)."""
+    return line.lstrip(" ")
+
+
+# ── tree model ───────────────────────────────────────────────────────────────
+
+class Container:
+    """A mapping ('map') or sequence ('seq') made of ordered blocks.
+
+    A mapping that represents a list item (a ``- key:`` line fused to the
+    ``- `` dash) has ``dash_first=True``: its first key is emitted with a
+    ``- `` prefix at ``seq_indent``, and the remaining keys at its own indent.
+    """
+
+    def __init__(self, kind: str, indent: int):
+        self.kind = kind              # 'map' | 'seq'
+        self.indent = indent          # indent of this container's header lines
+        self.dash_first = False       # map whose first key carries the `- `
+        self.seq_indent = 0           # indent of the dash when dash_first
+        self.blocks: list = []        # KeyBlock | ItemBlock | Container | Gap
+
+    def sort(self) -> None:
+        """Sort mapping keys alphabetically, bottom-up. Sequences are ordered."""
+        for b in self.blocks:
+            if isinstance(b, Container):
+                b.sort()
+            elif isinstance(b, (KeyBlock, ItemBlock)) and isinstance(b.value, Container):
+                b.value.sort()
+        if self.kind == "map":
+            self._sort_map_keys()
+
+    def _sort_map_keys(self) -> None:
+        """Rebuild a mapping with keys alphabetised, keeping each gap with the
+        key it followed in the original text (trailing-gap semantics).
+
+        One exception: a run of gap lines that is the *last* block of the
+        container is the container's own terminal/footer comment, not the
+        preceding key's. It stays pinned at the very end, so a footer comment
+        at the bottom of a file is not dragged into the middle when the
+        neighbouring key re-sorts.
+        """
+        leading_gap: list[str] = []
+        trailing_gap: list[str] = []
+        pairs: list[tuple[KeyBlock, list[str]]] = []   # (key, trailing_gap)
+        cur: tuple[KeyBlock, list[str]] | None = None
+        last = len(self.blocks) - 1
+        for i, b in enumerate(self.blocks):
+            if isinstance(b, Gap):
+                if cur is None:
+                    leading_gap.extend(b.lines)
+                elif i == last:
+                    trailing_gap.extend(b.lines)
+                else:
+                    cur[1].extend(b.lines)
+            else:
+                cur = (b, [])
+                pairs.append(cur)
+        pairs.sort(key=lambda p: p[0].name)
+        new_blocks: list = []
+        if leading_gap:
+            new_blocks.append(Gap(leading_gap))
+        for kb, trailing in pairs:
+            new_blocks.append(kb)
+            if trailing:
+                new_blocks.append(Gap(trailing))
+        if trailing_gap:
+            new_blocks.append(Gap(trailing_gap))
+        self.blocks = new_blocks
+
+
+class Gap:
+    """A run of blank/comment/directive lines kept verbatim."""
+
+    def __init__(self, lines: list[str]):
+        self.lines = lines
+
+
+class KeyBlock:
+    def __init__(self, name: str, header: str, cont: list[str] | None = None):
+        self.name = name
+        self.header = header          # header line text minus leading indent
+        self.cont = cont or []        # folded plain-scalar continuation lines
+        self.value = None             # Container | None
+        self.dash_anchor = False      # True if emitted with a `- ` prefix
+        self.anchor_indent = 0        # indent of the enclosing seq when anchor
+
+
+class ItemBlock:
+    def __init__(self, header: str, cont: list[str] | None = None):
+        self.header = header          # header line text minus leading indent
+        self.cont = cont or []        # folded plain-scalar continuation lines
+        self.value = None             # Container | None
+
+
+# ── parser ───────────────────────────────────────────────────────────────────
+
+def _inline_value(line: str) -> bool:
+    """True if *line* has an inline scalar value after its key/`-` prefix.
+
+    e.g. `catgirl: You are...` → True; `models:` → False.
+    """
+    h = line.lstrip()
+    if h.startswith("- "):
+        h = h[2:].lstrip()
+    m = _KEY_RE.match(h)
+    if not m or m.end() >= len(h):
+        return False
+    rest = h[m.end():].lstrip()
+    return bool(rest) and not rest.startswith("#")
+
+
+def _value_quoted(line: str) -> bool:
+    """True if the inline value of *line* is single- or double-quoted.
+
+    Quoted scalars may wrap onto deeper lines containing colons, so their
+    continuations must be consumed verbatim.
+    """
+    h = line.lstrip()
+    if h.startswith("- "):
+        h = h[2:].lstrip()
+    m = _KEY_RE.match(h)
+    if not m or m.end() >= len(h):
+        return False
+    rest = h[m.end():].lstrip()
+    return rest[:1] in ("'", '"')
+
+
+def _split_item_header(header: str):
+    """For a `- ...` item header, return (name, has_inline) if it opens a map.
+
+    `- api_key: none` → ('api_key', True); `- value` (no colon) → None.
+    """
+    h = header[2:].lstrip()
+    m = _KEY_RE.match(h)
+    if not m:
+        return None
+    name = m.group(1) or m.group(2)
+    return name, _inline_value("- " + h)
+
+
+def _gather_cont(lines, idx: int, indent: int, quoted: bool = False):
+    """Collect folded plain-scalar continuation lines deeper than *indent*.
+
+    Returns (cont_lines, next_idx). Stops at a gap, a line at/below *indent*,
+    or (for plain scalars) a key/item line. For *quoted* scalars, every deeper
+    line is consumed verbatim regardless of colons.
+    """
+    cont: list[str] = []
+    i = idx
+    while i < len(lines):
+        line = lines[i]
+        if _is_gap(line) or _indent(line) <= indent:
+            break
+        if not quoted:
+            s = line.lstrip()
+            if _is_key_line(line) or s.startswith("- "):
+                break
+        cont.append(line[indent:])
+        i += 1
+    return cont, i
+
+
+def parse_block(lines, idx: int, indent: int, kind: str):
+    """Parse a single mapping key or sequence item at *indent*.
+
+    Returns (KeyBlock|ItemBlock|Container, next_idx).
+    """
+    raw = lines[idx]
+    i = idx + 1
+    header = _strip_indent(raw)
+
+    if kind == "map":
+        name = _extract_key(raw)
+        has_inline = _inline_value(raw)
+        quoted = _value_quoted(raw)
+        item_key = None
+    else:
+        item_key = _split_item_header(header)
+        name = item_key[0] if item_key else None
+        has_inline = item_key[1] if item_key else False
+        quoted = _value_quoted(raw)
+
+    cont: list[str] = []
+    value = None
+    anchor_block = None
+    dash_map = None
+
+    j = i
+    while j < len(lines) and _is_gap(lines[j]):
+        j += 1
+
+    if j < len(lines):
+        nind = _indent(lines[j])
+        s = lines[j].lstrip()
+        next_is_block = nind > indent and (_is_key_line(lines[j]) or s.startswith("- "))
+
+        if kind == "seq" and item_key is not None and next_is_block and not quoted:
+            # A list item that opens a mapping.
+            ckind = "seq" if s.startswith("- ") else "map"
+            if ckind == "map":
+                cmap, i = parse_container(lines, i, nind, "map")
+                if has_inline:
+                    # `- api_key: none` then `base_url:…`: the anchor key is a
+                    # sibling of the deeper keys. Represent as one dash_first
+                    # map so the anchor participates in sorting.
+                    anchor = KeyBlock(item_key[0], header[2:].lstrip())
+                    cmap.blocks.insert(0, anchor)
+                    cmap.dash_first = True
+                    cmap.seq_indent = indent
+                    dash_map = cmap
+                else:
+                    # `- api_key:` (empty value) then deeper keys: the deeper
+                    # map is the anchor's value; the anchor stays pinned.
+                    anchor = KeyBlock(item_key[0], header[2:].lstrip())
+                    anchor.dash_anchor = True
+                    anchor.anchor_indent = indent
+                    anchor.value = cmap
+                    anchor_block = anchor
+            else:
+                value, i = parse_container(lines, i, nind, ckind)
+        elif next_is_block and not has_inline:
+            # Child container for a key with no inline value (e.g. `models:`
+            # followed by an indented/aligned sequence, or a nested map).
+            ckind = "seq" if s.startswith("- ") else "map"
+            value, i = parse_container(lines, i, nind, ckind)
+        elif nind > indent:
+            # Deeper plain text → folded scalar continuation.
+            cont, i = _gather_cont(lines, i, indent, quoted=quoted)
+        elif (nind == indent and kind == "map"
+              and s.startswith("- ") and not has_inline):
+            # Aligned sequence value (items at the same indent as the key).
+            value, i = parse_container(lines, i, indent, "seq")
+
+    if dash_map is not None:
+        return dash_map, i
+    if anchor_block is not None:
+        return anchor_block, i
+    blk = KeyBlock(name, header, cont) if kind == "map" else ItemBlock(header, cont)
+    blk.value = value
+    return blk, i
+
+
+def parse_container(lines, idx: int, indent: int, kind: str):
+    """Parse a container whose header lines are at *indent*.
+
+    Returns (Container, next_idx). Stops when a line drops below *indent* or a
+    line at *indent* is the wrong type for this container.
+    """
+    cont = Container(kind, indent)
+    i = idx
+    pending_gap: list[str] = []
+
+    while i < len(lines):
+        line = lines[i]
+        ind = _indent(line)
+
+        if _is_gap(line):
+            if ind < indent:
+                # A gap (blank/comment) at a shallower indent belongs to the
+                # enclosing container, not this one — bubble up. Otherwise a
+                # footer comment at indent 0 would be swallowed by the previous
+                # leaf map instead of landing at the document root.
+                break
+            pending_gap.append(line)
+            i += 1
+            continue
+
+        if ind < indent:
+            break
+
+        if ind == indent:
+            if kind == "map" and _is_key_line(line):
+                block_lines = pending_gap
+                pending_gap = []
+                if block_lines:
+                    cont.blocks.append(Gap(block_lines))
+                blk, i = parse_block(lines, i, indent, "map")
+                cont.blocks.append(blk)
+            elif kind == "seq" and line.lstrip().startswith("- "):
+                block_lines = pending_gap
+                pending_gap = []
+                if block_lines:
+                    cont.blocks.append(Gap(block_lines))
+                blk, i = parse_block(lines, i, indent, "seq")
+                cont.blocks.append(blk)
+            else:
+                # Wrong type at this indent → container ends here.
+                break
+        else:  # ind > indent
+            # Continuation not attached to a block; stop to be safe.
+            break
+
+    if pending_gap:
+        cont.blocks.append(Gap(pending_gap))
+    return cont, i
+
+
+def parse_document(text: str):
+    lines = text.splitlines(keepends=True)
+    i = 0
+    while i < len(lines) and _is_gap(lines[i]):
+        i += 1
+    if i >= len(lines):
+        # Comment-only / blank document: preserve the gaps verbatim.
+        root = Container("map", 0)
+        if lines:
+            root.blocks.append(Gap(lines))
+        return root, lines
+    s = lines[i].strip()
+    kind = "seq" if s.startswith("- ") else "map"
+    indent = _indent(lines[i])
+    root, _ = parse_container(lines, i, indent, kind)
+    # Attach any leading gaps to the root.
+    if i > 0:
+        root.blocks.insert(0, Gap(lines[:i]))
+    return root, lines
+
+
+def _eol(s: str) -> str:
+    """Ensure a line ends with a newline (idempotent)."""
+    return s if s.endswith("\n") else s + "\n"
+
+
+# ── emitter ──────────────────────────────────────────────────────────────────
+
+def _emit_keep(node: Container, out: list[str]) -> None:
+    first = True
+    for b in node.blocks:
+        if isinstance(b, Gap):
+            out.extend(_eol(line) for line in b.lines)
+            continue
+        if isinstance(b, Container):
+            _emit_keep(b, out)
+            continue
+        if node.dash_first and first:
+            out.append(_eol(" " * node.seq_indent + "- " + b.header))
+            for c in b.cont:
+                out.append(_eol(" " * node.seq_indent + c))
+        elif isinstance(b, KeyBlock) and b.dash_anchor:
+            out.append(_eol(" " * b.anchor_indent + "- " + b.header))
+            for c in b.cont:
+                out.append(_eol(" " * b.anchor_indent + c))
+        else:
+            out.append(_eol(" " * node.indent + b.header))
+            for c in b.cont:
+                out.append(_eol(" " * node.indent + c))
+        first = False
+        if isinstance(b.value, Container):
+            _emit_keep(b.value, out)
+
+
+def _emit_reindent(node: Container, indent: int, list_indent: int, out: list[str]) -> None:
+    """Re-indent sequences to *list_indent* spaces under their parent key.
+
+    Mapping nesting always steps by 2; a sequence's items are placed at the
+    parent line's indent plus *list_indent* (0 → aligned, 2 → indented).
+    """
+    first = True
+    for b in node.blocks:
+        if isinstance(b, Gap):
+            out.extend(_eol(line) for line in b.lines)
+            continue
+        if isinstance(b, Container):
+            # A dash_first list-item map nested in a sequence: its dash sits at
+            # the seq's target indent.
+            _emit_reindent(b, indent, list_indent, out)
+            continue
+        if node.dash_first and first:
+            key_indent = indent
+            prefix = "- "
+        elif isinstance(b, KeyBlock) and b.dash_anchor:
+            key_indent = indent
+            prefix = "- "
+        else:
+            key_indent = indent + (2 if node.dash_first else 0)
+            prefix = ""
+        out.append(_eol(" " * key_indent + prefix + b.header))
+        for c in b.cont:
+            out.append(_eol(" " * key_indent + c))
+        first = False
+        if isinstance(b.value, Container):
+            child = key_indent + (2 if b.value.kind == "map" else list_indent)
+            _emit_reindent(b.value, child, list_indent, out)
+
+
+def sort_text(text: str, list_indent=None) -> str:
+    root, _ = parse_document(text)
+    root.sort()
+    out: list[str] = []
+    if list_indent is None:                    # keep (byte-exact)
+        _emit_keep(root, out)
+    else:
+        _emit_reindent(root, root.indent, list_indent, out)
+    result = "".join(out)
+    # If the source did not end with a newline, the emitters' guaranteed-eol
+    # lines would inject a trailing one; strip it so byte-exactness holds.
+    if not text.endswith("\n") and result.endswith("\n"):
+        result = result[:-1]
+    return result

yaml_sort-0.2.1/src/yaml_sort.egg-info/PKG-INFO

@@ -0,0 +1,81 @@
+Metadata-Version: 2.4
+Name: yaml-sort
+Version: 0.2.1
+Summary: Deterministic YAML key sorter — sorts mapping keys alphabetically while preserving comments and byte-for-byte formatting.
+Author: Soren L. Hansen
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/sorenisanerd/yaml-sort
+Keywords: yaml,sort,deterministic,chezmoi,diff
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Text Processing :: Markup
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# yaml-sort
+
+Deterministic YAML key ordering. Sorts mapping keys alphabetically (bottom-up)
+while preserving comments and byte-for-byte formatting, so running it produces
+no diff when a file is already sorted.
+
+Designed to keep `chezmoi`-managed config diffs clean.
+
+## Why not just `yaml.load` → sort → `yaml.dump`?
+
+A library round-trip rewrites the whole file: it drops comments, re-quotes
+strings, re-indents everything, and normalizes flow/block style. That adds
+diff noise on every run. `yaml-sort` instead parses the *block structure* and
+re-emits it verbatim, moving only what it needs to (mapping keys).
+
+## Features
+
+- Sorts mapping keys alphabetically, bottom-up — including inside list items
+  and nested maps.
+- Never reorders list items (sequence order is meaningful).
+- A comment that is the *last* thing in a file (a footer) stays pinned at the
+  very bottom — it is not dragged into the middle when the neighbouring key
+  re-sorts.
+- For a list item that opens a map (`- api_key: none` then `base_url:`…), the
+  anchor key fused to the `- ` is sorted with its siblings and the `- `
+  re-fuses to whichever key sorts first, keeping every list entry fully
+  alphabetical.
+- `--list-indent keep` (default): preserve existing indentation byte-for-byte.
+- `--list-indent N`: re-indent sequence items N spaces right of their parent key
+  (0 = aligned, 2 = conventional indented style).
+- `--check`, `--diff`, `--stdin` modes.
+
+## Install
+
+```sh
+pip install yaml-sort        # from PyPI (once published)
+# or, from a checkout:
+pip install -e .
+```
+
+## Usage
+
+```
+yaml-sort <file>                  Sort file in-place
+yaml-sort <file> --check          Exit 0 if sorted, 1 if not
+yaml-sort <file> --diff           Show what would change
+yaml-sort <file> --list-indent 2  Also re-indent lists 2 spaces under their key
+yaml-sort --stdin                 Read stdin, write sorted to stdout
+```
+
+## Library use
+
+```python
+from yaml_sort import sort_text
+
+sorted_yaml = sort_text(raw_text)            # byte-preserving
+sorted_yaml = sort_text(raw_text, 2)         # re-indent lists to 2 spaces
+```
+
+## Development
+
+```sh
+pip install -e .[dev]
+pytest
+```

yaml_sort-0.2.1/src/yaml_sort.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+LICENSE
+README.md
+pyproject.toml
+src/yaml_sort/__init__.py
+src/yaml_sort/cli.py
+src/yaml_sort/core.py
+src/yaml_sort.egg-info/PKG-INFO
+src/yaml_sort.egg-info/SOURCES.txt
+src/yaml_sort.egg-info/dependency_links.txt
+src/yaml_sort.egg-info/entry_points.txt
+src/yaml_sort.egg-info/top_level.txt
+tests/test_packaging.py
+tests/test_yaml_sort.py

yaml_sort-0.2.1/src/yaml_sort.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

yaml_sort-0.2.1/src/yaml_sort.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+yaml-sort = yaml_sort.cli:main

yaml_sort-0.2.1/src/yaml_sort.egg-info/top_level.txt

@@ -0,0 +1 @@
+yaml_sort

yaml_sort-0.2.1/tests/test_packaging.py

@@ -0,0 +1,33 @@
+"""Packaging-metal metadata tests.
+
+These catch upload-time failures that ``twine check`` misses. In particular,
+PyPI rejects a wheel whose ``classifiers`` contain a Trove classifer that is
+not in PyPI's authoritative list (HTTP 400 "is not a valid classifier") — see
+commit 37b6105. ``twine check`` does NOT validate classifiers against that
+list; only this test does, via the ``trove-classifiers`` package (the same
+source-trove list PyPI accepts uploads against).
+"""
+
+import tomllib
+
+import pytest
+import trove_classifiers
+
+PROJECT_ROOT = __import__("pathlib").Path(__file__).resolve().parents[1]
+PYPROJECT = PROJECT_ROOT / "pyproject.toml"
+
+
+def _classifiers() -> list[str]:
+    with PYPROJECT.open("rb") as f:
+        data = tomllib.load(f)
+    return data["project"]["classifiers"]
+
+
+def test_every_classifier_is_a_valid_trove_classifier():
+    known = trove_classifiers.classifiers
+    invalid = [c for c in _classifiers() if c not in known]
+    assert not invalid, f"classifiers not in PyPI's Trove list: {invalid}"
+
+
+def test_at_least_one_classifier():
+    assert len(_classifiers()) > 0

yaml_sort-0.2.1/tests/test_yaml_sort.py

@@ -0,0 +1,139 @@
+"""Unit tests for yaml-sort's core sorting/emission behaviour.
+
+Each case is a pair of fixture files under ``tests/fixtures/``:
+
+    <case>.in.yaml       input document
+    <case>.out.yaml      expected output  (REQUIRED for every case, even when
+                                           it equals the input)
+
+``.out.yaml`` is mandatory so there is no ambiguity about what a case asserts.
+``test_fixture_pairing`` enforces that every ``.in.yaml`` has a matching
+``.out.yaml`` (and vice versa), and that every case in the tables below has
+both files.
+
+The ``list_indent`` column is the value to pass to
+:func:`~yaml_sort.sort_text` (None means leave it default).
+
+Reading from files (rather than inline strings) keeps expected output readable
+with no escaping.
+"""
+
+import pytest
+
+from yaml_sort import sort_text
+
+FIXTURES = __import__("pathlib").Path(__file__).parent / "fixtures"
+
+
+def _read(name, suffix):
+    return (FIXTURES / f"{name}.{suffix}").read_text()
+
+
+def _call(name, list_indent, **kw):
+    kwargs = {"list_indent": list_indent} if list_indent is not None else {}
+    kwargs.update(kw)
+    return sort_text(_read(name, "in.yaml"), **kwargs)
+
+
+# ── all cases: (name, list_indent) ───────────────────────────────────────────
+CASES = [
+    # basic key sorting
+    ("sort_top_level_keys", None),
+    ("already_sorted", None),
+    ("stability", None),
+    ("nested_map_sort", None),
+    ("deep_nested_sort", None),
+    # sequence handling (order preserved)
+    ("list_order_preserved", None),
+    ("list_of_scalars", None),
+    ("nested_list_preserved", None),
+    ("aligned_list_under_key", None),
+    # anchor behaviour
+    ("anchor_sorts", None),
+    ("anchor_already_first", None),
+    ("anchor_no_inline_value", None),
+    ("keys_inside_list_items", None),
+    # comments and gaps
+    ("comments_preserved", None),
+    ("blank_lines", None),
+    ("comment_in_list_item", None),
+    ("inline_comment", None),
+    # trailing footer comments
+    ("trailing_comment_stays_bottom", None),
+    ("trailing_comment_nested", None),
+    ("trailing_comment_after_nested", None),
+    # scalars and quoting
+    ("folded_plain_scalar", None),
+    ("quoted_scalar_with_colon", None),
+    ("quoted_empty_scalar", None),
+    ("comment_only", None),
+    ("trailing_newline", None),
+    ("unicode", None),
+    ("quoted_keys", None),
+    ("empty_map_value", None),
+    ("flow_style", None),
+    # list-indent modes
+    ("list_indent_zero", 0),
+    ("list_indent_two", 2),
+    ("list_indent_nested", 2),
+    ("list_indent_valid", 2),
+]
+
+
+@pytest.mark.parametrize("name,list_indent", CASES)
+def test_case(name, list_indent):
+    expected = _read(name, "out.yaml")
+    assert _call(name, list_indent) == expected
+
+
+@pytest.mark.parametrize("name,list_indent", CASES)
+def test_case_is_idempotent(name, list_indent):
+    # Sorting the already-sorted output must be a fixed point.
+    once = _call(name, list_indent)
+    kwargs = {"list_indent": list_indent} if list_indent is not None else {}
+    assert sort_text(once, **kwargs) == once
+
+
+# ── fixture integrity ─────────────────────────────────────────────────────────
+
+def test_fixture_pairing():
+    """Every .in.yaml has a matching .out.yaml and vice versa."""
+    ins = sorted(FIXTURES.glob("*.in.yaml"))
+    outs = sorted(FIXTURES.glob("*.out.yaml"))
+    in_names = {p.name[: -len(".in.yaml")] for p in ins}
+    out_names = {p.name[: -len(".out.yaml")] for p in outs}
+    assert in_names == out_names, (
+        f"mismatched fixtures: only-in={in_names - out_names or None}, "
+        f"only-out={out_names - in_names or None}"
+    )
+
+
+def test_every_case_has_fixtures():
+    """Every case in CASES has both files present."""
+    for name, _ in CASES:
+        assert (FIXTURES / f"{name}.in.yaml").is_file(), f"missing {name}.in.yaml"
+        assert (FIXTURES / f"{name}.out.yaml").is_file(), f"missing {name}.out.yaml"
+
+
+def test_no_orphan_fixtures():
+    """Every fixture pair is referenced by CASES."""
+    paired = {p.name[: -len(".in.yaml")] for p in FIXTURES.glob("*.in.yaml")}
+    referenced = {name for name, _ in CASES}
+    assert paired == referenced, (
+        f"unreferenced fixtures: {paired - referenced or None}, "
+        f"referenced-but-missing: {referenced - paired or None}"
+    )
+
+
+# ── properties / standalone ──────────────────────────────────────────────────
+
+def test_empty_document():
+    assert sort_text("") == ""
+
+
+def test_list_indent_reindented_output_is_valid_yaml():
+    yaml = pytest.importorskip("yaml")
+    src = _read("list_indent_valid", "in.yaml")
+    a = yaml.safe_load(src)
+    b = yaml.safe_load(sort_text(src, list_indent=2))
+    assert a == b