Skip to content

Commit

Permalink
update few command sentences
Browse files Browse the repository at this point in the history
  • Loading branch information
Santoshkumar Sharanappa Nateekar authored and Santoshkumar Sharanappa Nateekar committed Sep 19, 2024
1 parent a86fe94 commit 7640a63
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 7 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ To view examples of how to use Nala commands with various options, you can run
npm run nala help
```

### ⚠️ Important Note
#### ⚠️ Important Note
- **Debug and UI Mode Caution**: When using `debug` or `ui` mode, it is recommended to run only a single test using annotations (e.g., `@test1`). Running multiple tests in these modes (e.g., `npm run nala local mode=debug` or `mode=ui`) will launch a separate browser or debugger window for each test, which can quickly become resource-intensive and challenging to manage.

- **Tip**: To effectively watch or debug, focus on one test at a time to avoid opening excessive browser instances or debugger windows.
Expand Down
11 changes: 5 additions & 6 deletions nala/utils/nala.run.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,12 @@ function displayHelp() {
\x1b[1m2] Options:\x1b[0m
\x1b[33m* browser=<chrome|firefox|webkit>\x1b[0m Browser to use (default: chrome)
\x1b[33m* device=<desktop|mobile>\x1b[0m Device (default: desktop)
\x1b[33m* test=<.test.js>\x1b[0m Test file to run (default: all tests)
\x1b[33m* tag=<@tag>\x1b[0m Tags to filter tests by annotations ex: @test1 @accordion @marquee
\x1b[33m* -g, --g=<@tag>\x1b[0m Tags to filter tests by annotations ex: @test1 @accordion @marquee
\x1b[33m* browser=<chrome|firefox|webkit>\x1b[0m Browser to run the test in
\x1b[33m* device=<desktop|mobile>\x1b[0m Device type to run the test on
\x1b[33m* test=<.test.js>\x1b[0m Specific test file to run (runs all tests in the file)
\x1b[33m* -g, --g=<@tag>\x1b[0m Annotation Tag to filter and run tests by annotation (e.g., @test1, @accordion, @marquee)
\x1b[33m* mode=<headless|ui|debug|headed>\x1b[0m Mode (default: headless)
\x1b[33m* config=<config-file>\x1b[0m Configuration file (default: Playwright default)
\x1b[33m* config=<config-file>\x1b[0m Custom configuration file to use (default: Playwright's default)
\x1b[33m* project=<project-name>\x1b[0m Project configuration (default: milo-live-chromium)
\x1b[33m* milolibs=<local|prod|code|feature>\x1b[0m Milo library environment (default: none)
Expand Down

0 comments on commit 7640a63

Please sign in to comment.