genclass 0.0.0-stage → 0.1.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 +20 -0
- package/LICENSE +202 -0
- package/README.md +112 -2
- package/bin/genclass.mjs +8 -0
- package/dist/genclass.mjs +7096 -0
- package/package.json +49 -4
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
## 0.1.0
|
|
4
|
+
|
|
5
|
+
The first version: one command for everything GenClass sets up.
|
|
6
|
+
|
|
7
|
+
- **`genclass`** shows where a project stands in six steps (signed in, GenClass in the app, first page seen, pull
|
|
8
|
+
requests checked, coding agent connected, suggestions) and, on a terminal, walks the next one. Each step is read
|
|
9
|
+
from what is on disk and what genclass.dev answers, so a run continues where the last one stopped.
|
|
10
|
+
- **`genclass setup --yes`** and **`genclass status --json`** are the same walk for a coding agent: nothing is asked,
|
|
11
|
+
and what only a person can do (approve the sign-in, install the GitHub App) is printed with its link.
|
|
12
|
+
- **`genclass suggest [url]`** measures the repository and the live site against a catalog of checks (launch, search,
|
|
13
|
+
AI assistants, payments, safety, quality, email) and prints what failed, most important first, each with its
|
|
14
|
+
evidence, what to do and a prompt for a coding agent. Signed in, genclass.dev orders the list for the app and
|
|
15
|
+
words the reasons; it is sent the failed checks and five things about the app, never code, and the command shows
|
|
16
|
+
that before the first send.
|
|
17
|
+
- `login`, `logout`, `whoami`, `connect`, `dashboard`, `init`, `remove` and `scan` are the commands of
|
|
18
|
+
`@genclass/runtime`'s own CLI, unchanged.
|
|
19
|
+
- One file with no dependencies. It installs `@genclass/runtime` and `@genclass/mcp` at the versions it was built
|
|
20
|
+
with.
|
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/README.md
CHANGED
|
@@ -1,3 +1,113 @@
|
|
|
1
|
-
#
|
|
1
|
+
# genclass
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
One command that sets GenClass up and tells you what your app needs next.
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
npx genclass
|
|
7
|
+
```
|
|
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.
|
|
11
|
+
|
|
12
|
+
```text
|
|
13
|
+
GenClass • shop Vite + React
|
|
14
|
+
ada@example.com • Free plan
|
|
15
|
+
────────────────────────────────────────────────────────────────────────────
|
|
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.
|
|
26
|
+
```
|
|
27
|
+
|
|
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.
|
|
30
|
+
|
|
31
|
+
## The six steps
|
|
32
|
+
|
|
33
|
+
| Step | What it does | What it changes |
|
|
34
|
+
|---|---|---|
|
|
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. |
|
|
40
|
+
| Suggestions | Tells you what your app is missing, most important first. | Nothing in your project. |
|
|
41
|
+
|
|
42
|
+
A step that does not apply is left out and says why: no Playwright tests, not a GitHub repository, not a web app.
|
|
43
|
+
|
|
44
|
+
## Suggestions
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
npx genclass suggest https://your-site.com
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
It measures your repository and your live site against a list of checks, in plain words:
|
|
51
|
+
|
|
52
|
+
- **Launch:** HTTPS, one address for www and the bare domain, a real page title, a 404 for missing pages, somewhere
|
|
53
|
+
to try a change before users get it.
|
|
54
|
+
- **Search:** a description, a link preview image, robots.txt, a sitemap.
|
|
55
|
+
- **AI assistants:** whether ChatGPT, Claude and Perplexity may read the site, and whether the page has any text
|
|
56
|
+
before JavaScript runs.
|
|
57
|
+
- **Payments:** test keys on the live site, a secret key in browser code, a price people can see.
|
|
58
|
+
- **Safety:** a `.env` file in git, keys in tracked files.
|
|
59
|
+
- **Quality:** tests, a workflow that runs them, something that reports errors from real users.
|
|
60
|
+
- **Email:** SPF and DMARC, so your mail does not land in spam.
|
|
61
|
+
|
|
62
|
+
Each failed check comes with the evidence that was measured, what to do, and a prompt you can paste to your coding
|
|
63
|
+
agent. When you are signed in, genclass.dev orders the list for your app and words the reasons for it.
|
|
64
|
+
|
|
65
|
+
**What leaves your machine.** Requests to your own site, and, to get the plan, the checks that failed with their
|
|
66
|
+
evidence lines, plus your app's name, framework, address, payment provider and host. No source code, no file
|
|
67
|
+
contents, no secrets. The command shows this before the first time it sends it for a project; `--no-model` sends
|
|
68
|
+
nothing. genclass.dev passes it to the model that writes the plan and stores none of it.
|
|
69
|
+
|
|
70
|
+
**What is free.** Every check, with its evidence. The plan (why it matters for your app, the first step, the agent
|
|
71
|
+
prompt) is shown for the first three items on Free and for all of them on Team, with more plans a day.
|
|
72
|
+
|
|
73
|
+
## Commands
|
|
74
|
+
|
|
75
|
+
| | |
|
|
76
|
+
|---|---|
|
|
77
|
+
| `genclass` | where the project stands; on a terminal, the next step |
|
|
78
|
+
| `genclass setup` | the guided setup (`--yes`: no questions) |
|
|
79
|
+
| `genclass status` | the checklist (`--json`) |
|
|
80
|
+
| `genclass suggest [url]` | what your app is missing (`--json`, `--yes`, `--no-model`, `--all`) |
|
|
81
|
+
| `genclass dashboard` | this app's dashboard (`--open`) |
|
|
82
|
+
| `genclass scan <url>` | 23 visual checks on one page |
|
|
83
|
+
| `genclass login`, `logout`, `whoami` | your account |
|
|
84
|
+
| `genclass remove` | take GenClass out of the app again |
|
|
85
|
+
|
|
86
|
+
Options everywhere: `--cwd <dir>`, `--yes`, `--json`, `--no-browser`.
|
|
87
|
+
|
|
88
|
+
## For coding agents
|
|
89
|
+
|
|
90
|
+
`genclass` asks nothing when it is not run on a terminal, so an agent can drive it:
|
|
91
|
+
|
|
92
|
+
```bash
|
|
93
|
+
npx genclass status --json # where things stand, and "next": the command to run or what only a person can do
|
|
94
|
+
npx genclass setup --yes # does every step that needs no person; prints the links for the ones that do
|
|
95
|
+
npx genclass suggest --json # the checks that failed, with evidence, in order
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
Two steps need the person: approving the sign-in and installing the GitHub App. Both happen in their browser, and
|
|
99
|
+
the command prints the link. At the sign-in, `setup --yes` prints a link and a code and waits up to ten minutes for
|
|
100
|
+
the person to approve, so give it a long timeout, or have them run `npx genclass login` first.
|
|
101
|
+
|
|
102
|
+
## How it is built
|
|
103
|
+
|
|
104
|
+
One file with no dependencies, so `npx genclass` starts at once. It reuses the sign-in, project detection and
|
|
105
|
+
install code of `@genclass/runtime`'s own CLI ([`packages/runtime/bin`](../runtime/bin)) and installs the runtime
|
|
106
|
+
and MCP server versions it was built with. Sources: [`src/`](src). The server side is
|
|
107
|
+
[`telemetry-worker/src/cli.ts`](../../telemetry-worker/src/cli.ts) and
|
|
108
|
+
[`suggest.ts`](../../telemetry-worker/src/suggest.ts). Privacy: [PRIVACY.md](../../PRIVACY.md).
|
|
109
|
+
|
|
110
|
+
```bash
|
|
111
|
+
npm run build -w genclass # dist/genclass.mjs
|
|
112
|
+
(cd packages/cli && npx vitest run)
|
|
113
|
+
```
|
package/bin/genclass.mjs
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
// The `genclass` command. The published package runs its bundle (dist/genclass.mjs, built by build.mjs: one file, no
|
|
3
|
+
// dependencies); a checkout without a build runs the sources.
|
|
4
|
+
import { existsSync } from "node:fs";
|
|
5
|
+
import { fileURLToPath } from "node:url";
|
|
6
|
+
|
|
7
|
+
const built = fileURLToPath(new URL("../dist/genclass.mjs", import.meta.url));
|
|
8
|
+
await import(existsSync(built) ? "../dist/genclass.mjs" : "../src/main.mjs");
|