Skip to content

Commit d7d4e1d

Browse files
committed
refactor(): reword jsdoc for headless flag
1 parent ef548e4 commit d7d4e1d

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

src/cli/config-flags.ts

+6-2
Original file line numberDiff line numberDiff line change
@@ -176,8 +176,12 @@ export const STRING_NUMBER_CLI_FLAGS = ['maxWorkers'] as const;
176176
*/
177177
export const BOOLEAN_STRING_CLI_FLAGS = [
178178
/**
179-
* `headless` is an argument that prior to Chrome v112, only accepted boolean values. Starting with Chrome v112,
180-
* Stencil will accept a value of 'new' to support the new headless mode.
179+
* `headless` is an argument passed through to Puppeteer (which is passed to Chrome) for end-to-end testing.
180+
* Prior to Chrome v112, `headless` was treated like a boolean flag. Starting with Chrome v112, 'new' is an accepted
181+
* option to support Chrome's new headless mode. In order to support this option in Stencil, both the boolean and
182+
* string versions of the flag must be accepted.
183+
*
184+
* {@see https://developer.chrome.com/articles/new-headless/}
181185
*/
182186
'headless',
183187
] as const;

0 commit comments

Comments
 (0)