Skip to content

Commit 7173955

Browse files
committed
help text updated to have new parameters
1 parent e105777 commit 7173955

File tree

3 files changed

+31
-18
lines changed

3 files changed

+31
-18
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -129,13 +129,13 @@ _The default WPT server can also be specified via environment variable `WEBPAGET
129129
* **-bh, --browserheight** _\<pixels\>_: Browser window height (in display pixels)
130130
* **-vh, --viewportheight** _\<pixels\>_: Viewport Height in css pixels
131131
* **-vw, --viewportwidth** _\<pixels\>_: Viewport Width in css pixels
132-
* **-dpr, --dpr** _\<ratio\>_: Device To Pixel Ratio
132+
* **-dpr, --devicetopixelratio** _\<ratio\>_: Device To Pixel Ratio
133133
* **-au, --appendua** _\<string\>_: String to append to the user agent string. This is in addition to the default PTST/ver string
134-
* **-tt, --testtype** _\<type\>_: For running alternative test types, can specify traceroute or lighthouse
134+
* **-tt, --testtype** _\<string\>_: For running alternative test types, can specify traceroute or lighthouse
135135
* **-pr, --profiler** _\<number\>_: Set to 1 to enable the V8 sampling profiler (Chromium only)
136136
* **-avif, --disableAVIF** _\<number\>_: Set to 1 to disable AVIF support (Chromium 88+)
137-
* **-webp, --disableWEBP** _\<number\>_: Set to 1 to disable AVIF support (Chromium 88+)
138-
* **-jxl, --disableJXL** _\<number\>_: Set to 1 to disable AVIF support (Chromium 88+)
137+
* **-webp, --disableWEBP** _\<number\>_: Set to 1 to disable WEBP support (Chromium 88+)
138+
* **-jxl, --disableJXL** _\<number\>_: Set to 1 to disable JXL support (Chromium 88+)
139139
* **-dts, --dtShaper** _\<number\>_: Set to 1 to use Chrome's built-in traffic-shaping instead of the packet-level netem shaping usually used by the test agents
140140
* **-Y, --latency** _\<time\>_: first-hop Round Trip Time in ms (used when specifying a custom connectivity profile)
141141
* **-P, --plr** _\<percentage\>_: packet loss rate - percent of packets to drop (used when specifying a custom connectivity profile)
@@ -497,7 +497,7 @@ wpt.runTest(script, (err, data) => {
497497
* **browserheight**: _String_, Browser window height (in display pixels)
498498
* **viewportheight**: _String_, Viewport Height in css pixels
499499
* **viewportwidth**: _String_, Viewport Width in css pixels
500-
* **dpr**: _String_, Device To Pixel Ratio
500+
* **devicetopixelratio**: _String_, Device To Pixel Ratio
501501
* **appendua**: _String_, String to append to the user agent string. This is in addition to the default PTST/ver string
502502
* **testtype**: _String_, For running alternative test types, can specify traceroute or lighthouse
503503
* **profiler**: _Number_, Set to 1 to enable the V8 sampling profiler (Chromium only)

lib/mapping.js

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -332,84 +332,85 @@ var options = {
332332
name: 'browserwidth',
333333
key: 'bw',
334334
api: 'browser_width',
335-
param: 'browserwidth',
335+
param: 'pixels',
336336
info: 'Browser window width (in display pixels)'
337337
},
338338
'browserheight': {
339339
name: 'browserheight',
340340
key: 'bh',
341341
api: 'browser_height',
342-
param: 'browserheight',
342+
param: 'pixels',
343343
info: 'Browser window height (in display pixels)'
344344
},
345345
'viewportheight': {
346346
name: 'viewportheight',
347347
key: 'vh',
348348
api: 'height',
349-
param: 'viewportheight',
349+
param: 'pixels',
350350
info: 'Viewport Height in css pixels'
351351
},
352352
'viewportwidth': {
353353
name: 'viewportwidth',
354354
key: 'vw',
355355
api: 'width',
356-
param: 'viewportwidth',
356+
param: 'pixels',
357357
info: 'Viewport Width in css pixels'
358358
},
359-
'dpr' : {
360-
name : 'dpr',
359+
'devicetopixelratio' : {
360+
name : 'devicetopixelratio',
361361
key : 'dpr',
362362
api : 'dpr',
363-
param : 'dpr',
363+
param : 'ratio',
364364
info : 'Device To Pixel Ratio'
365365

366366
},
367367
'appendua' : {
368368
name : 'appendua',
369369
key : 'au',
370370
api : 'appendua',
371+
param : 'string',
371372
info : 'String to append to the user agent string. This is in addition to the default PTST/ver string.'
372373
},
373374
'testtype' : {
374375
name : 'testtype',
375376
key : 'tt',
376377
api : 'type',
377-
param : 'testtype',
378+
param : 'string',
378379
info : 'For running alternative test types, can specify traceroute or lighthouse'
379380
},
380381
'profiler' : {
381382
name : 'profiler',
382383
key : 'pr',
383384
api : 'profiler',
384-
param : 'profiler',
385+
param : 'number',
385386
info : 'Set to 1 to enable the V8 sampling profiler (Chromium only)'
386387
},
387388
'disableAVIF' : {
388389
name : 'disableAVIF',
389390
key : 'avif',
390391
api : 'disableAVIF',
391-
param : 'disableAVIF',
392+
param : 'number',
392393
info : 'Set to 1 to disable AVIF support (Chromium 88+).'
393394
},
394395
'disableWEBP' : {
395396
name : 'disableWEBP',
396397
key : 'webp',
397398
api : 'disableWEBP',
398-
param : 'disableWEBP',
399+
param : 'number',
399400
info : 'Set to 1 to disable WEBP support (Chromium 88+).'
400401
},
401402
'disableJXL' : {
402403
name : 'disableJXL',
403404
key : 'jxl',
404405
api : 'disableJXL',
405-
param : 'disableJXL',
406+
param : 'number',
406407
info : 'Set to 1 to disable JpegXL support (Chromium 88+).'
407408
},
408409
'dtShaper' : {
409410
name : 'dtShaper',
410411
key : 'dts',
411412
api : 'dtShaper',
412-
param : 'dtShaper',
413+
param : 'number',
413414
info : "Set to 1 to use Chrome's built-in traffic-shaping instead of the packet-level netem shaping usually used by the test agents"
414415
},
415416
'latency': {

test/fixtures/command-line/help-test.txt

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,18 @@ Options:
8686
specifying a custom connectivity profile)
8787
-U, --bwup <bandwidth> upload bandwidth in Kbps (used when
8888
specifying a custom connectivity profile)
89+
-bw, --browserwidth <pixels> Browser window width (in display pixels)
90+
-bh, --browserheight <pixels> Browser window height (in display pixels)
91+
-vh, --viewportheight <pixels> Viewport Height in css pixels
92+
-vw, --viewportwidth <pixels> Viewport Width in css pixels
93+
-dpr, --devicetopixelratio <dpr> Device To Pixel Ratio
94+
-au, --appendua <string> String to append to the user agent string. This is in addition to the default PTST/ver string
95+
-tt, --testtype <string> For running alternative test types, can specify traceroute or lighthouse
96+
-pr, --profiler <number> Set to 1 to enable the V8 sampling profiler (Chromium only)
97+
-avif, --disableAVIF <number> Set to 1 to disable AVIF support (Chromium 88+)
98+
-webp, --disableWEBP <number> Set to 1 to disable WEBP support (Chromium 88+)
99+
-jxl, --disableJXL <number> Set to 1 to disable JXL support (Chromium 88+)
100+
-dts, --dtShaper <number> Set to 1 to use Chrome's built-in traffic-shaping instead of the packet-level netem shaping usually used by the test agents
89101
-Y, --latency <time> first-hop Round Trip Time in ms (used
90102
when specifying a custom connectivity
91103
profile)

0 commit comments

Comments
 (0)