genclass 0.1.0 → 0.2.0

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/CHANGELOG.md CHANGED
@@ -1,5 +1,37 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.2.0
4
+
5
+ - **`genclass dashboard` shows the app in the terminal**: problems found on the live site by kind and page, measured
6
+ visual checks, what was handled, visitors, what the coding agent did with the findings, what the GitHub App is
7
+ doing and what the last suggestions run left. `--range 24h|7d|30d`, `--all`, `--app <name>`, `--open`, `--json`.
8
+ The numbers are the browser dashboard's, from a new route (`GET /api/cli/app`) with the same plan rules. The
9
+ sign-in page now says the command can show them; a sign-in approved before that is asked to sign in once more
10
+ instead of gaining it silently. Signed out, the command still prints an app's private dashboard link.
11
+ - **A short view.** The first screen is three or four lines: what is done, what is next, what waits on something
12
+ outside this machine, what comes later. `d` (or `genclass status --all`) shows every part with what is known about
13
+ it and a fuller explanation, and `d` again folds it back.
14
+ - **Every part of GenClass is a step**: account, runtime, dashboard, test workflow, GitHub App, coding agent,
15
+ suggestions. The workflow file and the GitHub App were one step and are now two, in that order.
16
+ - **One Enter per step.** Enter is the yes for what the step's sentence says it writes, so the workflow file and the
17
+ agent configuration are written without a second question, and an app added after signing in goes into the
18
+ account without being asked again (`init --in-account`). The diff of the runtime's change is still shown first.
19
+ - **The GitHub App connects by itself as far as it can.** The step asks genclass.dev what GitHub says; with no
20
+ answer it opens Continue with GitHub and waits, and when the app is not on the repository it opens GitHub's
21
+ install page and waits until it is. Without a terminal it prints the two links.
22
+ - **An opening wordmark**, GENCLASS in block letters, on a terminal that is wide enough and has the characters.
23
+ Never in piped output or `--json`.
24
+ - `status --json`: step ids are now `account`, `runtime`, `dashboard`, `workflow`, `github-app`, `agent`,
25
+ `suggestions` (were `first-page` and `pull-requests`), and each step has a short `title`.
26
+
27
+ ## 0.1.1
28
+
29
+ - **Fixed: the guided setup ended at the suggestions step's address question.** A question asked right after another
30
+ one (with nothing in between that waits) had its input paused when the earlier question's reader closed, and the
31
+ command ended at the prompt. Each question now waits for the one before it to have closed
32
+ (`packages/runtime/bin/lib/ui.mjs` `ask`). Found on the first real run of 0.1.0.
33
+ - The README no longer says the package is not on npm.
34
+
3
35
  ## 0.1.0
4
36
 
5
37
  The first version: one command for everything GenClass sets up.
package/README.md CHANGED
@@ -6,40 +6,89 @@ One command that sets GenClass up and tells you what your app needs next.
6
6
  npx genclass
7
7
  ```
8
8
 
9
- Run it in your web app's folder. It shows where the project stands and walks you through the next step. Stop at any
10
- point and run it again: it continues from what is true now.
9
+ Run it in your web app's folder. It shows where the project stands and walks you through the next step: one Enter
10
+ per step. Stop at any point and run it again: it continues from what is true now.
11
11
 
12
12
  ```text
13
+ ██████╗ ███████╗███╗ ██╗ ██████╗██╗ █████╗ ███████╗███████╗
14
+ ██╔════╝ ██╔════╝████╗ ██║██╔════╝██║ ██╔══██╗██╔════╝██╔════╝
15
+ ██║ ███╗█████╗ ██╔██╗ ██║██║ ██║ ███████║███████╗███████╗
16
+ ██║ ██║██╔══╝ ██║╚██╗██║██║ ██║ ██╔══██║╚════██║╚════██║
17
+ ╚██████╔╝███████╗██║ ╚████║╚██████╗███████╗██║ ██║███████║███████║
18
+ ╚═════╝ ╚══════╝╚═╝ ╚═══╝ ╚═════╝╚══════╝╚═╝ ╚═╝╚══════╝╚══════╝
19
+
20
+ Finds what breaks in your web app, and tells you what it needs next. v0.2.0
21
+
13
22
  GenClass • shop Vite + React
