feat: support TESTSPRITE_PROJECT_ID default

[naufalfx805-source]

Refs #76

Discord: npall_805

Summary:

• add TESTSPRITE_PROJECT_ID fallback for test list, test create, and test run --all
• keep explicit --project precedence and preserve existing VALIDATION_ERROR behavior when neither is set
• document the env var and add regression coverage for list/create/run-all paths

Validation:

• npm test -- src/commands/test.test.ts src/commands/test.run.spec.ts
• npm run typecheck
• npm run lint
• npm run build
• npx prettier --check src/commands/test.ts src/commands/test.test.ts src/commands/test.run.spec.ts DOCUMENTATION.md
• git diff --check

Summary by CodeRabbit

• New Features

  • CLI now defaults to TESTSPRITE_PROJECT_ID for test list, test create, and test run --all when --project is omitted.
  • Improved dashboard/deep-link generation to use the resolved project automatically.

• Bug Fixes

  • Project resolution is consistent across list filters, create payloads, and batch run “fresh” flows.
  • Validation errors for missing/blank project now clearly reference TESTSPRITE_PROJECT_ID.

• Documentation

  • Updated DOCUMENTATION.md to include TESTSPRITE_PROJECT_ID as the default project and refined table formatting.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: b9aebf48-0350-4618-a26d-b09e789d4063

📥 Commits

Reviewing files that changed from the base of the PR and between ac98599 and c70e2ad.

📒 Files selected for processing (3)

• src/commands/test.run.spec.ts
• src/commands/test.test.ts
• src/commands/test.ts

🚧 Files skipped from review as they are similar to previous changes (2)

• src/commands/test.test.ts
• src/commands/test.ts

---

Walkthrough

This PR adds TESTSPRITE_PROJECT_ID as a fallback source for projectId in test list, test create, and test run --all, updates validation to mention that variable, and adds tests plus documentation for the new behavior.

Changes

TESTSPRITE_PROJECT_ID default project support

Layer / File(s)	Summary
resolveProjectId helper and requireProjectId assertion src/commands/test.ts	Adds resolveProjectId(projectId, deps) to fall back to TESTSPRITE_PROJECT_ID and converts requireProjectId into an assertion function.
test list projectId resolution src/commands/test.ts, src/commands/test.test.ts	Makes projectId optional for test list, resolves and validates it, uses it in /tests queries, and adds coverage for env fallback and validation messaging.
test create projectId resolution src/commands/test.ts, src/commands/test.test.ts	Makes projectId optional for test create, resolves and validates it, uses it in request payloads and links, and adds coverage for env fallback.
test run --all projectId resolution src/commands/test.ts, src/commands/test.run.spec.ts	Makes projectId optional for test run --all, resolves and validates it, uses it across batch-run requests and URLs, and adds coverage for env fallback and validation messaging.
Tests and documentation DOCUMENTATION.md	Documents TESTSPRITE_PROJECT_ID in the environment variables table.

Estimated code review effort: 2 (Simple) | ~15 minutes

Sequence Diagram(s)

sequenceDiagram
  participant CLI
  participant Command
  participant resolveProjectId
  participant API

  CLI->>Command: invoke without --project
  Command->>resolveProjectId: resolveProjectId(projectId, deps)
  resolveProjectId-->>Command: TESTSPRITE_PROJECT_ID fallback
  Command->>Command: requireProjectId(projectId)
  Command->>API: request using resolved projectId

Loading

Possibly related issues

• [Hackathon] TESTSPRITE_PROJECT_ID env default for --project #76: Matches the same TESTSPRITE_PROJECT_ID fallback behavior for --project, with corresponding docs and tests.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly describes the main change: adding TESTSPRITE_PROJECT_ID as a default project source.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

_{Comment @coderabbitai help to get the list of available commands.}

[coderabbitai]

🧹 Nitpick comments (3)

src/commands/test.ts (3)

7785-7789: 🎯 Functional Correctness | 🔵 Trivial | ⚡ Quick win

Error message doesn't mention the new TESTSPRITE_PROJECT_ID fallback.

requireProjectId's message ("is required") is used by test list and test create when neither --project nor TESTSPRITE_PROJECT_ID is set, but it gives no hint about the env var. Compare with the bespoke check for test run --all (Line 7475) which explicitly says pass --project <id> or set TESTSPRITE_PROJECT_ID. Since all three commands now support the same fallback, the generic message should mention it too for a consistent, actionable error across commands.

