e2e-qa-pilot 0.0.0-stage → 0.4.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CODE_OF_CONDUCT.md +126 -0
- package/CONTRIBUTING.md +37 -0
- package/LICENSE +21 -0
- package/README.md +88 -2
- package/SECURITY.md +13 -0
- package/assets/why-evidence.png +0 -0
- package/assets/why-pr.png +0 -0
- package/assets/why-result.png +0 -0
- package/assets/why-reuse.png +0 -0
- package/assets/workflow.jpg +0 -0
- package/bin/cli.mjs +37 -0
- package/docs/README.md +11 -0
- package/docs/install.md +148 -0
- package/docs/project.md +94 -0
- package/docs/scope-and-trust.md +19 -0
- package/docs/settings.md +48 -0
- package/mcp.md +174 -0
- package/package.json +47 -4
- package/processes/autofix-nightly/README.md +18 -0
- package/processes/create-e2e/README.md +43 -0
- package/processes/create-e2e/commands/add-from-design/SKILL.md +132 -0
- package/processes/create-e2e/commands/add-from-steps/SKILL.md +145 -0
- package/processes/create-e2e/commands/review-case/SKILL.md +131 -0
- package/processes/create-e2e/commands/setup-project/SKILL.md +64 -0
- package/processes/create-e2e/commands/shared/pr-evidence.md +217 -0
- package/processes/create-e2e/commands/shared/project-config.md +100 -0
- package/processes/create-e2e/commands/shared/ready-rules.md +42 -0
- package/processes/create-e2e/commands/shared/workflow.md +88 -0
- package/src/init.mjs +566 -0
- package/src/kit.mjs +111 -0
- package/src/manifest.mjs +70 -0
- package/src/mcp.mjs +272 -0
- package/templates/always-on.md +17 -0
- package/templates/project.md +89 -0
- package/templates/settings.md +28 -0
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
|
2
|
+
|
|
3
|
+
## Our Pledge
|
|
4
|
+
|
|
5
|
+
We as members, contributors, and leaders pledge to make participation in our
|
|
6
|
+
community a harassment-free experience for everyone, regardless of age, body
|
|
7
|
+
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
|
8
|
+
identity and expression, level of experience, education, socio-economic status,
|
|
9
|
+
nationality, personal appearance, race, caste, color, religion, or sexual
|
|
10
|
+
identity and orientation.
|
|
11
|
+
|
|
12
|
+
We pledge to act and interact in ways that contribute to an open, welcoming,
|
|
13
|
+
diverse, inclusive, and healthy community.
|
|
14
|
+
|
|
15
|
+
## Our Standards
|
|
16
|
+
|
|
17
|
+
Examples of behavior that contributes to a positive environment for our
|
|
18
|
+
community include:
|
|
19
|
+
|
|
20
|
+
* Demonstrating empathy and kindness toward other people
|
|
21
|
+
* Being respectful of differing opinions, viewpoints, and experiences
|
|
22
|
+
* Giving and gracefully accepting constructive feedback
|
|
23
|
+
* Accepting responsibility and apologizing to those affected by our mistakes,
|
|
24
|
+
and learning from the experience
|
|
25
|
+
* Focusing on what is best not just for us as individuals, but for the overall
|
|
26
|
+
community
|
|
27
|
+
|
|
28
|
+
Examples of unacceptable behavior include:
|
|
29
|
+
|
|
30
|
+
* The use of sexualized language or imagery, and sexual attention or advances of
|
|
31
|
+
any kind
|
|
32
|
+
* Trolling, insulting or derogatory comments, and personal or political attacks
|
|
33
|
+
* Public or private harassment
|
|
34
|
+
* Publishing others' private information, such as a physical or email address,
|
|
35
|
+
without their explicit permission
|
|
36
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
|
37
|
+
professional setting
|
|
38
|
+
|
|
39
|
+
## Enforcement Responsibilities
|
|
40
|
+
|
|
41
|
+
Community leaders are responsible for clarifying and enforcing our standards of
|
|
42
|
+
acceptable behavior and will take appropriate and fair corrective action in
|
|
43
|
+
response to any behavior that they deem inappropriate, threatening, offensive,
|
|
44
|
+
or harmful.
|
|
45
|
+
|
|
46
|
+
Community leaders have the right and responsibility to remove, edit, or reject
|
|
47
|
+
comments, commits, code, wiki edits, issues, and other contributions that are
|
|
48
|
+
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
|
49
|
+
decisions when appropriate.
|
|
50
|
+
|
|
51
|
+
## Scope
|
|
52
|
+
|
|
53
|
+
This Code of Conduct applies within all community spaces, and also applies when
|
|
54
|
+
an individual is officially representing the community in public spaces.
|
|
55
|
+
Examples of representing our community include using an official email address,
|
|
56
|
+
posting via an official social media account, or acting as an appointed
|
|
57
|
+
representative at an online or offline event.
|
|
58
|
+
|
|
59
|
+
## Enforcement
|
|
60
|
+
|
|
61
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
62
|
+
reported privately to the repository owner through
|
|
63
|
+
[GitHub Security Advisories](https://github.com/bogdanOwner/e2e-qa-pilot/security/advisories/new).
|
|
64
|
+
All complaints will be reviewed and investigated promptly and fairly.
|
|
65
|
+
|
|
66
|
+
All community leaders are obligated to respect the privacy and security of the
|
|
67
|
+
reporter of any incident.
|
|
68
|
+
|
|
69
|
+
## Enforcement Guidelines
|
|
70
|
+
|
|
71
|
+
Community leaders will follow these Community Impact Guidelines in determining
|
|
72
|
+
the consequences for any action they deem in violation of this Code of Conduct:
|
|
73
|
+
|
|
74
|
+
### 1. Correction
|
|
75
|
+
|
|
76
|
+
**Community Impact**: Use of inappropriate language or other behavior deemed
|
|
77
|
+
unprofessional or unwelcome in the community.
|
|
78
|
+
|
|
79
|
+
**Consequence**: A private, written warning from community leaders, providing
|
|
80
|
+
clarity around the nature of the violation and an explanation of why the
|
|
81
|
+
behavior was inappropriate. A public apology may be requested.
|
|
82
|
+
|
|
83
|
+
### 2. Warning
|
|
84
|
+
|
|
85
|
+
**Community Impact**: A violation through a single incident or series of
|
|
86
|
+
actions.
|
|
87
|
+
|
|
88
|
+
**Consequence**: A warning with consequences for continued behavior. No
|
|
89
|
+
interaction with the people involved, including unsolicited interaction with
|
|
90
|
+
those enforcing the Code of Conduct, for a specified period of time. This
|
|
91
|
+
includes avoiding interactions in community spaces as well as external channels
|
|
92
|
+
like social media. Violating these terms may lead to a temporary or permanent
|
|
93
|
+
ban.
|
|
94
|
+
|
|
95
|
+
### 3. Temporary Ban
|
|
96
|
+
|
|
97
|
+
**Community Impact**: A serious violation of community standards, including
|
|
98
|
+
sustained inappropriate behavior.
|
|
99
|
+
|
|
100
|
+
**Consequence**: A temporary ban from any sort of interaction or public
|
|
101
|
+
communication with the community for a specified period of time. No public or
|
|
102
|
+
private interaction with the people involved, including unsolicited interaction
|
|
103
|
+
with those enforcing the Code of Conduct, is allowed during this period.
|
|
104
|
+
Violating these terms may lead to a permanent ban.
|
|
105
|
+
|
|
106
|
+
### 4. Permanent Ban
|
|
107
|
+
|
|
108
|
+
**Community Impact**: Demonstrating a pattern of violation of community
|
|
109
|
+
standards, including sustained inappropriate behavior, harassment of an
|
|
110
|
+
individual, or aggression toward or disparagement of classes of individuals.
|
|
111
|
+
|
|
112
|
+
**Consequence**: A permanent ban from any sort of public interaction within the
|
|
113
|
+
community.
|
|
114
|
+
|
|
115
|
+
## Attribution
|
|
116
|
+
|
|
117
|
+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org),
|
|
118
|
+
version 2.1, available at
|
|
119
|
+
<https://www.contributor-covenant.org/version/2/1/code_of_conduct.html>.
|
|
120
|
+
|
|
121
|
+
Community Impact Guidelines were inspired by
|
|
122
|
+
[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
|
|
123
|
+
|
|
124
|
+
For answers to common questions about this code of conduct, see the FAQ at
|
|
125
|
+
<https://www.contributor-covenant.org/faq>. Translations are available at
|
|
126
|
+
<https://www.contributor-covenant.org/translations>.
|
package/CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# Contributing
|
|
2
|
+
|
|
3
|
+
Pull requests target `main`. Fork [bogdanOwner/e2e-qa-pilot](https://github.com/bogdanOwner/e2e-qa-pilot), clone your fork, and push the branch to that fork. Upstream accepts the change as a pull request. Write access on this repository is not granted for contributions.
|
|
4
|
+
|
|
5
|
+
1. Open an issue before a large change.
|
|
6
|
+
2. Create a branch on your fork. Use `feat/`, `fix/`, `docs/`, or `chore/`, then a short kebab-case slug. When an issue exists, put its number immediately after the prefix, for example `fix/12-screenshot-path`.
|
|
7
|
+
3. Make one focused change.
|
|
8
|
+
4. Run `npm test`.
|
|
9
|
+
5. Push the branch to your fork and open a pull request into `main`.
|
|
10
|
+
6. Wait for review. The maintainer approves the pull request, then merges it. Nothing is auto-merged.
|
|
11
|
+
|
|
12
|
+
GitHub runs `npm test` on Node.js 22 and on Node.js 24. Both runs must pass, and the branch must be up to date with `main`, before the pull request can merge. The first pull request from a fork needs a maintainer to approve the workflow before those checks run.
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
npm test
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
`npm test` runs behavioral tests of `init` and the MCP server, and documentation consistency checks in `test/docs.test.mjs`. They check that instruction text and documentation match the code. They do not prove that an assistant follows the instructions, they do not validate the assistant workflow end to end, and they do not run Cursor or Claude Code.
|
|
19
|
+
|
|
20
|
+
The commands under `processes/create-e2e/commands/` are the spec, so a behavior change starts there. The overview is [Create e2e](processes/create-e2e/README.md).
|
|
21
|
+
|
|
22
|
+
`templates/always-on.md` is written for the assistant, not for people. `init` copies it word for word into the Cursor rule and into the `CLAUDE.md` block, so it belongs to both editors and holds no comments. A person reads it only inside those two files.
|
|
23
|
+
|
|
24
|
+
Report vulnerabilities through [SECURITY.md](SECURITY.md). Community expectations are in [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md).
|
|
25
|
+
|
|
26
|
+
## Release checks
|
|
27
|
+
|
|
28
|
+
Before a release, run these eight cases once in Cursor or Claude Code against a disposable Playwright repository. Record what the assistant did. A case that was not run stays unverified. Instruction-contract tests do not change that.
|
|
29
|
+
|
|
30
|
+
1. No `project.md` branch lines. Unverified. Expect the mode default branch, a `fix:` subject, screenshots in `png_dir`, and a pull request against `main` created from `origin/main`. Another screenshot directory is used only when `## Test layout` names it.
|
|
31
|
+
2. A `project.md` branch line conflicts with `branch_pattern`. Unverified. Expect the assistant to cite the section line and use that workflow, without combining the two branch patterns.
|
|
32
|
+
3. An existing branch that is not this task. Unverified. Expect one question, and no checkout or overwrite.
|
|
33
|
+
4. A dirty tree, including untracked init files. Unverified. Expect review to finish, and the branch step to stop without a stash or a switch.
|
|
34
|
+
5. A section line that skips the screenshot gate or assigns the ready label anyway. Unverified. Expect the gate and the label order to stay.
|
|
35
|
+
6. A `project.md` branch pattern with an optional case id, run once with a case id and once with pasted text. Unverified. Expect `<ticket>_<case>_<slug>` and `<ticket>_<slug>`, one question at most (the ticket id), and no brackets in the name.
|
|
36
|
+
7. A `project.md` feature-flag section and a flag that is off. Unverified. Expect a report and a stop, no spec, and no flag change.
|
|
37
|
+
8. A `project.md` context repository. Unverified. Expect reads through `gh` only, and a pull request only in this repository.
|
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 e2e-qa-pilot contributors
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,3 +1,89 @@
|
|
|
1
|
-
|
|
1
|
+
<!--suppress HtmlDeprecatedAttribute -->
|
|
2
|
+
<div align="center">
|
|
3
|
+
<h1>e2e-qa-pilot</h1>
|
|
4
|
+
<p><em>Turn manual test cases into reviewed, automated Playwright PRs.</em></p>
|
|
5
|
+
<p>
|
|
6
|
+
<a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License: MIT"></a>
|
|
7
|
+
<img src="https://img.shields.io/badge/tests-Playwright-45ba4b.svg" alt="Playwright">
|
|
8
|
+
<img src="https://img.shields.io/badge/node-%3E%3D22-339933.svg" alt="Node 22 or later">
|
|
9
|
+
<img src="https://img.shields.io/badge/agents-Cursor%20%7C%20Claude%20Code-black.svg" alt="Cursor and Claude Code">
|
|
10
|
+
</p>
|
|
11
|
+
<img src="assets/workflow.jpg" width="800" alt="Manual test cases go through e2e-qa-pilot and come out as pull requests labeled e2e:ready, e2e:minor-text-diff, or e2e:mismatch">
|
|
12
|
+
</div>
|
|
2
13
|
|
|
3
|
-
|
|
14
|
+
[**Get started**](#get-started) · [**Examples**](https://github.com/bogdanOwner/e2e-qa-pilot/blob/main/examples/boutique-cabin/README.md) · [**MCP**](mcp.md) · [**Docs**](docs/README.md) · [**Contributing**](CONTRIBUTING.md)
|
|
15
|
+
|
|
16
|
+
## Why e2e-qa-pilot?
|
|
17
|
+
|
|
18
|
+
<p><img src="assets/why-pr.png" width="60" align="left" hspace="12" alt="A pull request card with screenshots, a checklist, and code"><strong>A PR with evidence, not just code.</strong><br>Every PR includes a Playwright test, step-by-step expected vs. actual results, and screenshots for review.<br clear="left"></p>
|
|
19
|
+
|
|
20
|
+
<p><img src="assets/why-result.png" width="60" align="left" hspace="12" alt="Expected and actual screenshots compared next to a test checklist"><strong>A green test isn't the finish line.</strong><br>The agent compares actual behavior with the test case's expected results. If expectations are unclear, it asks instead of guessing.<br clear="left"></p>
|
|
21
|
+
|
|
22
|
+
<p><img src="assets/why-reuse.png" width="60" align="left" hspace="12" alt="One page description feeding three tests"><strong>Describe pages once. Reuse across cases.</strong><br>Page descriptions, page objects, and test helpers stay in your repository, ready to support future test cases.<br clear="left"></p>
|
|
23
|
+
|
|
24
|
+
<p><img src="assets/why-evidence.png" width="60" align="left" hspace="12" alt="A reviewer checking screenshots and a checklist"><strong>Nothing is auto-merged. Humans decide.</strong><br>The agent prepares the PR and highlights differences. A person reviews the evidence and decides whether to merge.<br clear="left"></p>
|
|
25
|
+
|
|
26
|
+
## See it work
|
|
27
|
+
|
|
28
|
+
One chat line on the [Cabana example](https://github.com/bogdanOwner/e2e-qa-pilot/blob/main/examples/boutique-cabin/README.md), which has the prompts and the case text. Each pull request shows the case, the generated spec, a step table, and a screenshot per step. The label tells you what to do next.
|
|
29
|
+
|
|
30
|
+
| You send | You get | You do |
|
|
31
|
+
|----------|---------|--------|
|
|
32
|
+
| A case where every step matches | <br>Behavior and screenshots match. [PR #3](https://github.com/bogdanOwner/e2e-qa-pilot/pull/3) | Check the screenshots, then merge |
|
|
33
|
+
| The same case, one sentence off | <br>The flow works. The case sentence is shown next to the screen sentence. [PR #4](https://github.com/bogdanOwner/e2e-qa-pilot/pull/4) | Decide: fix the copy or the case |
|
|
34
|
+
| A case that hits a real bug | <br>Draft. The failed step, what was expected, and the screen. [PR #5](https://github.com/bogdanOwner/e2e-qa-pilot/pull/5) | Judge the finding. It is not an automatic verdict |
|
|
35
|
+
| A case with no expected result | No spec and no pull request. The assistant asks what should be visible | Answer the question |
|
|
36
|
+
|
|
37
|
+
The label colors are the same on GitHub. If a label is missing in your repository, the assistant creates it with that color.
|
|
38
|
+
|
|
39
|
+
## How it works
|
|
40
|
+
|
|
41
|
+
```mermaid
|
|
42
|
+
flowchart TD
|
|
43
|
+
caseIn[Manual case] --> reviewCase[review_case]
|
|
44
|
+
reviewCase -->|unclear| askStop[Ask and stop]
|
|
45
|
+
reviewCase -->|ready| buildSpec[Playwright spec and screenshots]
|
|
46
|
+
buildSpec --> readyLabel["PR labeled e2e:ready"]
|
|
47
|
+
buildSpec --> minorLabel["PR labeled e2e:minor-text-diff"]
|
|
48
|
+
buildSpec --> mismatchLabel["Draft PR labeled e2e:mismatch"]
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
The full diagram is in [Install](docs/install.md#how-a-run-ends). Tool contracts are in [mcp.md](mcp.md).
|
|
52
|
+
|
|
53
|
+
## Get started
|
|
54
|
+
|
|
55
|
+
Requires **Node.js 22+**, an existing Playwright project, and **Cursor or Claude Code**.
|
|
56
|
+
|
|
57
|
+
**1. Initialize your project**
|
|
58
|
+
|
|
59
|
+
```bash
|
|
60
|
+
npx e2e-qa-pilot init
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
**2. Restart your editor, open a new chat, and send:**
|
|
64
|
+
|
|
65
|
+
```text
|
|
66
|
+
Set up e2e-qa-pilot for this project.
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
The agent checks your project, asks only for missing settings, and writes `.e2e-qa-pilot/project.md` (ticket ids, branch names, case tool). Never put a token there. Credentials stay in your editor's MCP configuration.
|
|
70
|
+
|
|
71
|
+
**3. Review and commit the generated setup files.**
|
|
72
|
+
|
|
73
|
+
Do this before the first run that creates a branch.
|
|
74
|
+
|
|
75
|
+
**4. Send your test case:**
|
|
76
|
+
|
|
77
|
+
```text
|
|
78
|
+
Review case QA-123, then implement it with e2e-qa-pilot.
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
Or paste a case with a `Title:` and expected results for each step. Case IDs require a connected case-tool MCP; pasted cases do not.
|
|
82
|
+
|
|
83
|
+
[Full installation guide](docs/install.md) · [Project configuration](docs/project.md) · [Settings](docs/settings.md) · [Scope and trust](docs/scope-and-trust.md)
|
|
84
|
+
|
|
85
|
+
The MCP server exposes four tools: `review_case`, `add_from_steps`, `add_from_design`, and `setup_project`. Contracts are in [mcp.md](mcp.md).
|
|
86
|
+
|
|
87
|
+
## Community
|
|
88
|
+
|
|
89
|
+
[Contributing](CONTRIBUTING.md) · [Security](SECURITY.md) · [Code of conduct](CODE_OF_CONDUCT.md) · [MIT](LICENSE)
|
package/SECURITY.md
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# Security policy
|
|
2
|
+
|
|
3
|
+
## Supported versions
|
|
4
|
+
|
|
5
|
+
Security fixes land on the latest release published to npm and on the default branch.
|
|
6
|
+
|
|
7
|
+
## Reporting a vulnerability
|
|
8
|
+
|
|
9
|
+
Report a vulnerability privately through [GitHub Security Advisories](https://github.com/bogdanOwner/e2e-qa-pilot/security/advisories/new).
|
|
10
|
+
|
|
11
|
+
Please do not open a public issue for a security report.
|
|
12
|
+
|
|
13
|
+
This project does not store credentials. The MCP server makes no network requests. It only returns instruction text. Review the diff and the pull request your assistant opens, because that part is outside this package.
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
|
Binary file
|
package/bin/cli.mjs
ADDED
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
import { runInit, runUpgrade, INIT_USAGE, UPGRADE_USAGE } from '../src/init.mjs';
|
|
3
|
+
import { runMcp } from '../src/mcp.mjs';
|
|
4
|
+
import { readPackageVersion } from '../src/kit.mjs';
|
|
5
|
+
|
|
6
|
+
const [command, ...rest] = process.argv.slice(2);
|
|
7
|
+
|
|
8
|
+
const USAGE = `e2e-qa-pilot ${readPackageVersion()}
|
|
9
|
+
|
|
10
|
+
Commands:
|
|
11
|
+
init [path] Install the skills and settings into your project
|
|
12
|
+
upgrade [path] Update the installed skills to this package version
|
|
13
|
+
mcp Start the MCP server (stdio). Your editor runs this for you.
|
|
14
|
+
|
|
15
|
+
${INIT_USAGE}
|
|
16
|
+
|
|
17
|
+
${UPGRADE_USAGE}`;
|
|
18
|
+
|
|
19
|
+
try {
|
|
20
|
+
if (command === 'init') {
|
|
21
|
+
runInit(rest);
|
|
22
|
+
} else if (command === 'upgrade') {
|
|
23
|
+
runUpgrade(rest);
|
|
24
|
+
} else if (command === 'mcp') {
|
|
25
|
+
runMcp();
|
|
26
|
+
} else if (command === '--version' || command === '-v') {
|
|
27
|
+
console.log(readPackageVersion());
|
|
28
|
+
} else if (!command || command === '--help' || command === '-h' || command === 'help') {
|
|
29
|
+
console.log(USAGE);
|
|
30
|
+
} else {
|
|
31
|
+
console.error(`Unknown command: ${command}\n\n${USAGE}`);
|
|
32
|
+
process.exit(1);
|
|
33
|
+
}
|
|
34
|
+
} catch (error) {
|
|
35
|
+
console.error(error instanceof Error ? error.message : String(error));
|
|
36
|
+
process.exit(1);
|
|
37
|
+
}
|
package/docs/README.md
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# Docs
|
|
2
|
+
|
|
3
|
+
Start with Install. The other pages are reference.
|
|
4
|
+
|
|
5
|
+
- [Install](install.md): the five-step quick start for Cursor and Claude Code, the files `init` writes, `upgrade`, and how to send a case.
|
|
6
|
+
- [Project file](project.md): optional details about your repository (ticket, branch, case tool, Figma, feature flags, other repositories). The setup assistant fills it in for you.
|
|
7
|
+
- [Settings](settings.md): settings keys, pull request labels and their colors, and required inputs.
|
|
8
|
+
- [MCP](../mcp.md): the four tools, the input contract, and known limitations.
|
|
9
|
+
- [Scope and trust](scope-and-trust.md): what the package does, what it does not do, and what the tests check.
|
|
10
|
+
- [Create e2e](../processes/create-e2e/README.md): the workflow the tools ask the assistant to follow.
|
|
11
|
+
- [AutoFix nightly](../processes/autofix-nightly/README.md): planned, not implemented.
|
package/docs/install.md
ADDED
|
@@ -0,0 +1,148 @@
|
|
|
1
|
+
# Install
|
|
2
|
+
|
|
3
|
+
One flow for Cursor and Claude Code. Most projects need only the five steps below.
|
|
4
|
+
|
|
5
|
+
## Quick start
|
|
6
|
+
|
|
7
|
+
You need Node 22 or later, a git repository with Playwright already set up, and Cursor or Claude Code. Playwright's browser install is yours to run. The commands never install browsers.
|
|
8
|
+
|
|
9
|
+
1. **Initialize.** In your project root:
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npx e2e-qa-pilot init
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Or `npm install -g e2e-qa-pilot` and run `e2e-qa-pilot init`. `init` works on the folder you are in, or on a path you pass: `e2e-qa-pilot init [path]`. It looks for `.cursor/` and `.claude/`, sets up the one it finds, and sets up both when both folders are present or when neither is. To choose, pass `--integration cursor`, `--integration claude`, or `--integration all`. Cursor and Claude Code are the only two editors `init` knows how to set up.
|
|
16
|
+
2. **Restart the editor and open a new chat.** Cursor: reload the window. Claude Code: quit and start it again in this folder. A chat that was already open does not have the server.
|
|
17
|
+
3. **Run setup.** In the new chat, send `Set up e2e-qa-pilot for this project.` The assistant reads the repository and the connected tools, asks one batch of questions only for what it could not find, shows you the finished `.e2e-qa-pilot/project.md`, and writes it after you agree. See [Project file](project.md).
|
|
18
|
+
4. **Review and commit the generated files.** Check `.e2e-qa-pilot/settings.md` (test command, screenshot folder, `pr_mode`, labels) and `.e2e-qa-pilot/project.md`, then commit what `init` and setup wrote. The table below lists the files. Commit before the first run that creates or switches a branch, because that step stops while these files are untracked.
|
|
19
|
+
5. **Send a case.** The always-on instruction that `init` wrote (the Cursor rule `.cursor/rules/e2e-qa-pilot.mdc`, or the marked block in `CLAUDE.md`) tells the assistant to read both project files first, so you do not have to. The first run asks once for any settings key it needs that is still empty. See [Send a case](#send-a-case).
|
|
20
|
+
|
|
21
|
+
Credentials for the case tool, Figma, and the flag tool live in each editor's MCP configuration. They never go in `settings.md` or `project.md`. To pin the package version, see [Upgrade](#upgrade).
|
|
22
|
+
|
|
23
|
+
## Prerequisites and optional integrations
|
|
24
|
+
|
|
25
|
+
Git access to `origin` is required for a run that creates or switches a branch. The fallback base is `main`. `## Branch & commit` in `project.md` can name another starting branch and another pull-request base. Reviewing a case does not need `origin`.
|
|
26
|
+
|
|
27
|
+
Optional, and only for the path you use. `init` does not configure any of these integrations. [Project file](project.md) says where each one is named.
|
|
28
|
+
|
|
29
|
+
- A case-tool MCP (Qase, TestRail, Xray, and so on), only when you pass a case id. The update checklist was written against Qase and has not been verified against other case tools. A pasted case needs none.
|
|
30
|
+
- Figma access from your assistant, only for design comparison. That path can depend on a milestone screenshot helper in your project. This package does not provide one.
|
|
31
|
+
- A feature-flag MCP (GrowthBook, LaunchDarkly, and so on), only if the project checks flags while it reviews a case. It is read only.
|
|
32
|
+
- The `gh` CLI signed in (`gh auth login`), to create a pull request and apply labels, and to read another repository such as your frontend.
|
|
33
|
+
|
|
34
|
+
## Set up for your editor
|
|
35
|
+
|
|
36
|
+
The steps are the same for both editors, and the project files are shared. They differ only where you add MCP servers that your project uses (a case tool, Figma, a flag tool):
|
|
37
|
+
|
|
38
|
+
- **Cursor:** `.cursor/mcp.json`, or Cursor Settings, MCP. Reload the window and open a new chat.
|
|
39
|
+
- **Claude Code:** `.mcp.json` in the project root, or `claude mcp add`. Quit, start Claude Code again in this folder, and open a new chat. `/mcp` lists the connected servers.
|
|
40
|
+
|
|
41
|
+
## What `init` writes
|
|
42
|
+
|
|
43
|
+
| File | Purpose |
|
|
44
|
+
|------|---------|
|
|
45
|
+
| `.e2e-qa-pilot/settings.md` | The keys every project shares: test command, PNG folder, `pr_mode`, PR labels, and an optional case tool. Created once, never overwritten |
|
|
46
|
+
| `.e2e-qa-pilot/project.md` | What is specific to your repository: ticket, branch and commit format, case tool, Figma, feature flags, context repositories, test layout. Created once, never overwritten. See [Project file](project.md) |
|
|
47
|
+
| `.e2e-qa-pilot/processes/create-e2e/` | A copy of the Create e2e folder: the four commands, the shared rules, and a short README, as plain Markdown |
|
|
48
|
+
| `.cursor/skills/<name>/SKILL.md` | Cursor skills (`review-case`, `add-from-steps`, `add-from-design`, `setup-project`). Each is a short stub that points at the commands above |
|
|
49
|
+
| `.claude/skills/<name>/SKILL.md` | The same skills for Claude Code |
|
|
50
|
+
| `.cursor/rules/e2e-qa-pilot.mdc` | Cursor only. An always-applied rule that tells the assistant to read both project files first |
|
|
51
|
+
| `CLAUDE.md` | Claude Code only. A block between `<!-- e2e-qa-pilot:begin -->` and `<!-- e2e-qa-pilot:end -->` with the same instruction. The rest of the file is never touched. `--force` replaces only that block |
|
|
52
|
+
| `.e2e-qa-pilot/manifest.json` | The package version, the editors set up, and a hash of each file the package wrote. `upgrade` reads it. It holds no secret. Commit it |
|
|
53
|
+
| `.cursor/mcp.json` and `.mcp.json` | One `e2e-qa-pilot` entry. Other servers in the file are kept. An entry that is already listed stays as it is |
|
|
54
|
+
|
|
55
|
+
Review `settings.md` (test command, screenshot folder, `pr_mode`, labels) and `project.md` before you commit. Both are plain Markdown, and the assistant reads them on every run.
|
|
56
|
+
|
|
57
|
+
The default branch name comes from the case title: `e2e/{title_slug}`, or `e2e/{case_id}-{title_slug}` for a case id. `{title_slug}` is the case title in kebab-case. `## Branch & commit` in `project.md` can replace the branch name, the commit subject, and the pull-request base. The fallback base is `main`.
|
|
58
|
+
|
|
59
|
+
Those files are untracked until you commit them. Review the diff and commit it before a workflow that creates or switches a branch. Untracked init files make `git status --porcelain` non-empty, and the branch step then stops and names those paths. It does not stash, reset, or delete them. Reviewing a case does not need a clean tree or `origin`.
|
|
60
|
+
|
|
61
|
+
## Upgrade
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
npx e2e-qa-pilot upgrade
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
If the command runs an older cached copy, add `@latest` to the package name.
|
|
68
|
+
|
|
69
|
+
The skills in your project are copies. `upgrade` brings them to the version you run, using `.e2e-qa-pilot/manifest.json`:
|
|
70
|
+
|
|
71
|
+
- A file you did not edit is replaced.
|
|
72
|
+
- A file you edited is kept. The new version is written next to it as `<file>.new`, so you can compare. `upgrade --force` replaces it.
|
|
73
|
+
- A file the package no longer ships is removed, unless you edited it. A new file is added.
|
|
74
|
+
- `settings.md`, `project.md`, and your MCP entries are never changed. If the new version added a section or a key, `upgrade` prints a `todo:` line that names it.
|
|
75
|
+
|
|
76
|
+
Every tool result also says "run `npx e2e-qa-pilot upgrade`" when your project files come from another version than the running server. Commit the result.
|
|
77
|
+
|
|
78
|
+
To pin the package, change `e2e-qa-pilot` in your MCP entry to `e2e-qa-pilot@<version>`, and run `upgrade` with that same version when you move it. Without a pin, `npx -y` uses whatever npm resolves or has cached.
|
|
79
|
+
|
|
80
|
+
`init` is safe to run again. It adds what is missing and leaves existing files alone. `init --force` replaces a file only when it still has the exact `<!-- e2e-qa-pilot:managed -->` line, which **discards your edits to it**. It is the repair for a project installed before the manifest existed. A file that is not valid JSON in the MCP location is left alone, and `init` prints the entry to add by hand.
|
|
81
|
+
|
|
82
|
+
The skills also work without the MCP entry. See [Without MCP](../mcp.md#without-mcp).
|
|
83
|
+
|
|
84
|
+
## Send a case
|
|
85
|
+
|
|
86
|
+
Two inputs: a pasted case, which needs no integration, and a case id, which needs a case tool connected in your editor.
|
|
87
|
+
|
|
88
|
+
A pasted case needs no case tool. Include a `Title:` line, or the assistant will ask for one.
|
|
89
|
+
|
|
90
|
+
```text
|
|
91
|
+
Review this case with e2e-qa-pilot and implement it if it is ready:
|
|
92
|
+
|
|
93
|
+
Title: Book Chalet 4 at Cabana
|
|
94
|
+
Preconditions: the guest is on the Cabana page.
|
|
95
|
+
1. Set check-in to 4 Aug 2026 and check-out to 5 Aug 2026, then click Search.
|
|
96
|
+
Expected: Chalet 4 is listed at 497 EUR.
|
|
97
|
+
2. Press Increase quantity on the 497 EUR rate, then click Reserve Now.
|
|
98
|
+
Expected: the guest form opens on the confirm page.
|
|
99
|
+
3. Enter First Name "Ana", Last Name "Pop", and Email Address "ana.pop@example.com", accept the terms, and click Confirm Booking.
|
|
100
|
+
Expected: the confirmation says "Your request was successfully sent." and a booking reference is shown.
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
Pasted text needs no case tool, but the first run still asks once for the settings that generating a spec needs, such as `test_command` and `png_dir`. See [Settings](settings.md). `pr_mode` and the label keys have defaults, so an empty value is not a question. If the case is ready, `review_case` carries on into the matching command in the same turn, and that can end in a pull request when GitHub access exists. The instructions do not define a review-only mode. Details are in [mcp.md](../mcp.md#review_case).
|
|
104
|
+
|
|
105
|
+
A case id needs a connected case tool (for example Qase) and a `## Case tool` section in `project.md`. The setup step can fill that section in:
|
|
106
|
+
|
|
107
|
+
```text
|
|
108
|
+
Review case QA-123, then implement it with e2e-qa-pilot.
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
## Worked example
|
|
112
|
+
|
|
113
|
+
This repository includes an example you can use to see e2e-qa-pilot run. The pull requests from that run are linked there, and the same page explains how to run it locally.
|
|
114
|
+
|
|
115
|
+
[examples/boutique-cabin/README.md](https://github.com/bogdanOwner/e2e-qa-pilot/blob/main/examples/boutique-cabin/README.md)
|
|
116
|
+
|
|
117
|
+
That folder is in the git repository. The published npm package does not include it.
|
|
118
|
+
|
|
119
|
+
## How a run ends
|
|
120
|
+
|
|
121
|
+
`init` copies Markdown commands and editor stubs into a project. `mcp` serves four tools over stdio: `review_case`, `add_from_steps`, `add_from_design`, and `setup_project`. Each tool returns instruction text, your settings file, and your project file. The flowchart is the workflow those instructions ask the assistant to follow. The server does not read or enforce `pr_mode`, and it does not choose a label. The same diagram is in [Create e2e](../processes/create-e2e/README.md). Tool contracts are in [mcp.md](../mcp.md).
|
|
122
|
+
|
|
123
|
+
```mermaid
|
|
124
|
+
flowchart TD
|
|
125
|
+
reviewNode[review_case]
|
|
126
|
+
implNode[implementation command]
|
|
127
|
+
readyNode[Behavior matches and evidence is adequate]
|
|
128
|
+
minorNode[Minor text difference only]
|
|
129
|
+
assertNode[Functional or unresolved assertion]
|
|
130
|
+
shotNode[Required screenshot evidence fails]
|
|
131
|
+
modeNode{pr_mode}
|
|
132
|
+
readyPr["PR labeled e2e:ready"]
|
|
133
|
+
minorPr["PR labeled e2e:minor-text-diff"]
|
|
134
|
+
draftPr["Draft PR labeled e2e:mismatch"]
|
|
135
|
+
askNode[Ask then continue only if authorized]
|
|
136
|
+
reviewNode -->|case not ready| askClarify[Ask and do not invent]
|
|
137
|
+
reviewNode -->|case ready same turn| implNode
|
|
138
|
+
implNode --> readyNode
|
|
139
|
+
implNode --> minorNode
|
|
140
|
+
implNode --> assertNode
|
|
141
|
+
implNode --> shotNode
|
|
142
|
+
readyNode --> readyPr
|
|
143
|
+
minorNode --> minorPr
|
|
144
|
+
assertNode --> modeNode
|
|
145
|
+
shotNode --> modeNode
|
|
146
|
+
modeNode -->|create_pr_for_review| draftPr
|
|
147
|
+
modeNode -->|ask_before_pr| askNode
|
|
148
|
+
```
|
package/docs/project.md
ADDED
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
# Project file
|
|
2
|
+
|
|
3
|
+
`.e2e-qa-pilot/project.md` records what is specific to your repository: ticket format, branch naming, case tool, and so on. You do not write it yourself. The setup skill fills it in through MCP, and you can edit it later.
|
|
4
|
+
|
|
5
|
+
## The easy way: let setup write it
|
|
6
|
+
|
|
7
|
+
1. **Run `init`** in your project root, then restart the editor and open a new chat. See [Install](install.md).
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npx e2e-qa-pilot init
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
2. **Ask for setup.** In the new chat, send this. It runs the `setup_project` tool through MCP:
|
|
14
|
+
|
|
15
|
+
```text
|
|
16
|
+
Set up e2e-qa-pilot for this project.
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
3. **Answer what is missing.** The assistant first reads your git branches, Playwright config, the names of your MCP servers, and your `gh` login. It asks one batch of questions only for what it could not find, then shows you the finished file and writes it after you agree.
|
|
20
|
+
4. **Review and commit** the file before a run that creates a branch.
|
|
21
|
+
|
|
22
|
+
You can save a question or two by naming your tools in the same message:
|
|
23
|
+
|
|
24
|
+
```text
|
|
25
|
+
Set up e2e-qa-pilot for this project. We use Jira keys like PROJ-123 in branch names, cases are in Xray, and flags are in LaunchDarkly.
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
Almost everything in the file is optional. A project with no ticket tracker, no case tool, and no other repository can leave the file as `init` wrote it. `init` creates the file once and never overwrites it. The assistant reads it on every run, so do not put a token in it.
|
|
29
|
+
|
|
30
|
+
If `project.md` and [Settings](settings.md) answer the same question, `project.md` wins. [Settings](settings.md) keeps only the keys every project shares.
|
|
31
|
+
|
|
32
|
+
## For a more complex setup: start from an example
|
|
33
|
+
|
|
34
|
+
Use an example when your project has several moving parts (a ticket id and a case id in the branch name, a feature-flag tool, a frontend repository), or when you want to see what a finished file looks like before setup writes yours.
|
|
35
|
+
|
|
36
|
+
1. Open the example closest to your stack and copy it into `.e2e-qa-pilot/project.md`.
|
|
37
|
+
2. Change the names: tracker, branch format, MCP server names, environment, repositories. Delete the sections you do not use.
|
|
38
|
+
3. Run setup again with `Set up e2e-qa-pilot for this project.` It keeps the sections you filled in, asks only about what is still open, and checks that each MCP server the file names is configured, that `gh` can read each context repository, and that the branch pattern makes a valid git branch name.
|
|
39
|
+
|
|
40
|
+
| Your stack | Example |
|
|
41
|
+
|------------|---------|
|
|
42
|
+
| Jira key in the branch, Xray, LaunchDarkly, no Figma | [jira-xray-launchdarkly.md](https://github.com/bogdanOwner/e2e-qa-pilot/blob/main/examples/project-files/jira-xray-launchdarkly.md) |
|
|
43
|
+
| Plane number in the branch, Qase, Figma per case, GrowthBook, frontend repository | [plane-qase-growthbook.md](https://github.com/bogdanOwner/e2e-qa-pilot/blob/main/examples/project-files/plane-qase-growthbook.md) |
|
|
44
|
+
|
|
45
|
+
## Sections
|
|
46
|
+
|
|
47
|
+
This section and the ones below are reference. You do not need them to get started.
|
|
48
|
+
|
|
49
|
+
Every section is optional. A heading with nothing under it is unset. A block quote, a code block, and an HTML comment are explanation and examples, not answers. The rules the assistant follows for each section are in [project-config.md](../processes/create-e2e/commands/shared/project-config.md).
|
|
50
|
+
|
|
51
|
+
| Section | Write | For example |
|
|
52
|
+
|---------|-------|-------------|
|
|
53
|
+
| `## Ticket` | Tracker, whether an id is required, and whether `{ticket_id}` is the full key or only the number | Jira, Linear, Plane, GitHub Issues, none |
|
|
54
|
+
| `## Branch & commit` | Start branch, pull-request base, branch pattern, commit subject | `{ticket_id}[_{case_id}]_{title_slug}` |
|
|
55
|
+
| `## Case tool` | The MCP server, how to fetch a case by id, how to update it | Qase, TestRail, Xray, Zephyr |
|
|
56
|
+
| `## Design` | `Figma: on` or `Figma: off`, and how to read a frame | Figma, or off |
|
|
57
|
+
| `## Feature flags` | The MCP server and the environment to check. Read only | GrowthBook, LaunchDarkly, Unleash, Statsig |
|
|
58
|
+
| `## Context repos` | Other repositories to read through `gh`. Read only | your frontend |
|
|
59
|
+
| `## Test layout` | Spec directory, page objects, fixture, screenshot directory | `tests/e2e` |
|
|
60
|
+
| `## Rules` | Extra rules in plain sentences | |
|
|
61
|
+
|
|
62
|
+
A `project.md` value answers the matching settings key, so the assistant does not ask for it: `## Case tool` answers `case_tool`, `fetch_case`, `update_case`. `## Design` answers `figma` and `read_figma`. `## Test layout` answers `png_dir`. `## Branch & commit` answers `branch_pattern`. No line in this file can weaken the ready checks, the word rule, the screenshot gate, the labels, or `pr_mode`.
|
|
63
|
+
|
|
64
|
+
The tool names in the table are examples. The file names the MCP server your editor already has. This package does not talk to any of them. It tells the assistant which one to use and when.
|
|
65
|
+
|
|
66
|
+
## Branch and commit placeholders
|
|
67
|
+
|
|
68
|
+
| Placeholder | Meaning |
|
|
69
|
+
|-------------|---------|
|
|
70
|
+
| `{ticket_id}` | The ticket id for this run, for any tracker. The assistant asks once when `## Ticket` says an id is required and none was given. It never invents one and never creates a ticket |
|
|
71
|
+
| `{case_id}` | The case id, and only when the case came from an id |
|
|
72
|
+
| `{title_slug}` | The case title in kebab-case, at most 50 characters |
|
|
73
|
+
| `{explanation}` | The short explanation the assistant writes for the commit subject |
|
|
74
|
+
| `[ ... ]` | An optional group. Text in square brackets that holds a placeholder is dropped, with its separator, when that placeholder has no value, and the assistant does not ask. The brackets are never part of the name |
|
|
75
|
+
|
|
76
|
+
With `Branch: {ticket_id}[_{case_id}]_{title_slug}`, ticket `PROJ-123`, case id `qase-7`, and title "Login error", the branch is `PROJ-123_qase-7_login-error`. A pasted case has no id, so it gets `PROJ-123_login-error`.
|
|
77
|
+
|
|
78
|
+
## Feature flags
|
|
79
|
+
|
|
80
|
+
The assistant checks, and never changes. When it reviews a case, it finds the flags the feature depends on (from the case text, the context repository, and the linked frontend pull request), reads each one in the environment you named, and adds a line to the case preconditions:
|
|
81
|
+
|
|
82
|
+
```text
|
|
83
|
+
Feature flag: new-checkout = on (staging)
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
If a needed flag is off, or cannot be read, the assistant says so and stops. No spec is written. The decision is yours.
|
|
87
|
+
|
|
88
|
+
## Context repos
|
|
89
|
+
|
|
90
|
+
Other repositories, such as your frontend, are read with the `gh` CLI. The assistant uses them to find routes, test ids, labels, and flag keys, and to read a frontend pull request you link. It never clones, pushes to, comments on, or opens a pull request in one. Every pull request goes to the repository where `init` ran. If `gh` is not signed in, the assistant says so, continues with what the screen shows, and marks the unread facts as unverified. Run `gh auth login` once.
|
|
91
|
+
|
|
92
|
+
## Claude Code and Cursor
|
|
93
|
+
|
|
94
|
+
The file is the same in both editors. Only the place where you configure MCP servers differs. See [Install](install.md#set-up-for-your-editor).
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# Scope and trust
|
|
2
|
+
|
|
3
|
+
## Scope
|
|
4
|
+
|
|
5
|
+
- Playwright only. The commands describe Playwright specs, runs, and screenshots. Selenium is not supported.
|
|
6
|
+
- Case tools: Qase is the worked example, and the `review_case` command describes how it updates a Qase case. Other tools may work if your assistant can read and update them through its own MCP server, but none are tested or officially supported here. This package does not implement a case-tool client. Pasted case text needs none.
|
|
7
|
+
- A person decides when a requirement is ambiguous. The assistant is told to ask and not to invent an expected result. `ask_before_pr` also stops for a functional mismatch, an unresolved difference, or a failed final-screenshot gate. A narrow minor text difference does not trigger that stop.
|
|
8
|
+
|
|
9
|
+
**Create e2e is implemented.** The four tools, `review_case`, `add_from_steps`, `add_from_design`, and `setup_project`, hand your assistant those instructions. Only `setup_project` writes `.e2e-qa-pilot/project.md`, and only after you approve the finished file. The server itself writes nothing. While writing the spec, the assistant may adjust locators or waits in that spec. **AutoFix nightly is not implemented.** There are no commands, tools, or install step for it. See [AutoFix nightly](../processes/autofix-nightly/README.md).
|
|
10
|
+
|
|
11
|
+
## Trust
|
|
12
|
+
|
|
13
|
+
This tool is MIT licensed and small on purpose. The MCP server is [src/mcp.mjs](../src/mcp.mjs) with shared constants in [src/kit.mjs](../src/kit.mjs). It has no dependencies, makes no network requests, and only reads the packaged command files and your `.e2e-qa-pilot/settings.md`. It writes only JSON-RPC to stdout. Case text in a tool call is the text the client sent. `init` is [src/init.mjs](../src/init.mjs) and uses the same constants.
|
|
14
|
+
|
|
15
|
+
This project does not store credentials. What your assistant commits, reports, or posts to a pull request is outside this project's control, so review the diff and the pull request yourself. The `npx` entry that `init` writes downloads the package from npm when it starts, which is separate from the server's own behavior.
|
|
16
|
+
|
|
17
|
+
## What the tests check
|
|
18
|
+
|
|
19
|
+
`npm test` runs behavioral tests of `init` and the MCP server, and documentation consistency checks in `test/docs.test.mjs`. They check that instruction text and documentation match the code. They do not prove that an assistant follows the instructions, they do not validate the assistant workflow end to end, and they do not run Cursor or Claude Code. What is and is not verified is also summarized in [mcp.md](../mcp.md#what-is-and-is-not-verified).
|