byor 0.1.0__tar.gz

byor-0.1.0/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.

byor-0.1.0/PKG-INFO

@@ -0,0 +1,189 @@
+Metadata-Version: 2.4
+Name: byor
+Version: 0.1.0
+Summary: Make custom ast-grep diagnostics easy to set up, share, and expose to AI agents
+Keywords: ast-grep,linter,ai,coding-agent,diagnostics,static-analysis
+Author: Ryan Saxe
+Author-email: Ryan Saxe <ryancsaxe+1@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Quality Assurance
+Requires-Dist: ast-grep-cli>=0.42.3
+Requires-Dist: ruamel-yaml>=0.18
+Requires-Python: >=3.11
+Project-URL: Homepage, https://github.com/RyanSaxe/byor
+Project-URL: Repository, https://github.com/RyanSaxe/byor
+Project-URL: Issues, https://github.com/RyanSaxe/byor/issues
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/RyanSaxe/byor/main/assets/banner.png" alt="byor: Build Your Own Rules" width="600">
+</p>
+
+Write a custom lint rule once and it becomes a live diagnostic in your terminal,
+your editor, and your AI agent's feedback loop.
+
+byor is a small CLI around [ast-grep](https://ast-grep.github.io), a fast
+structural search-and-lint tool. `ast-grep scan` lints from the terminal and
+`ast-grep lsp` shows diagnostics in your editor; byor arranges plain rule files
+and configuration so both work without setup, then adds the two things ast-grep
+leaves out: sharing rules across your repositories, and feeding their
+diagnostics back into AI coding agents.
+
+```yaml
+# .byor/rules/project/no-print.yml
+id: no-print
+language: python
+severity: warning
+message: Use the logging module, not print, in library code.
+rule:
+  pattern: print($$$ARGS)
+metadata:
+  byor:
+    agent_prompt: >
+      Replace this print with a module-level logger,
+      logging.getLogger(__name__), at the appropriate level.
+```
+
+`message` is what you read in the terminal and editor; `agent_prompt` is the
+directive byor hands your AI agent when it trips the rule.
+
+## Install
+
+```bash
+uv tool install byor    # or `uvx byor` to try without installing
+byor install            # set up the skill + your agents' hooks (once)
+byor init               # add byor to a repo
+```
+
+byor bundles ast-grep, so Python 3.11+ is the only requirement. `byor install`
+registers your editor and agent integrations machine-wide; `byor init` adds a
+repository's rule directories and `sgconfig.yml`.
+[docs/ai-agents.md](docs/ai-agents.md) covers what each step writes.
+
+You can also let your AI coding agent handle it: open it in the repo and ask it
+to set up byor.
+
+## Terminal and editor
+
+A rule under `.byor/rules/` is an ordinary ast-grep rule, so the ordinary tools
+read it:
+
+```bash
+ast-grep scan            # lint the repo
+ast-grep scan src/       # ...or a path
+```
+
+For live in-editor diagnostics, point your editor's ast-grep integration at
+`ast-grep lsp`: rules light up as you type and reload when you edit them.
+([editor setup](https://ast-grep.github.io/guide/tools/editors.html).)
+
+## Rule scopes
+
+The same rule format lives at three scopes:
+
+| Scope | Lives in | Shared with |
+| --- | --- | --- |
+| `project` | `.byor/rules/project/` | Your team (committed) |
+| `local` | `.byor/rules/personal/local/` | You, this repo only |
+| `global` | `~/.config/byor/rules/` | You, in every repo |
+
+Global rules are your personal standards; byor makes them apply in every repo.
+Project and local rules override a global rule with the same ID, so a team
+policy or a local experiment takes precedence. See [docs/rules.md](docs/rules.md)
+for the rule workflow and [docs/sync-model.md](docs/sync-model.md) for how byor
+copies global rules into each repo.
+
+## With AI coding agents
+
+Agents can both obey your rules and write new ones:
+
+- **Feedback.** A post-edit hook runs `byor agent-check` after the agent edits a
+  file and feeds the diagnostics back into its context, scoped to the lines it
+  changed, so it fixes violations before moving on.
+- **Capture.** A bundled skill turns durable feedback ("never do this", "always
+  do that") into an ast-grep rule: the agent drafts it, confirms once, and runs
+  `byor add`. When a linter or type checker fits better, the skill offers that
+  instead.
+
+`byor install` wires up the agents you pick (once, machine-wide); `byor hook`
+adds or drops one later.
+
+```bash
+byor install --agents claude-code,codex
+byor hook install --agent cursor
+```
+
+byor supports six harnesses:
+
+| Harness | Skill | Real hook | Diagnostic precision |
+| --- | --- | --- | --- |
+| Claude Code | yes | `PostToolUse` | the edited lines |
+| Codex | yes | `PostToolUse` | the patched lines |
+| Copilot CLI | yes | `postToolUse` | best-effort path |
+| Cursor | yes | `postToolUse` | the edited lines |
+| OpenCode | yes | `tool.execute.after` plugin | the changed file |
+| Pi | yes | `tool_result` extension | the changed file |
+
+A `checks:` section in `.byor/config.yml` (or your global config) runs extra
+command-line tools (a linter, a type checker, anything) on the changed files and
+folds their output into the same feedback. See
+[docs/ai-agents.md](docs/ai-agents.md).
+
+## Continuous integration
+
+Project rules are committed files that work with `ast-grep`, so CI doesn't need
+`byor`: a fresh clone already has everything `ast-grep scan` reads. Scan with
+`--error` so warnings fail the build (a plain scan exits 0 on warnings):
+
+```yaml
+- run: npm install -g @ast-grep/cli
+- run: ast-grep scan --error
+```
+
+## Commands
+
+**Setup.** You run these once to get going.
+
+```text
+byor install        Register byor's AI integrations (machine-wide)
+byor init           Initialize byor in a repository
+byor hook           Add or remove an agent integration
+byor doctor         Check that everything is wired up
+```
+
+**Rules.** Your agent runs these as it captures and manages rules for you.
+
+```text
+byor add            Create a rule in a scope
+byor list           Show rules and where they come from
+byor edit           Open a rule in $EDITOR
+byor remove         Delete a rule
+byor promote        Move a personal rule into shared project rules
+byor exclude        Disable a global rule in this repository
+byor include        Re-enable an excluded global rule
+```
+
+**Automatic.** byor runs these itself: the post-edit hook and self-heal.
+
+```text
+byor agent-check    Render diagnostics for your agent
+byor sync           Mirror global rules into the repo
+```
+
+Every command takes `--help`, and repo-operating commands take `--repo PATH`
+(default: search upward from the current directory).
+
+## Documentation
+
+- [docs/rules.md](docs/rules.md) — rule format, scopes, and the rule workflow
+- [docs/ai-agents.md](docs/ai-agents.md) — AI agent integration and `agent-check`
+- [docs/sync-model.md](docs/sync-model.md) — copies, self-healing, and git hooks

byor-0.1.0/README.md

@@ -0,0 +1,163 @@
+<p align="center">
+  <img src="https://raw.githubusercontent.com/RyanSaxe/byor/main/assets/banner.png" alt="byor: Build Your Own Rules" width="600">
+</p>
+
+Write a custom lint rule once and it becomes a live diagnostic in your terminal,
+your editor, and your AI agent's feedback loop.
+
+byor is a small CLI around [ast-grep](https://ast-grep.github.io), a fast
+structural search-and-lint tool. `ast-grep scan` lints from the terminal and
+`ast-grep lsp` shows diagnostics in your editor; byor arranges plain rule files
+and configuration so both work without setup, then adds the two things ast-grep
+leaves out: sharing rules across your repositories, and feeding their
+diagnostics back into AI coding agents.
+
+```yaml
+# .byor/rules/project/no-print.yml
+id: no-print
+language: python
+severity: warning
+message: Use the logging module, not print, in library code.
+rule:
+  pattern: print($$$ARGS)
+metadata:
+  byor:
+    agent_prompt: >
+      Replace this print with a module-level logger,
+      logging.getLogger(__name__), at the appropriate level.
+```
+
+`message` is what you read in the terminal and editor; `agent_prompt` is the
+directive byor hands your AI agent when it trips the rule.
+
+## Install
+
+```bash
+uv tool install byor    # or `uvx byor` to try without installing
+byor install            # set up the skill + your agents' hooks (once)
+byor init               # add byor to a repo
+```
+
+byor bundles ast-grep, so Python 3.11+ is the only requirement. `byor install`
+registers your editor and agent integrations machine-wide; `byor init` adds a
+repository's rule directories and `sgconfig.yml`.
+[docs/ai-agents.md](docs/ai-agents.md) covers what each step writes.
+
+You can also let your AI coding agent handle it: open it in the repo and ask it
+to set up byor.
+
+## Terminal and editor
+
+A rule under `.byor/rules/` is an ordinary ast-grep rule, so the ordinary tools
+read it:
+
+```bash
+ast-grep scan            # lint the repo
+ast-grep scan src/       # ...or a path
+```
+
+For live in-editor diagnostics, point your editor's ast-grep integration at
+`ast-grep lsp`: rules light up as you type and reload when you edit them.
+([editor setup](https://ast-grep.github.io/guide/tools/editors.html).)
+
+## Rule scopes
+
+The same rule format lives at three scopes:
+
+| Scope | Lives in | Shared with |
+| --- | --- | --- |
+| `project` | `.byor/rules/project/` | Your team (committed) |
+| `local` | `.byor/rules/personal/local/` | You, this repo only |
+| `global` | `~/.config/byor/rules/` | You, in every repo |
+
+Global rules are your personal standards; byor makes them apply in every repo.
+Project and local rules override a global rule with the same ID, so a team
+policy or a local experiment takes precedence. See [docs/rules.md](docs/rules.md)
+for the rule workflow and [docs/sync-model.md](docs/sync-model.md) for how byor
+copies global rules into each repo.
+
+## With AI coding agents
+
+Agents can both obey your rules and write new ones:
+
+- **Feedback.** A post-edit hook runs `byor agent-check` after the agent edits a
+  file and feeds the diagnostics back into its context, scoped to the lines it
+  changed, so it fixes violations before moving on.
+- **Capture.** A bundled skill turns durable feedback ("never do this", "always
+  do that") into an ast-grep rule: the agent drafts it, confirms once, and runs
+  `byor add`. When a linter or type checker fits better, the skill offers that
+  instead.
+
+`byor install` wires up the agents you pick (once, machine-wide); `byor hook`
+adds or drops one later.
+
+```bash
+byor install --agents claude-code,codex
+byor hook install --agent cursor
+```
+
+byor supports six harnesses:
+
+| Harness | Skill | Real hook | Diagnostic precision |
+| --- | --- | --- | --- |
+| Claude Code | yes | `PostToolUse` | the edited lines |
+| Codex | yes | `PostToolUse` | the patched lines |
+| Copilot CLI | yes | `postToolUse` | best-effort path |
+| Cursor | yes | `postToolUse` | the edited lines |
+| OpenCode | yes | `tool.execute.after` plugin | the changed file |
+| Pi | yes | `tool_result` extension | the changed file |
+
+A `checks:` section in `.byor/config.yml` (or your global config) runs extra
+command-line tools (a linter, a type checker, anything) on the changed files and
+folds their output into the same feedback. See
+[docs/ai-agents.md](docs/ai-agents.md).
+
+## Continuous integration
+
+Project rules are committed files that work with `ast-grep`, so CI doesn't need
+`byor`: a fresh clone already has everything `ast-grep scan` reads. Scan with
+`--error` so warnings fail the build (a plain scan exits 0 on warnings):
+
+```yaml
+- run: npm install -g @ast-grep/cli
+- run: ast-grep scan --error
+```
+
+## Commands
+
+**Setup.** You run these once to get going.
+
+```text
+byor install        Register byor's AI integrations (machine-wide)
+byor init           Initialize byor in a repository
+byor hook           Add or remove an agent integration
+byor doctor         Check that everything is wired up
+```
+
+**Rules.** Your agent runs these as it captures and manages rules for you.
+
+```text
+byor add            Create a rule in a scope
+byor list           Show rules and where they come from
+byor edit           Open a rule in $EDITOR
+byor remove         Delete a rule
+byor promote        Move a personal rule into shared project rules
+byor exclude        Disable a global rule in this repository
+byor include        Re-enable an excluded global rule
+```
+
+**Automatic.** byor runs these itself: the post-edit hook and self-heal.
+
+```text
+byor agent-check    Render diagnostics for your agent
+byor sync           Mirror global rules into the repo
+```
+
+Every command takes `--help`, and repo-operating commands take `--repo PATH`
+(default: search upward from the current directory).
+
+## Documentation
+
+- [docs/rules.md](docs/rules.md) — rule format, scopes, and the rule workflow
+- [docs/ai-agents.md](docs/ai-agents.md) — AI agent integration and `agent-check`
+- [docs/sync-model.md](docs/sync-model.md) — copies, self-healing, and git hooks

byor-0.1.0/pyproject.toml

@@ -0,0 +1,55 @@
+[project]
+name = "byor"
+version = "0.1.0"
+description = "Make custom ast-grep diagnostics easy to set up, share, and expose to AI agents"
+readme = "README.md"
+authors = [
+    { name = "Ryan Saxe", email = "ryancsaxe+1@gmail.com" }
+]
+requires-python = ">=3.11"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+keywords = ["ast-grep", "linter", "ai", "coding-agent", "diagnostics", "static-analysis"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Software Development :: Quality Assurance",
+]
+dependencies = [
+    "ast-grep-cli>=0.42.3",
+    "ruamel-yaml>=0.18",
+]
+
+[project.urls]
+Homepage = "https://github.com/RyanSaxe/byor"
+Repository = "https://github.com/RyanSaxe/byor"
+Issues = "https://github.com/RyanSaxe/byor/issues"
+
+[project.scripts]
+byor = "byor.cli:main"
+
+[build-system]
+requires = ["uv_build>=0.11.16,<0.12.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "pre-commit>=4.6.0",
+    "pytest>=9.0.3",
+    "pytest-cov>=7.1.0",
+    "ruff>=0.15.17",
+    "ty>=0.0.49",
+]
+
+[tool.ruff.lint]
+extend-select = ["I", "UP", "B", "SIM"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["tests"]

byor-0.1.0/src/byor/__init__.py

@@ -0,0 +1 @@
+"""BYOR: custom ast-grep diagnostics, easy to set up, share, and expose to AI agents."""