trenyx 0.0.0-stage → 0.1.1

package/LICENSE

@@ -0,0 +1,202 @@
+                                 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.
+

package/README.md

@@ -1,3 +1,159 @@
-# Temporary Holding Version
+# trenyx run
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+**Early release.** Scores are self-run and can differ from Trenyx's independent runs.
+
+Plants realistic bugs in a throwaway copy of your repo, runs your tests against each one, and tells you which got through.
+Everything runs on your machine. Your code goes only to the AI provider you already use, through your own key. Nothing goes
+to Trenyx: there is no telemetry, no upload and no Trenyx server in this version.
+
+```sh
+cd your-repo            # a git repo with passing tests
+export ANTHROPIC_API_KEY=...
+npx trenyx run
+```
+
+What you see: it runs your tests twice on a clean copy of your last commit, says which provider gets the code and how many
+files, and asks before sending anything. Then it locks the bug list with a SHA-256 fingerprint, prints where the bugs went,
+runs each bug alone, and prints the score and every bug that got through, with file and line. A markdown report goes to
+`~/.trenyx/reports/` (or `--out`). The score is a self-run score, not an independent Trenyx result. AI output can be wrong, so
+check the bugs and the score before you rely on them. For an independent measure, run by Trenyx and not by you, see
+https://trenyx.io.
+
+`trenyx run --help` lists the options. The useful ones: `--bugs N`, `--test-cmd`, `--path`, `--exclude`, `--copy`,
+`--list-files`, `--bugs-file`, `--max-cost`, `--seed`.
+
+## Where your code goes
+
+| What | Where |
+|---|---|
+| Product source at your last commit, tests removed | Your provider, and only the files the bug writer chooses to open. `--list-files` shows every file it could open; `--path` and `--exclude` narrow that. |
+| Tests, untracked files, `.env`, `.git` history | Nowhere. The view is built from a clean copy of committed files only, and links are never followed. |
+| Your API key | The provider's client only. Tests and bugs run with it removed from their environment. |
+| Anything, to Trenyx | Nothing. The code has no network calls of its own; the only package it uses is the provider's SDK. |
+
+The bug writer is a small loop of our own over the plain Claude API (`src/loop.ts`), with three tools (`src/tools.ts`): list,
+read and search, inside the view and nothing else. There is no write, shell, web or MCP tool to ask for. A check runs on every
+call, and a file that isn't on the view's list reads exactly like one that doesn't exist. The only credential read is the chosen
+provider's: the key is passed in code, and anything else an SDK would pick up by itself (an auth token, a subscription token, a
+saved profile, custom headers, a log setting) is removed from the process first. A run makes the model call and nothing else, and
+saves no session. If `ANTHROPIC_BASE_URL` is set, the screen names that host instead.
+
+Behind a proxy, set `NODE_USE_ENV_PROXY=1` as well as `HTTPS_PROXY` (Node 22.21 or later): Node's own HTTP client ignores
+`HTTPS_PROXY` without it.
+
+**The tests run on your machine like any test run**, with the bugs in them. An AI wrote those bugs, so read them if your
+tests can do real damage: `--bugs-file` runs a list you have checked. A bug that adds a process, a network call or a read
+of credentials is dropped before it runs, but that filter is a check, not a sandbox.
+
+## What it does to your repository
+
+Nothing. Each run happens in a `git clone --shared` in the system temp folder, with its remote removed, so a test that runs
+git cannot reach your branches or stash, your hooks do not run, and nothing is written into your `.git`. `node_modules` and
+anything named by `--copy` are copied once into that folder, and every run gets its own copy of them, so each bug starts
+from the same state. The temp folder is removed at the end, on Ctrl-C, on SIGTERM and on a crash. A `kill -9` leaves only
+that folder behind.
+
+## Where the bugs go
+
+A score only means something if the bugs land where bugs land. Left alone, a writer picks small self-contained files, which
+is where a good suite is strongest, so the spread is a rule the run enforces, not a request:
+
+- **The plan comes first.** Files in the project's language are grouped by folder, and any folder with more than an eighth of
+  the code is split into its subfolders. Each folder gets bugs in proportion to its code (one file counts for 1,500 lines at most).
+- **Limits.** At most 2 bugs in a file, 30% of the bugs in a folder (more only where a folder holds more of the code, as in a
+  flat package), and 25% of the bugs in files smaller than the project's median file. A project with few files loosens the file
+  limit, because the bugs have nowhere else to go.
+- **Kept out by name:** dot folders, generated code, type and config files, and support folders such as `scripts/`, `examples/`
+  and `benchmarks/` above the source root.
+- **Enforced.** A bug that breaks a limit is dropped and the report says why. A folder left short gets one narrow second pass,
+  and if that fails too, the run says plainly which folders are short.
+- **Blind.** The plan sees the view, the language and the bug count, nothing else: never a test, a test file, or which code is
+  tested. Tests are gone from the sizes too.
+
+The run output and the report show where the bugs went; the report adds what the tests did in each folder. A saved list
+(`--bugs-file`) runs as written, and the limits are shown as not applied.
+
+If your test command covers only part of the repository, use `--path` for that part: a bug in code your command never runs
+will always read as got through. The run says so where it can tell, and prints the flag to use:
+
+- a test command that names a folder gets `--path` for it;
+- Go folders with their own `go.mod`, which a root `go test ./...` never reaches, get `--exclude`;
+- when the clean runs fail on something the output names and a clean copy lacks, it prints `--copy` for that;
+- when the root runs no tests but parts of the repository have their own project file, it prints the command for each part.
+
+These read names and the test output only, never reach the bug writer, and change nothing by themselves. There is no coverage
+check, so a folder your tests miss for any other reason is not flagged: it reads as bugs that got through.
+
+## Which kinds of bug
+
+The kinds bundled here are a small subset of the Trenyx bug catalogue: 63 kinds out of about 1,000, each with its name and a
+one-line how-to, and no miss rates. The full catalogue grows with every independent Trenyx run and stays with the hosted service.
+
+Each run gives the writer a random two-thirds of the bundled kinds for your language, so a suite can't be tuned to a fixed list.
+The run prints its seed, and `--seed` draws the same kinds again. It does not repeat the bugs, because the AI writes those fresh
+each time: to run the same bugs again, use `--bugs-file`.
+
+## What it costs
+
+16 bugs is the default and the most: US$0.64 to US$0.99 of AI cost on the two real projects measured so far. `--max-cost` (default US$5) covers the first list, its one retry and the second pass
+together. Cost comes from the token counts the API returns, at Anthropic's list prices; on Bedrock and Vertex that is an
+estimate, because they bill separately. Each reply is held to what the money left can buy, the run stops at 90% of your limit to
+leave room for a last turn, and the second pass may use at most a third of it. A run that hits the limit before a bug list comes
+back runs nothing and says what it spent.
+
+## Bedrock and Vertex
+
+Set `CLAUDE_CODE_USE_BEDROCK=1` with your AWS setup and `AWS_REGION`, or `CLAUDE_CODE_USE_VERTEX=1` with your Google Cloud setup,
+`CLOUD_ML_REGION` and `ANTHROPIC_VERTEX_PROJECT_ID`. Their clients are large, so they stay out of the normal install:
+
+```sh
+npx --package=trenyx --package=@anthropic-ai/bedrock-sdk trenyx run      # or @anthropic-ai/vertex-sdk
+```
+
+## How bugs are scored
+
+The same rules as the Trenyx engine, where they apply. Tests that fail on either clean run never count as a catch; tests that
+fail on only one are flaky and left out. Caught means a new failing test, and each catch is re-run once and must fail one of
+the same tests again. A hang counts as caught only on new failing tests that reproduce, otherwise it is left out. A broken
+build, and a run that only crashes, are left out too. The score is caught over counted. When bugs are left out, the score shows
+how far they could move it, for example "11 of 12 counted; 11 to 15 of 16 if those four count."
+A test that fails both clean runs gets two more before the run stops, so one unstable test doesn't end the check: a test that
+fails some clean runs but not all is left out. Only a test failing all four stops the run.
+
+Two passing clean runs can't rule out a test that fails now and then, and such a test reads as a catch for any bug. So when
+anything was caught, the suite runs clean three more times. A catch resting only on tests that went both ways on identical
+code, in those runs or across a bug's own two runs, is not counted.
+
+A second line says how far the score could move on another draw of bugs, an 80% Wilson interval on caught over counted, for
+example "Likely between 4 and 8 of 15 if different bugs were drawn." The two ranges measure different things.
+
+## Try it from this folder
+
+```sh
+npm ci && npx tsc -p . && npm pack          # needs Node 20.3 or later (22 for the tests)
+cd your-repo && npx --package=/path/to/trenyx-0.0.1.tgz trenyx run
+```
+
+## Tests
+
+```sh
+npm test                                    # needs go, cargo, python3 and Node 22; a missing toolchain is skipped by name
+```
+
+Unit tests use a fake API client, the SDK tests run the real client against a fake provider on localhost, and a Trenyx-side tool replays an engine run's bug list through the spread rule (placement only,
+never scores). End-to-end tests run a tiny repo in each language with canned bugs and hash every byte of it,
+`.git` included, before and after, also after SIGINT and SIGTERM. On macOS a run also passes with every network call denied by
+the OS. With pytest on the PATH the Python tests use pytest, otherwise unittest.
+
+## What ships, and how it was chosen
+
+`src/rules.gen.ts` is generated from the engine's blind view; `src/blind.ts` ports the logic, and the port is measured against
+the engine on real checkouts. `catalogue/slice.json` is the bundled catalogue
+(built by Trenyx's own tools, which aren't in this repository): for each language, the classes marked for every domain, ranked by how many repositories they were
+planted in, never by whether they were caught, at most 36 per language, name and one-line how-to only.  Bug writing sits behind `BugWriter` (`src/writer.ts`) and the catalogue behind `CatalogueSource`
+(`src/catalogue.ts`), so neither the run nor the report depends on where they come from.
+
+## Licence
+
+The code is Apache-2.0 (`LICENSE`); the bug catalogue in `catalogue/` has its own terms (`catalogue/LICENSE`): use it through this
+package on your own code, including at work, but don't copy it out.

package/catalogue/LICENSE

@@ -0,0 +1,7 @@
+The files in this folder are not covered by the Apache License.
+
+Copyright 2026 Saurabh Bhatt.
+
+You may use these files as part of this package to run Trenyx on your own code, including at work and for commercial projects. You may not copy them out of this package, redistribute them, or use them to build or train another product or model. All other rights reserved.
+
+These files are provided as is, without warranty of any kind.