laxy-verify 1.1.1 → 1.1.3

package/README.md

@@ -5,9 +5,221 @@ Frontend quality gate for AI-generated code. Build + Lighthouse verification wit
 ```bash
 npx laxy-verify --init    # Auto-detect framework, generate config
 npx laxy-verify .         # Run verification
+npx laxy-verify login     # Log in for Pro/Pro+ features
 npx laxy-verify --badge   # Show shields.io badge
 ```
 
+## Quick Start
+
+### 1. Initialize
+
+```bash
+cd your-project
+npx laxy-verify --init
+```
+
+This generates `.laxy.yml` and `.github/workflows/laxy-verify.yml` automatically by detecting your framework and package manager.
+
+### 2. Run Locally
+
+```bash
+npx laxy-verify .
+```
+
+### 3. Add to CI
+
+Push the generated workflow file. Every PR gets a quality gate with grade comment and status check.
+
+## Grades
+
+| Grade | Requirement |
+|-------|------------|
+| **Gold** | Build passes + all Lighthouse thresholds pass + all viewports pass (Pro+ only) |
+| **Silver** | Build passes + Lighthouse exceeds all thresholds |
+| **Bronze** | Build passes (Lighthouse not run or below threshold) |
+| **Unverified** | Build failed |
+
+`fail_on` controls the minimum acceptable grade. Default: `bronze`.
+
+> **Gold grade** is only achievable with a Pro+ account. It requires multi-viewport Lighthouse (desktop/tablet/mobile) to all pass in addition to the standard thresholds.
+
+## Pro / Pro+ Features
+
+Log in to unlock paid plan features:
+
+```bash
+npx laxy-verify login        # Log in with your laxy-blue.vercel.app account
+npx laxy-verify whoami       # Check current login status
+npx laxy-verify logout       # Remove saved credentials
+```
+
+| Feature | Free | Pro | Pro+ |
+|---------|------|-----|------|
+| Build verification | ✅ | ✅ | ✅ |
+| Lighthouse (1 run) | ✅ | ✅ | ✅ |
+| Silver grade | ✅ | ✅ | ✅ |
+| Bronze grade | ✅ | ✅ | ✅ |
+| Lighthouse (3 runs, averaged) | ❌ | ✅ | ✅ |
+| Gold grade eligibility | ❌ | ✅ | ✅ |
+| Verbose failure output | ❌ | ✅ | ✅ |
+| Multi-viewport Lighthouse (desktop/tablet/mobile) | ❌ | ❌ | ✅ |
+| Failure analysis report | ❌ | ❌ | ✅ |
+| Fast Lane (priority queue) | ❌ | ❌ | ✅ |
+
+### Login
+
+```bash
+npx laxy-verify login
+# Enter your email and password for laxy-blue.vercel.app
+```
+
+Credentials are stored in `~/.laxy/credentials.json` (chmod 600). Token expires after 30 days.
+
+For CI environments, set the `LAXY_TOKEN` environment variable instead of logging in interactively:
+
+```yaml
+env:
+  LAXY_TOKEN: ${{ secrets.LAXY_TOKEN }}
+```
+
+### Multi-viewport (Pro+)
+
+```bash
+npx laxy-verify --multi-viewport .
+```
+
+Runs Lighthouse on three viewports: desktop, tablet (1024×768), and mobile. Gold grade requires all three to pass the configured thresholds.
+
+## Configuration
+
+All fields optional in `.laxy.yml`:
+
+```yaml
+framework: "auto"           # auto | nextjs | vite | cra | sveltekit
+build_command: ""           # default: auto-detected from package.json
+dev_command: ""             # default: auto-detected
+package_manager: "auto"     # auto | npm | pnpm | yarn | bun
+port: 3000                  # dev server port
+build_timeout: 300          # seconds (default 5m)
+dev_timeout: 60             # seconds for dev server start (90 in CI mode)
+lighthouse_runs: 1          # @lhci/cli runs (CI mode auto-sets to 3)
+
+thresholds:
+  performance: 70           # CI mode applies -10 offset (effective: 60)
+  accessibility: 85
+  seo: 80
+  best_practices: 80
+
+fail_on: "bronze"           # unverified | bronze | silver | gold
+                            # unverified = never fail (informational only)
+```
+
+**fail_on vs build failure:** Build failure always produces grade `Unverified` and exit code 1, regardless of `fail_on`. `fail_on: unverified` means informational only (always exit 0).
+
+**--ci flag:** Lowers Performance threshold by 10, sets `lighthouse_runs=3` (when not explicitly set), and increases `dev_timeout` to 90s. Auto-set when `CI=true` env var exists.
+
+## CLI Options
+
+```
+npx laxy-verify [project-dir]   Default: current directory
+
+Options:
+  --format   console | json       Output format (default: console)
+  --ci                            CI mode: -10 Performance, runs=3
+  --config   <path>               Path to .laxy.yml
+  --fail-on  unverified|bronze|silver|gold  Override fail_on
+  --skip-lighthouse               Build-only verification (max Bronze)
+  --badge                         Show shields.io badge (reads .laxy-result.json)
+  --init                          Generate .laxy.yml + GitHub workflow
+  --multi-viewport                Pro+: run Lighthouse on desktop/tablet/mobile
+
+Subcommands:
+  login [email]                   Log in to unlock Pro/Pro+ features
+  logout                          Remove saved credentials
+  whoami                          Show current login status
+```
+
+## exit codes
+
+| Code | Meaning |
+|------|--------|
+| 0 | Grade meets or exceeds `fail_on` threshold |
+| 1 | Grade worse than `fail_on`, or build failed |
+| 2 | Configuration error (no package.json, invalid YAML, etc.) |
+
+## GitHub Action
+
+```yaml
+- uses: psungmin24/laxy-verify@v1
+  with:
+    github-token: ${{ secrets.GITHUB_TOKEN }}
+    fail-on: silver    # optional, default: bronze
+    config: .laxy.yml  # optional
+```
+
+Posts a PR comment with grade and Lighthouse scores, and sets a commit status check.
+
+For Pro/Pro+ features in CI, add `LAXY_TOKEN` to your repository secrets:
+
+```yaml
+- uses: psungmin24/laxy-verify@v1
+  with:
+    github-token: ${{ secrets.GITHUB_TOKEN }}
+    fail-on: gold      # Gold requires Pro+ account
+  env:
+    LAXY_TOKEN: ${{ secrets.LAXY_TOKEN }}
+```
+
+## Limitations (v1)
+
+- **Monorepos:** Not supported. Run `npx laxy-verify apps/web` for the app subdirectory.
+- **Lighthouse accuracy:** Scores are measured in dev mode (`npm run dev`). Production scores are typically higher.
+- **Fork PRs:** Comments and status checks are not posted on PRs from forks (GitHub security restriction).
+- **Yarn Berry:** May require manual `package_manager` configuration if using Corepack.
+- **Gold grade:** Requires Pro+ plan and `--multi-viewport` flag. All three viewports must pass Lighthouse thresholds.
+
+## Expected CI Timing
+
+- Build: 15-30s
+- Dev server start: 5-20s
+- Lighthouse (1 run): ~15s
+- Lighthouse (3 runs CI): ~45s
+- Multi-viewport (Pro+, 3 viewports): ~60s
+- **Total: 35-95s per PR**
+
+## .laxy-result.json
+
+Written after every run:
+
+```json
+{
+  "grade": "Silver",
+  "timestamp": "2026-04-07T10:30:00Z",
+  "build": { "success": true, "durationMs": 12300, "errors": [] },
+  "lighthouse": { "performance": 87, "accessibility": 92, "seo": 88, "bestPractices": 90, "runs": 1 },
+  "thresholds": { "performance": 70, "accessibility": 85, "seo": 80, "bestPractices": 80 },
+  "ciMode": false,
+  "framework": "nextjs",
+  "exitCode": 0,
+  "config_fail_on": "bronze"
+}
+```
+
+Use `npx laxy-verify --badge` to output a shields.io badge markdown from this file.
+
+## Badge
+
+```bash
+npx laxy-verify --badge
+```
+
+Output: `![Laxy Verify: Silver](https://img.shields.io/badge/laxy_verify-silver-brightgreen)`
+
+## License
+
+MIT
+
+
 ## Quick Start
 
 ### 1. Initialize

