Skip to content

Commit dc352ca

Browse files
committed
chore: update documentation
1 parent 0975570 commit dc352ca

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -339,13 +339,33 @@ Run all or specific integration tests (NUTs) via:
339339
# Run all integration tests
340340
yarn test:nuts
341341

342+
# Run component local preview test (local development only)
343+
yarn test:nut:local
344+
342345
# Run by category
343346
yarn test:nuts "test/commands/lightning/dev/component*.nut.ts"
344347

345348
# Run with environment variables
346349
OPEN_BROWSER=false NODE_ENV=production yarn test:nuts
347350
```
348351

352+
### Local-Only Tests
353+
354+
Some NUT tests are designed to run only in local development environments and are automatically skipped in CI pipelines. These tests typically:
355+
356+
- Require specific local setup or resources
357+
- Are too slow for CI environments
358+
- Need manual verification or debugging
359+
- Test features that aren't suitable for automated testing
360+
361+
**Component Local Preview Test**
362+
The `componentLocalPreview.nut.ts` test verifies that the Lightning Dev Server starts correctly and responds to component URLs. This test:
363+
364+
- Runs only locally (skipped when `CI=true`)
365+
- Tests server startup and HTTP response
366+
- Verifies component URL routing (`/c-hello-world/`)
367+
- Can be run with: `yarn test:nut:local`
368+
349369
### Test Data Structure
350370

351371
The testkit creates SFDX projects and test data at runtime:

0 commit comments

Comments
 (0)