14
23
  ada@example.com • Free plan
15
24
  ────────────────────────────────────────────────────────────────────────────
16
- ✔ Signed in ada@example.com · Free plan
17
- ✔ GenClass is in this app added · app "shop"
18
- ◌ First page seen deploy, then open your site once
19
- ● Pull requests checked Playwright found · no workflow file yet
20
- ○ Coding agent connected
21
- ○ Suggestions
22
-
23
- Next Check every pull request
24
- On each pull request GenClass runs your Playwright tests once more with slow and
25
- reordered responses, and comments when a page ends up wrong, with the steps to see it.
25
+ ✔ Done Account • Runtime
26
+ ● Next Add the test workflow
27
+ ◌ Waiting Dashboard: deploy, then open your site once
28
+ ○ Later GitHub App • Coding agent • Suggestions
29
+
30
+ Next Add the test workflow
31
+ One new file, .github/workflows/genclass.yml. Your tests are not changed.
32
+
33
+ Enter to continue, d for every part, s to skip, q to stop
26
34
  ```
27
35
 
28
- > **Status:** `genclass` is not on npm yet. From a checkout of this repository:
29
- > `npm run build -w genclass && node packages/cli/bin/genclass.mjs` in your app's folder.
36
+ The view stays that short. Press `d` (or run `genclass status --all`) to see every part with what is known about
37
+ it, and `d` again to fold it back.
30
38
 
31
- ## The six steps
39
+ ## Every part, in order
32
40
 
33
- | Step | What it does | What it changes |
41
+ | Part | What the step does | What it changes |
34
42
  |---|---|---|
35
- | Signed in | Opens genclass.dev in your browser; you approve a short code there. | A session file in your user config folder. Nothing is typed in the terminal. |
36
- | GenClass is in this app | Adds the runtime: one import (or script tag) and the package. It watches the page in your users' browsers for lost edits, double submits and old data shown over new, and only reports. | Your entry file and `package.json`, after you have seen the diff and said yes. `genclass remove` undoes it. |
37
- | First page seen | Waits for your live site to be opened once. GenClass sends nothing from localhost. | Nothing. |
38
- | Pull requests checked | Runs your Playwright tests once more per pull request with slow and reordered responses, and comments when a page ends up wrong. | One new file, `.github/workflows/genclass.yml`, which you commit. You install the GenClass GitHub App in your browser; it cannot read or change your code. |
39
- | Coding agent connected | Lets Claude Code, Cursor and other agents ask GenClass what went wrong and check their fix. | `.mcp.json` (or `.cursor/mcp.json`), after you have seen the change. |
43
+ | Account | Opens genclass.dev in your browser; you approve a short code there. | A session file in your user config folder. Nothing is typed in the terminal. |
44
+ | Runtime | Adds GenClass to the app: one import (or script tag) and the package. It watches the page in your users' browsers for lost edits, double submits and old data shown over new, and only reports. | Your entry file and `package.json`; you see the change first. `genclass remove` undoes it. |
45
+ | Dashboard | Waits for your live site to be opened once. GenClass sends nothing from localhost. | Nothing. |
46
+ | Test workflow | Runs your Playwright tests once more per pull request with slow and reordered responses. | One new file, `.github/workflows/genclass.yml`, which you commit. |
47
+ | GitHub App | Comments on a pull request when a page ends up wrong, with the steps to see it. The command opens GitHub's install page and waits for the answer. | Nothing in your project. The app cannot read or change your code. |
48
+ | Coding agent | Gives Claude Code, Cursor and other agents GenClass's tools: ask what went wrong, replay it, check the fix. | `.mcp.json` (or `.cursor/mcp.json`). |
40
49
  | Suggestions | Tells you what your app is missing, most important first. | Nothing in your project. |
41
50
 
42
- A step that does not apply is left out and says why: no Playwright tests, not a GitHub repository, not a web app.
51
+ On a terminal, Enter starts a step and is the yes for what its sentence says it writes. A part that does not apply
52
+ is left out and says why: no Playwright tests, not a GitHub repository, not a web app.
53
+
54
+ ## Your app in the terminal
55
+
56
+ ```bash
57
+ npx genclass dashboard
58
+ ```
59
+
60
+ What GenClass found on your live site, in one screen: problems by kind and page, measured visual checks, what was
61
+ handled, visitors, what your coding agent did with the findings, what the GitHub App is doing, and what the last
62
+ suggestions run left to do.
63
+
64
+ ```text
65
+ GenClass • shop Vite + React
66
+ ada@example.com • Team plan
67
+ ────────────────────────────────────────────────────────────────────────────
68
+ last 7 days · last page 3 hours ago
69
+
70
+ Visits watched 1,204 Problems found 17 ▁▃▂▇▅▁█
71
+ Handled 3 Visual checks 9
72
+
73
+ Problems
74
+ 12 duplicate /checkout the same request went out twice
75
+ 4 stale /orders/:id old data replaced newer data
76
+ 1 failing /cart a request keeps failing
77
+
78
+ Visual checks
79
+ 6 text-overflow /pricing
80
+ 3 image-broken /
81
+
82
+ Visitors 312 visits · 1,020 page views · 41% left after one page
83
+ Coding agent 5 found · 3 reproduced · 2 fixed · 1 with a test
84
+ GitHub App reviewing · 4 pull requests so far
85
+ Suggestions 7 to do, 2 urgent · checked 2 days ago · genclass suggest
86
+ ```
87
+
88
+ `--range 24h`, `7d` or `30d` picks the period, `--all` shows every row, `--app <name>` another app of your account,
89
+ `--open` the browser dashboard, `--json` the same as data. These are the numbers your dashboard on genclass.dev
90
+ shows, cut by the same plan rules. The sign-in page says the command can show them; a sign-in from before 0.2.0
91
+ was approved without that, so the command asks you to sign in once more.
43
92
 
44
93
  ## Suggestions
45
94
 
@@ -76,9 +125,9 @@ prompt) is shown for the first three items on Free and for all of them on Team,
76
125
  |---|---|
77
126
  | `genclass` | where the project stands; on a terminal, the next step |
78
127
  | `genclass setup` | the guided setup (`--yes`: no questions) |
79
- | `genclass status` | the checklist (`--json`) |
128
+ | `genclass status` | what is done and what is next (`--all`: every part; `--json`) |
80
129
  | `genclass suggest [url]` | what your app is missing (`--json`, `--yes`, `--no-model`, `--all`) |
81
- | `genclass dashboard` | this app's dashboard (`--open`) |
130
+ | `genclass dashboard` | your app in the terminal (`--range`, `--all`, `--app`, `--open`, `--json`) |
82
131
  | `genclass scan <url>` | 23 visual checks on one page |
83
132
  | `genclass login`, `logout`, `whoami` | your account |
84
133
  | `genclass remove` | take GenClass out of the app again |
@@ -93,6 +142,7 @@ Options everywhere: `--cwd <dir>`, `--yes`, `--json`, `--no-browser`.
93
142
  npx genclass status --json # where things stand, and "next": the command to run or what only a person can do
94
143
  npx genclass setup --yes # does every step that needs no person; prints the links for the ones that do
95
144
  npx genclass suggest --json # the checks that failed, with evidence, in order
145
+ npx genclass dashboard --json # what GenClass found on the live site
96
146
  ```
97
147
 
98
148
  Two steps need the person: approving the sign-in and installing the GitHub App. Both happen in their browser, and