prose-formatter 0.1.2__tar.gz

prose_formatter-0.1.2/.github/actions/build-wheel/action.yml

@@ -0,0 +1,47 @@
+name        : Build wheel
+description : Runs `maturin-action` and uploads the resulting artifact. Caller must check out the repo before invoking this composite.
+
+inputs:
+  command:
+    description : maturin subcommand (`build` or `sdist`)
+    required    : true
+  target:
+    description : Cargo target triple (Linux/macOS/Windows wheel rows). Empty for sdist.
+    required    : false
+    default     : ''
+  manylinux:
+    description : Manylinux compatibility tag (`auto` on Linux, empty elsewhere)
+    required    : false
+    default     : ''
+  args:
+    description : Additional flags passed to maturin
+    required    : false
+    default     : ''
+  name:
+    description : Tag suffix in the uploaded `wheels-{name}` artifact.
+    default     : sdist
+
+runs:
+  using: composite
+  steps:
+    - name: Restore Cargo cache
+      uses: Swatinem/rust-cache@c19371144df3bb44fab255c43d04cbc2ab54d1c4
+      with:
+        cache-on-failure : 'true'
+
+    - name: Run maturin
+      uses: PyO3/maturin-action@3e2bdf6ba6453a61e649744019b8a2d906c7eb38
+      with:
+        command   : ${{ inputs.command }}
+        target    : ${{ inputs.target }}
+        manylinux : ${{ inputs.manylinux }}
+        args      : ${{ inputs.args }}
+        sccache   : ${{ github.ref_type != 'tag' }}
+
+    - name: Upload artifact
+      uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a
+      with:
+        name               : wheels-${{ inputs.name }}
+        path               : target/wheels/*
+        if-no-files-found  : error
+        retention-days     : 7

prose_formatter-0.1.2/.github/actions/provision-uv/action.yml

@@ -0,0 +1,11 @@
+name        : Provision uv with a warm wheel cache
+description : Install the uv binary and restore `~/.cache/uv` keyed off the PEP 723 scripts so subsequent `uv run --script` invocations skip the PyPI fetch.
+
+runs:
+  using: composite
+  steps:
+    - uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b
+      with:
+        version               : latest
+        enable-cache          : true
+        cache-dependency-glob : .github/scripts/*.py

prose_formatter-0.1.2/.github/release.yml

@@ -0,0 +1,22 @@
+changelog:
+  categories:
+    - title: ✨ Features
+      labels:
+        - 🦉 engine
+        - 🪜 alignment
+        - 🪉 ordering
+        - 🪶 formatting
+        - 🪄 cli
+    - title: 📰 Docs
+      labels:
+        - 📰 docs
+    - title: 🗜️ Build
+      labels:
+        - 🗜️ build
+    - title: 🧱 Internals
+      labels:
+        - ⚖️ tests
+        - 🗺️ architecture
+    - title: Other
+      labels:
+        - "*"

prose_formatter-0.1.2/.github/scripts/parse-version.py

@@ -0,0 +1,31 @@
+#!/usr/bin/env -S uv run --script
+# /// script
+# requires-python = ">=3.11"
+# ///
+"""
+Validate that pyproject.toml and Cargo.toml agree with the pushed tag.
+
+Reads from the environment:
+    GITHUB_REF_TYPE  e.g. tag, branch
+    GITHUB_REF_NAME  e.g. 0.1.0, main
+
+Exits 0 on a non-tag run, or on a tag whose declared pyproject.toml and
+Cargo.toml versions match. Exits 1 when either file disagrees with the tag.
+"""
+
+from os      import environ
+from re      import sub
+from tomllib import load
+
+
+if environ.get("GITHUB_REF_TYPE") != "tag":
+    raise SystemExit
+
+version = environ["GITHUB_REF_NAME"]
+for file, table, expected in [
+    ("pyproject.toml", "project", version),
+    ("Cargo.toml",     "package", sub(r"\.?(a|b|rc|dev|post)(\d+)", r"-\1.\2", version)),
+]:
+    with open(file, "rb") as f:
+        if (actual := load(f)[table]["version"]) != expected:
+            raise SystemExit(f"::error::{file} version mismatch: expected {expected}, got {actual}")

prose_formatter-0.1.2/.github/scripts/summary.py

@@ -0,0 +1,113 @@
+#!/usr/bin/env -S uv run --script
+# /// script
+# requires-python = ">=3.11"
+# dependencies = ["jinja2"]
+# ///
+"""
+Render a 🪻 Prose step summary and gate the workflow's exit code.
+
+Subcommands:
+    ci       Render the CI gate summary (reads `RESULT` plus the GitHub
+             defaults). Exits 0 on `success`, 1 otherwise.
+    release  Render the Release gate summary (reads `BUILD`, `SDIST`,
+             `PUBLISH` plus the GitHub defaults). Exits 0 when every
+             required job succeeded, 1 otherwise.
+
+Both subcommands append to `$GITHUB_STEP_SUMMARY`.
+"""
+
+from jinja2  import Environment, FileSystemLoader
+from os      import environ
+from pathlib import Path
+from sys     import argv
+
+ENV = Environment(
+    keep_trailing_newline = True,
+    loader                = FileSystemLoader(Path(__file__).with_name("templates")),
+    lstrip_blocks         = True,
+    trim_blocks           = True
+)
+PLATFORMS = [
+    ("🐧 Linux x86_64",   "*manylinux*x86_64.whl",  "x86_64-unknown-linux-gnu"),
+    ("🐧 Linux aarch64",  "*manylinux*aarch64.whl", "aarch64-unknown-linux-gnu"),
+    ("🍎 macOS x86_64",   "*macosx*x86_64.whl",     "x86_64-apple-darwin"),
+    ("🍎 macOS aarch64",  "*macosx*arm64.whl",      "aarch64-apple-darwin"),
+    ("🪟 Windows x86_64", "*win_amd64.whl",         "x86_64-pc-windows-msvc"),
+    ("🚢 sdist",          "*.tar.gz",               None)
+]
+REPO_URL  = f"{environ['GITHUB_SERVER_URL']}/{environ['GITHUB_REPOSITORY']}"
+SHA       = environ["GITHUB_SHA"]
+
+
+def ci():
+    """
+    Render the CI gate summary and exit with the matrix verdict.
+
+    Reads `RESULT` plus the GitHub-runner defaults, renders
+    `ci-summary.md.j2`, and exits 0 when `RESULT == "success"`,
+    1 otherwise.
+    """
+    REF    = environ.get("GITHUB_HEAD_REF") or environ["GITHUB_REF_NAME"]
+    RESULT = environ["RESULT"]
+    emit(
+        "ci-summary.md.j2",
+        commit_url = f"{REPO_URL}/commit/{SHA}",
+        msg        = f"Result `{RESULT}`",
+        ref        = REF,
+        short      = SHA[:7],
+        tree_url   = f"{REPO_URL}/tree/{REF}"
+    )
+    raise SystemExit(RESULT != "success")
+
+
+def emit(template: str, **vars):
+    """
+    Render `template` with `vars` and append to `$GITHUB_STEP_SUMMARY`.
+
+    Args:
+        template : Filename of a `.md.j2` template under `templates/`.
+        vars     : Substitution context passed to `Template.render`.
+    """
+    with open(environ["GITHUB_STEP_SUMMARY"], "a", encoding="utf-8") as f:
+        f.write(ENV.get_template(template).render(**vars))
+
+
+def release():
+    """
+    Render the Release gate summary and exit with the pipeline verdict.
+
+    Reads `BUILD`, `SDIST`, `PUBLISH` plus the GitHub-runner defaults,
+    renders `release-summary.md.j2`, and exits 0 when every required
+    job (build, sdist, plus publish on tag runs) succeeded.
+    """
+    BUILD    = environ["BUILD"]
+    IS_TAG   = environ.get("GITHUB_REF_TYPE") == "tag"
+    PUBLISH  = environ["PUBLISH"]
+    REF_NAME = environ["GITHUB_REF_NAME"]
+    SDIST    = environ["SDIST"]
+    VERSION   = REF_NAME.removeprefix("v")
+    platforms = [
+        (label, target, next(Path("dist").glob(pattern), None))
+        for label, pattern, target in PLATFORMS
+    ]
+    emit(
+        "release-summary.md.j2",
+        build       = BUILD,
+        commit_link = f"[`{SHA[:7]}`]({REPO_URL}/commit/{SHA})",
+        is_tag      = IS_TAG,
+        platforms   = platforms,
+        publish     = PUBLISH,
+        pypi_url    = f"https://pypi.org/project/prose-formatter/{VERSION}/",
+        sdist       = SDIST,
+        tag_link    = f"[`{REF_NAME}`]({REPO_URL}/releases/tag/{REF_NAME})",
+        tree_link   = f"[`{REF_NAME}`]({REPO_URL}/tree/{REF_NAME})",
+        version     = VERSION
+    )
+    raise SystemExit(
+        BUILD != "success"
+        or SDIST != "success"
+        or (IS_TAG and PUBLISH != "success")
+    )
+
+
+{"ci": ci, "release": release}[argv[1]]()

prose_formatter-0.1.2/.github/scripts/templates/ci-summary.md.j2

@@ -0,0 +1,3 @@
+## 🪻 Prose CI
+
+{{ msg }} for [`{{ short }}`]({{ commit_url }}) on [`{{ ref }}`]({{ tree_url }}).

prose_formatter-0.1.2/.github/scripts/templates/release-summary.md.j2

@@ -0,0 +1,29 @@
+## 🪻 Prose Release
+
+{% if not is_tag -%}
+Build dry-run for {{ commit_link }} on {{ tree_link }}.
+{% elif publish == "success" -%}
+Published [*Prose* {{ version }}]({{ pypi_url }}) from {{ commit_link }} on tag {{ tag_link }}.
+{% elif build != "success" or sdist != "success" -%}
+Build matrix failed for tag {{ tag_link }} at {{ commit_link }}. Publish skipped.
+{% else -%}
+Publish failed for tag {{ tag_link }} at {{ commit_link }}.
+{% endif %}
+
+### Builds
+
+| Platform | Target | Status | Artifact |
+|---|---|---|---|
+{% for label, target, path in platforms %}
+| {{ label }} | {{ ('`' ~ target ~ '`') if target else '—' }} | {{ '✅' if path else '❌' }} | {{ ('`' ~ path.name ~ '`') if path else '—' }} |
+{% endfor %}
+{% if is_tag and publish == "success" %}
+
+### Install
+
+```bash
+pip install prose-formatter=={{ version }}
+```
+
+Each artifact ships a [SLSA build-provenance attestation](https://slsa.dev/spec/v1.0/provenance) verifiable on the [PyPI project page]({{ pypi_url }}).
+{% endif %}

prose_formatter-0.1.2/.github/workflows/check.yml

@@ -0,0 +1,47 @@
+name : 🪻 Check
+
+on:
+  workflow_call:
+    inputs:
+      command:
+        description : The cargo command to run, passed straight to bash inside the runner.
+        required    : true
+        type        : string
+      save-cache:
+        default     : false
+        description : When true the mise and Cargo caches write back to GHA. Set true only on main-branch runs.
+        type        : boolean
+      shared-key:
+        default     : prose
+        description : Swatinem cache scope. Distinct keys allow per-profile cache isolation.
+        type        : string
+
+permissions:
+  contents: read
+
+env:
+  CARGO_PROFILE_DEV_DEBUG : line-tables-only
+  CARGO_TERM_COLOR        : always
+
+jobs:
+  cargo:
+    name    : ${{ inputs.command }}
+    runs-on : ubuntu-latest
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
+
+      - name: Install mise tools
+        uses: jdx/mise-action@1648a7812b9aeae629881980618f079932869151
+        with:
+          cache      : true
+          cache_save : ${{ inputs.save-cache }}
+
+      - name: Restore Cargo cache
+        uses: Swatinem/rust-cache@c19371144df3bb44fab255c43d04cbc2ab54d1c4
+        with:
+          cache-on-failure : 'true'
+          save-if          : ${{ inputs.save-cache }}
+          shared-key       : ${{ inputs.shared-key }}
+
+      - name : Run ${{ inputs.command }}
+        run  : ${{ inputs.command }}

prose_formatter-0.1.2/.github/workflows/ci.yml

@@ -0,0 +1,57 @@
+name     : 🪻 CI
+run-name : 🪻 CI · ${{ github.head_ref || github.ref_name }}
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+concurrency:
+  cancel-in-progress : ${{ github.event_name == 'pull_request' }}
+  group              : ${{ github.workflow }}-${{ github.head_ref || github.ref }}
+
+permissions:
+  contents: read
+
+jobs:
+  check:
+    name : ${{ matrix.name }}
+    uses : ./.github/workflows/check.yml
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - command    : cargo fmt --all --check
+            name       : 🪶 Format
+            shared-key : prose-fmt
+          - command    : cargo machete
+            name       : 🪓 Unused
+            shared-key : prose-audit
+          - command    : cargo clippy --all-targets --locked -- -D warnings
+            name       : 📎 Clippy
+            shared-key : prose-build
+          - command    : cargo build --all-targets --locked
+            name       : 🗜️ Build
+            shared-key : prose-build
+          - command    : cargo test --locked
+            name       : ⚖️ Test
+            shared-key : prose-build
+    with:
+      command    : ${{ matrix.command }}
+      save-cache : ${{ github.event_name == 'push' }}
+      shared-key : ${{ matrix.shared-key }}
+
+  gate:
+    name    : 🗞️ Brief
+    needs   : check
+    if      : always()
+    runs-on : ubuntu-latest
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
+      - uses: ./.github/actions/provision-uv
+
+      - name: Summarize and gate
+        env:
+          RESULT : ${{ needs.check.result }}
+        run: ./.github/scripts/summary.py ci

prose_formatter-0.1.2/.github/workflows/release.yml

@@ -0,0 +1,158 @@
+# Prose release pipeline · tag-driven publish to PyPI via OIDC.
+#
+# Triggers on bare-semver tag push (build + publish) and packaging-relevant PRs
+# (build dry-run only). Builds wheels for Linux x86_64/aarch64, macOS
+# x86_64/aarch64, Windows x86_64, plus an sdist. Trusted publishing means
+# no API tokens are stored in repo or org secrets.
+#
+# The PyPI trusted-publisher contract must exist before the first tag push.
+# Field values, set under Account → Publishing on pypi.org, must match:
+#
+#   PyPI Project Name    prose-formatter
+#   Owner                Jybbs
+#   Repository name      prose
+#   Workflow filename    release.yml
+#   Environment name     release
+#
+# Renaming this file, the `release` environment, the repo, or the owner
+# breaks the trust relationship. Update PyPI before the next tag.
+#
+# https://docs.pypi.org/trusted-publishers/adding-a-publisher/
+
+name     : 🪻 Release
+run-name : 🪻 Release · ${{ github.head_ref || github.ref_name }}
+
+on:
+  push:
+    tags: ['[0-9]*']
+  pull_request:
+    paths:
+      - pyproject.toml
+      - Cargo.toml
+      - .github/workflows/release.yml
+
+concurrency:
+  cancel-in-progress : ${{ github.event_name == 'pull_request' }}
+  group              : ${{ github.workflow }}-${{ github.head_ref || github.ref }}
+
+permissions:
+  contents: read
+
+jobs:
+  plan:
+    name            : 🗺️ Plan
+    runs-on         : ubuntu-latest
+    timeout-minutes : 5
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
+      - uses: ./.github/actions/provision-uv
+
+      - name : Parse tag and validate versions
+        run  : ./.github/scripts/parse-version.py
+
+  build:
+    name            : 🎻 ${{ matrix.name }}
+    needs           : plan
+    runs-on         : ${{ matrix.runner }}
+    timeout-minutes : 30
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - name      : linux-x86_64
+            runner    : ubuntu-latest
+            target    : x86_64-unknown-linux-gnu
+            manylinux : auto
+          - name      : linux-aarch64
+            runner    : ubuntu-24.04-arm
+            target    : aarch64-unknown-linux-gnu
+            manylinux : auto
+          - name      : macos-x86_64
+            runner    : macos-15-intel
+            target    : x86_64-apple-darwin
+          - name      : macos-aarch64
+            runner    : macos-latest
+            target    : aarch64-apple-darwin
+          - name      : windows-x86_64
+            runner    : windows-latest
+            target    : x86_64-pc-windows-msvc
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
+      - uses: ./.github/actions/build-wheel
+        with:
+          command   : build
+          target    : ${{ matrix.target }}
+          manylinux : ${{ matrix.manylinux }}
+          args      : --release --locked
+          name      : ${{ matrix.name }}
+
+  sdist:
+    name            : 🚢 sdist
+    needs           : plan
+    runs-on         : ubuntu-latest
+    timeout-minutes : 10
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
+      - uses: ./.github/actions/build-wheel
+        with:
+          command : sdist
+
+  publish:
+    name            : ${{ github.ref_type == 'tag' && '📯 Publish to PyPI' || '🕯️ Publish dry-run' }}
+    needs           : [build, sdist]
+    runs-on         : ubuntu-latest
+    timeout-minutes : 15
+    environment:
+      name : release
+      url  : https://pypi.org/p/prose-formatter
+    permissions:
+      id-token: write
+    steps:
+      - name: Download all artifacts
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c
+        with:
+          path           : dist
+          pattern        : wheels-*
+          merge-multiple : true
+
+      - uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b
+        with:
+          cache-dependency-glob: ""
+
+      - name: Smoke-install built wheel
+        run: |
+          uv tool install --no-index --find-links=dist prose-formatter
+          prose --version
+
+      - name: Generate PEP 740 attestations
+        uses: astral-sh/attest-action@f589a42a7efb6fe400b4f400de60b4bc90390027
+        if: github.ref_type == 'tag'
+
+      - name: Publish to PyPI
+        if: github.ref_type == 'tag'
+        run: uv publish --trusted-publishing=always dist/*
+
+  gate:
+    name            : 🗞️ Brief
+    needs           : [build, sdist, publish]
+    if              : always()
+    runs-on         : ubuntu-latest
+    timeout-minutes : 5
+    steps:
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
+      - uses: ./.github/actions/provision-uv
+
+      - name: Download all artifacts
+        if: needs.build.result != 'cancelled' && needs.sdist.result != 'cancelled'
+        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c
+        with:
+          path           : dist
+          pattern        : wheels-*
+          merge-multiple : true
+
+      - name: Write release summary
+        env:
+          BUILD   : ${{ needs.build.result }}
+          SDIST   : ${{ needs.sdist.result }}
+          PUBLISH : ${{ needs.publish.result }}
+        run: ./.github/scripts/summary.py release

prose_formatter-0.1.2/.gitignore

@@ -0,0 +1,21 @@
+/target/
+/dist/
+/wheels/
+
+*.pyc
+__pycache__/
+*.so
+*.dylib
+*.dll
+
+.venv/
+.env
+.envrc
+
+.DS_Store
+*.swp
+*.swo
+
+.vscode/
+.idea/
+.claude/settings.local.json