subedit 0.1.0__tar.gz

subedit-0.1.0/.claude/settings.json

@@ -0,0 +1,15 @@
+{
+  "hooks": {
+    "PostToolUse": [
+      {
+        "matcher": "Edit|Write",
+        "hooks": [
+          {
+            "type": "command",
+            "command": "uv run --project \"$CLAUDE_PROJECT_DIR\" subedit-hook"
+          }
+        ]
+      }
+    ]
+  }
+}

subedit-0.1.0/.claude-plugin/marketplace.json

@@ -0,0 +1,11 @@
+{
+  "name": "mroops",
+  "owner": { "name": "mroops0111" },
+  "plugins": [
+    {
+      "name": "subedit",
+      "source": { "source": "github", "repo": "mroops0111/subedit" },
+      "description": "Repairs comment layout silently on write, and returns only what needs rewriting."
+    }
+  ]
+}

subedit-0.1.0/.claude-plugin/plugin.json

@@ -0,0 +1,12 @@
+{
+  "name": "subedit",
+  "displayName": "subedit",
+  "version": "0.1.0",
+  "description": "Repairs comment layout silently on write, and returns only what needs rewriting.",
+  "author": {
+    "name": "mroops0111"
+  },
+  "homepage": "https://github.com/mroops0111/subedit",
+  "repository": "https://github.com/mroops0111/subedit",
+  "license": "MIT"
+}

subedit-0.1.0/.github/dependabot.yml

@@ -0,0 +1,13 @@
+version: 2
+updates:
+  - package-ecosystem: "uv"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    groups:
+      minor-and-patch:
+        patterns:
+          - "*"
+        update-types:
+          - "minor"
+          - "patch"

subedit-0.1.0/.github/release.yml

@@ -0,0 +1,24 @@
+changelog:
+  exclude:
+    labels:
+      - ignore-for-release
+    authors:
+      - dependabot
+  categories:
+    - title: Breaking Changes
+      labels:
+        - breaking
+    - title: Features
+      labels:
+        - feature
+        - enhancement
+    - title: Bug Fixes
+      labels:
+        - bug
+        - fix
+    - title: Documentation
+      labels:
+        - documentation
+    - title: Other Changes
+      labels:
+        - "*"

subedit-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,77 @@
+name: CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+  workflow_dispatch:
+  workflow_call:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.ref_name }}
+  cancel-in-progress: ${{ github.ref != 'refs/heads/master' }}
+
+jobs:
+  lint:
+    name: Lint & Format
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+      - run: uv sync --extra dev
+      - run: uv run ruff check src/ tests/
+      - run: uv run ruff format --check src/ tests/
+
+  typecheck:
+    name: Type Check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+      - run: uv sync --extra dev
+      - run: uv run basedpyright src/ tests/
+
+  test:
+    name: Test (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+          enable-cache: true
+      - run: uv sync --extra dev
+      - run: uv run pytest tests/ -v --tb=short
+
+      - name: Self-hosting
+        run: uv run subedit check src/ tests/
+
+  prose:
+    name: Prose
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: errata-ai/vale-action@reviewdog
+        with:
+          version: 3.18.0
+          files: src tests README.md
+          fail_on_error: true
+          reporter: github-check
+
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    needs: [lint, typecheck, test, prose]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v6
+      - run: uv build

subedit-0.1.0/.github/workflows/pr.yml

@@ -0,0 +1,78 @@
+name: PR
+
+on:
+  pull_request_target:
+    types: [opened, edited, synchronize, reopened]
+
+permissions:
+  pull-requests: write
+  issues: write
+
+jobs:
+  label:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/github-script@v7
+        with:
+          script: |
+            const title = context.payload.pull_request.title || '';
+            const match = title.match(/^([a-zA-Z]+)(\([^)]*\))?(!)?:/);
+            if (!match) {
+              core.info(`Title "${title}" has no conventional prefix, skipping`);
+              return;
+            }
+            const [, type, , bang] = match;
+            const labels = new Set();
+            if (bang) labels.add('breaking');
+            switch (type.toLowerCase()) {
+              case 'feat':
+              case 'feature':
+                labels.add('feature');
+                break;
+              case 'fix':
+                labels.add('bug');
+                break;
+              case 'docs':
+                labels.add('documentation');
+                break;
+              case 'enhance':
+              case 'enhancement':
+                labels.add('enhancement');
+                break;
+            }
+            if (labels.size === 0) {
+              core.info(`Type "${type}" has no label mapping`);
+              return;
+            }
+            const colors = {
+              breaking: 'B60205',
+              feature: '0E8A16',
+              bug: 'D73A4A',
+              documentation: '0075CA',
+              enhancement: 'A2EEEF',
+            };
+            for (const name of labels) {
+              try {
+                await github.rest.issues.getLabel({
+                  ...context.repo,
+                  name,
+                });
+              } catch (e) {
+                if (e.status === 404) {
+                  await github.rest.issues.createLabel({
+                    ...context.repo,
+                    name,
+                    color: colors[name] || 'EDEDED',
+                  });
+                  core.info(`Created missing label "${name}"`);
+                } else {
+                  throw e;
+                }
+              }
+            }
+            await github.rest.issues.addLabels({
+              ...context.repo,
+              issue_number: context.payload.pull_request.number,
+              labels: [...labels],
+            });
+            core.info(`Applied labels: ${[...labels].join(', ')}`);