package/dist/auth.js

@@ -121,48 +121,28 @@ function whoami() {
         console.log("  인증 정보를 읽을 수 없습니다.");
     }
 }
-/** readline으로 비밀번호 입력 (터미널 에코 숨김) */
-function promptPassword(prompt) {
-    return new Promise((resolve) => {
-        const rl = readline.createInterface({
-            input: process.stdin,
-            output: process.stdout,
-            terminal: true,
-        });
+async function login(emailArg) {
+    // 단일 readline 인터페이스로 이메일+비밀번호 수집
+    // (복수 rl 인스턴스 생성 시 Windows UV_HANDLE_CLOSING Assertion 발생)
+    const rl = readline.createInterface({
+        input: process.stdin,
+        output: process.stdout,
+        terminal: false,
+    });
+    const ask = (prompt) => new Promise((resolve) => rl.question(prompt, (ans) => resolve(ans.trim())));
+    const askMuted = (prompt) => new Promise((resolve) => {
         process.stdout.write(prompt);
-        // 에코 끄기 (Unix 계열만, Windows는 readline이 처리)
-        if (process.stdin.isTTY) {
-            // @ts-ignore — private API
-            process.stdin._handle?.setRawMode?.(true);
-        }
-        let password = "";
-        process.stdin.on("data", (chunk) => {
-            const char = chunk.toString("utf-8");
-            if (char === "\n" || char === "\r" || char === "\u0004") {
-                process.stdout.write("\n");
-                rl.close();
-                resolve(password);
-            }
-            else if (char === "\u0008" || char === "\u007f") {
-                password = password.slice(0, -1);
-            }
-            else {
-                password += char;
-            }
+        rl.once("line", (line) => {
+            process.stdout.write("\n");
+            resolve(line.trim());
         });
     });
-}
-async function login(emailArg) {
-    const rl = readline.createInterface({ input: process.stdin, output: process.stdout });
-    const askEmail = () => {
-        if (emailArg) {
-            rl.close();
-            return Promise.resolve(emailArg);
-        }
-        return new Promise((res) => rl.question("  이메일: ", (ans) => { rl.close(); res(ans.trim()); }));
-    };
-    const email = await askEmail();
-    const password = await promptPassword("  비밀번호: ");
+    const email = emailArg?.trim() ?? (await ask("  이메일: "));
+    const password = await askMuted("  비밀번호: ");
+    // 입력 완료 후 stdin 핸들 즉시 해제 (Windows Assertion 방지)
+    rl.removeAllListeners();
+    rl.close();
+    process.stdin.destroy();
     console.log("\n  로그인 중...");
     let res;
     try {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "laxy-verify",
-  "version": "1.1.1",
+  "version": "1.1.3",
   "description": "Frontend quality gate: build + Lighthouse verification",
   "type": "commonjs",
   "bin": {