♻️ Suggested consistent message

 function requireProjectId(projectId: string | undefined): asserts projectId is string {
   if (typeof projectId !== 'string' || projectId.length === 0) {
-    throw localValidationError('project', 'is required');
+    throw localValidationError('project', 'is required; pass --project <id> or set TESTSPRITE_PROJECT_ID');
   }
 }

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@src/commands/test.ts` around lines 7785 - 7789, Update requireProjectId in
test.ts so its validation error mentions the TESTSPRITE_PROJECT_ID fallback
instead of only saying “is required,” matching the messaging used by testRunAll
and the shared behavior of test list, test create, and test run. Adjust the
localValidationError text to instruct users to pass --project <id> or set
TESTSPRITE_PROJECT_ID, and keep the check centralized in requireProjectId so all
callers get the same actionable message.

---

7779-7784: 🎯 Functional Correctness | 🔵 Trivial | 💤 Low value

resolveProjectId correctly implements env-var fallback with trimming.

One edge case to note: an explicitly passed empty string (--project "") is treated as "set" (since the check is !== undefined), bypassing the TESTSPRITE_PROJECT_ID fallback entirely and failing with "is required" instead of falling back to the env var. Also, the env var value is trimmed but an explicit --project value is not — a minor asymmetry.

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@src/commands/test.ts` around lines 7779 - 7784, The `resolveProjectId` helper
treats an explicitly passed empty string as a real value, which prevents the
`TESTSPRITE_PROJECT_ID` fallback and can lead to a missing-project error. Update
`resolveProjectId` to treat blank CLI input the same as unset by trimming the
`projectId` argument before deciding whether to return it or fall back to
`deps.env`/`process.env`, keeping behavior consistent with the env-var handling.

---

7469-7477: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win

Duplicate validation logic vs. requireProjectId.

This manual if (!projectId) throw localValidationError(...) duplicates the same condition requireProjectId already encodes (and runTestRunAll re-checks it again internally via resolveProjectId/requireProjectId on the now-resolved value). Consider having requireProjectId accept an optional custom message/hint so both call sites share one implementation instead of maintaining two divergent error strings for the same validation rule.

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@src/commands/test.ts` around lines 7469 - 7477, The `isAll` branch in
`runTestRunAll` duplicates the same project-id validation already handled by
`requireProjectId`, so consolidate the check into a single implementation.
Update `requireProjectId` to accept an optional custom error message or hint,
then use it from the `--all` path instead of the manual `if (!projectId) throw
localValidationError(...)` block. Keep the existing `resolveProjectId`,
`requireProjectId`, and `runTestRunAll` flow consistent so both call sites share
the same validation rule and error wording.

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@src/commands/test.ts`:
- Around line 7785-7789: Update requireProjectId in test.ts so its validation
error mentions the TESTSPRITE_PROJECT_ID fallback instead of only saying “is
required,” matching the messaging used by testRunAll and the shared behavior of
test list, test create, and test run. Adjust the localValidationError text to
instruct users to pass --project <id> or set TESTSPRITE_PROJECT_ID, and keep the
check centralized in requireProjectId so all callers get the same actionable
message.
- Around line 7779-7784: The `resolveProjectId` helper treats an explicitly
passed empty string as a real value, which prevents the `TESTSPRITE_PROJECT_ID`
fallback and can lead to a missing-project error. Update `resolveProjectId` to
treat blank CLI input the same as unset by trimming the `projectId` argument
before deciding whether to return it or fall back to `deps.env`/`process.env`,
keeping behavior consistent with the env-var handling.
- Around line 7469-7477: The `isAll` branch in `runTestRunAll` duplicates the
same project-id validation already handled by `requireProjectId`, so consolidate
the check into a single implementation. Update `requireProjectId` to accept an
optional custom error message or hint, then use it from the `--all` path instead
of the manual `if (!projectId) throw localValidationError(...)` block. Keep the
existing `resolveProjectId`, `requireProjectId`, and `runTestRunAll` flow
consistent so both call sites share the same validation rule and error wording.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: bd688675-74da-4adc-a5f1-e51a303832b1

📥 Commits

Reviewing files that changed from the base of the PR and between e53257d and ac98599.

📒 Files selected for processing (4)

• DOCUMENTATION.md
• src/commands/test.run.spec.ts
• src/commands/test.test.ts
• src/commands/test.ts

[zeshi-du]

Approved — TESTSPRITE_PROJECT_ID with flag-over-env precedence, the resolved id threaded through dashboard URLs, and the improved error text are exactly what issue #76 asked for. It went CONFLICTING under today's merge wave (#96/#33 landed in test.ts first). Rebase onto main and it merges — no other changes requested. (Heads-up: #179 will layer the config-file project_id below your env fallback once this lands, so getting this in first sets the precedence chain.)

[jangjos-128]

Hi @naufalfx805-source — so sorry for the disruption here. 🙏 While we were publishing a new CLI release, a hiccup in our process unintentionally closed this PR. To be clear: your contribution wasn't rejected, and nothing on your end caused this.

Your work is completely safe — your branch and every commit are intact and untouched, and main is already back to normal on our side.

Because of how the closure happened, the cleanest path is a fresh PR from your existing branch (rather than reopening this one) — and opening it yourself keeps it under your name, with full credit for your work:

👉 Open a new PR from your branch

It should merge cleanly. So your work doesn't get lost, if we don't hear back in the next ~3 days we'll go ahead and open it for you — but opening it yourself keeps it under your name, and either way we're always happy to hand it back to you.

Thank you for contributing to TestSprite, and again, we're sorry for the hassle. We really appreciate this work and want to see it merged. 🙌