subedit-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,83 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Verify tag matches pyproject.toml version
+        run: |
+          TAG="${GITHUB_REF_NAME#v}"
+          VERSION=$(python3 -c "import tomllib; print(tomllib.load(open('pyproject.toml','rb'))['project']['version'])")
+          if [ "$TAG" != "$VERSION" ]; then
+            echo "::error::Tag v$TAG does not match pyproject.toml version $VERSION"
+            exit 1
+          fi
+
+      - uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+
+      - run: uv build
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish-pypi:
+    name: Publish
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/subedit
+    permissions:
+      id-token: write
+      attestations: write
+      contents: read
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - uses: actions/attest-build-provenance@v2
+        with:
+          subject-path: 'dist/*'
+
+      - uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    name: GitHub Release
+    needs: publish-pypi
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Create GitHub Release
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          gh release create "${GITHUB_REF_NAME}" \
+            --repo "${GITHUB_REPOSITORY}" \
+            --title "${GITHUB_REF_NAME}" \
+            --generate-notes \
+            dist/*

subedit-0.1.0/.gitignore

@@ -0,0 +1,20 @@
+# Design notes stay local. The generated rule reference is tracked.
+docs/*
+!docs/rules.md
+
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.venv/
+dist/
+build/
+
+# Tooling caches
+.ruff_cache/
+.pytest_cache/
+.coverage
+htmlcov/
+
+# macOS
+.DS_Store

subedit-0.1.0/.vale.ini

@@ -0,0 +1,13 @@
+StylesPath = styles
+MinAlertLevel = error
+
+[*.{py,ts,tsx,js,go,rs}]
+BasedOnStyles = mroops
+mroops.MidSentenceColonMarkup = NO
+
+[*.md]
+BasedOnStyles = mroops
+mroops.MidSentenceColon = NO
+
+[tests/fixtures/vale/*]
+BasedOnStyles =

subedit-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 mroops0111
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

subedit-0.1.0/PKG-INFO

@@ -0,0 +1,193 @@
+Metadata-Version: 2.5
+Name: subedit
+Version: 0.1.0
+Summary: A linter and formatter for the prose inside code comments, across languages.
+Project-URL: Homepage, https://github.com/mroops0111/subedit
+Project-URL: Repository, https://github.com/mroops0111/subedit
+Project-URL: Issues, https://github.com/mroops0111/subedit/issues
+Author: Yun-Tai Yang
+License: MIT
+License-File: LICENSE
+Keywords: comments,formatter,linter,lsp,prose,tree-sitter
+Classifier: Development Status :: 1 - Planning
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Quality Assurance
+Requires-Python: >=3.11
+Requires-Dist: pydantic>=2.13.5
+Requires-Dist: tree-sitter-language-pack>=1.17.0
+Requires-Dist: tree-sitter>=0.26.0
+Requires-Dist: typer>=0.27.2
+Provides-Extra: dev
+Requires-Dist: basedpyright>=1.40.1; extra == 'dev'
+Requires-Dist: pytest>=9.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.16.7; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# subedit
+
+Your house style, enforced in the places prose hides inside a codebase.
+
+A subeditor is the person at a publication who makes every piece of copy match its house style. `subedit` does that job for the prose in your code.
+
+Linters check your code. Almost nothing checks the sentences you write around it. `subedit` reads the comments and docstrings in your source, lays them out one sentence per line, and only tells you about the sentences a tool cannot fix for you.
+
+## Example
+
+An editor wraps a comment at whatever column it reaches, so sentences break mid clause.
+
+```python
+    # Cap the buffer at the runner limit, because an unbounded
+    # read faults the job. Retry once, then give up.
+```
+
+`subedit fix --write` repairs the layout and says nothing.
+
+```python
+    # Cap the buffer at the runner limit, because an unbounded read faults the job.
+    # Retry once, then give up.
+```
+
+A sentence that runs past the width with no comma has nowhere legal to break, and only its author knows where the meaning divides. That one comes back to you, or to the agent that wrote it.
+
+```text
+1 comment finding needs rewriting in src/cache.py.
+Each states the fix. Apply it in place, do not add a suppression comment.
+
+line 2  [unbreakable-sentence]
+  This sentence runs to 116 characters against a budget of 114 characters and contains no comma, so there is no legal place to break it. Add a comma at a clause boundary, or split it into two sentences.
+```
+
+## Installation
+
+Install the command line tool from PyPI.
+
+```bash
+uv tool install subedit
+```
+
+`pipx install subedit` and `pip install subedit` work as well.
+
+## Commands
+
+Every command takes files or directories.
+
+| Command | Result |
+| --- | --- |
+| `subedit check src/` | every finding |
+| `subedit check src/ --output=actionable` | only the sentences that need rewriting |
+| `subedit fix src/` | the repairs, as a diff |
+| `subedit fix src/ --write` | the repairs, applied |
+| `subedit stats src/` | comment shapes across the codebase, for setting thresholds from data |
+| `subedit rules` | every rule and who resolves it |
+
+`check` and `fix` exit 1 while anything needs an author, so they drop into pre-commit or CI as they are.
+
+## Fix Kinds
+
+Every finding says who can resolve it, and the whole design turns on that answer.
+
+| Kind | Resolved by | Reaches you |
+| --- | --- | --- |
+| `TARGETED` | the tool, silently | no |
+| `REFLOW` | the tool, silently | no |
+| `REWRITE` | only the author | yes |
+
+Rewriting a sentence needs its meaning, which a deterministic process cannot supply. Everything else is repaired without a word, because each message costs the reader attention.
+
+## Agent Hook
+
+`subedit-hook` runs after every file an agent edits. It repairs the mechanical findings in place, and exits 2 only when a sentence needs rewriting, which hands the message back to the model.
+
+### Claude Code
+
+The plugin registers the hook. It cannot install the tool, so install that first.
+
+```text
+/plugin marketplace add mroops0111/subedit
+/plugin install subedit@mroops
+```
+
+To register it by hand instead, add this to `.claude/settings.json`.
+
+```json
+{
+  "hooks": {
+    "PostToolUse": [
+      {
+        "matcher": "Edit|Write|MultiEdit|NotebookEdit",
+        "hooks": [{ "type": "command", "command": "subedit-hook" }]
+      }
+    ]
+  }
+}
+```
+
+### Codex
+
+Add this to `~/.codex/hooks.json`.
+
+```json
+{
+  "hooks": {
+    "PostToolUse": [{ "command": "subedit-hook" }]
+  }
+}
+```
+
+### Several Agents
+
+Registering the hook with both agents is the normal case. Each agent names its edit tools differently, so every payload identifies its sender, and a payload from anything else exits 0 untouched. `subedit-hook --help` prints the payload shapes it accepts.
+
+## Configuration
+
+Settings come from `subedit.toml`, or from `[tool.subedit]` in `pyproject.toml`, whichever sits closest above the file being checked.
+
+```toml
+[subedit]
+line-width = 120
+exclude = ["tests/fixtures/**"]
+
+[rules]
+mid-clause-break = "error"
+block-too-long = { severity = "warning", line = 3, doc-public = 20 }
+```
+
+Rule names describe the problem they report. `docs/rules.md` lists every rule, generated from the rules themselves.
+
+## Delegated Tools
+
+`subedit check` also runs two tools where they are installed, and folds their findings into its own report.
+
+- **Vale**: punctuation, banned phrasing, and anything a markup aware prose linter already handles
+- **AutoCorrect**: spacing and punctuation width between CJK and Latin text
+
+`--no-delegate` skips both. `fix` and the agent hook do not run them.
+
+## Surfaces
+
+Code comments are the first surface, and Markdown comes next.
+
+| Surface | Status | Mostly enforces |
+| --- | --- | --- |
+| Code comments and docstrings | working | layout, since comments sit inside a column limit |
+| Markdown | planned | structure, since soft wrapped text barely needs layout |
+| Markdown slides | planned | Markdown, with front matter left as it is |
+
+## Related Tools
+
+`subedit` covers the one thing the usual Python tools leave alone.
+
+| Tool | Checks |
+| --- | --- |
+| ruff | code structure |
+| basedpyright | types |
+| **subedit** | **the natural language inside source** |
+
+## License
+
+MIT