@jupyterlab/galata 4.4.0 → 4.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +16 -14
  2. package/package.json +9 -9
package/README.md CHANGED
@@ -220,20 +220,20 @@ Here are the new test fixture introduced by Galata on top of [Playwright fixture
220
220
 
221
221
  ### baseURL
222
222
 
223
- - type: < string >
223
+ - type: \< string >
224
224
 
225
225
  Application base URL without `/lab`. It defaults to environment variable `TARGET_URL` or `http://localhost:8888` if nothing
226
226
  is defined.
227
227
 
228
228
  ### appPath
229
229
 
230
- - type: < string >
230
+ - type: \< string >
231
231
 
232
232
  Application URL path fragment; default `"/lab"`
233
233
 
234
234
  ### autoGoto
235
235
 
236
- - type: < boolean >
236
+ - type: \< boolean >
237
237
 
238
238
  Whether to go to JupyterLab page within the fixture or not; default `true`.
239
239
 
@@ -264,7 +264,7 @@ test('Open language menu', async ({ page }) => {
264
264
 
265
265
  ### serverFiles
266
266
 
267
- - type: <'on' | 'off' | 'only-on-failure'>
267
+ - type: \<'on' | 'off' | 'only-on-failure'>
268
268
 
269
269
  Galata can keep the uploaded and created files in `tmpPath` on
270
270
  the server root for debugging purpose. By default the files are kept
@@ -276,14 +276,14 @@ on failure.
276
276
 
277
277
  ### mockState
278
278
 
279
- - type: < boolean | Record<string, unknown> >
279
+ - type: \< boolean | Record\<string, unknown> >
280
280
 
281
281
  Mock JupyterLab state in-memory or not.
282
282
  Possible values are:
283
283
 
284
284
  - true (default): JupyterLab state will be mocked on a per test basis
285
285
  - false: JupyterLab state won't be mocked (Be careful it will write state in local files)
286
- - Record<string, unknown>: Initial JupyterLab data state - Mapping (state key, value).
286
+ - Record\<string, unknown>: Initial JupyterLab data state - Mapping (state key, value).
287
287
  By default the state is stored in-memory.
288
288
 
289
289
  Example:
@@ -337,14 +337,16 @@ test('should return the mocked state', async ({ page }) => {
337
337
 
338
338
  ### mockSettings
339
339
 
340
- - type: < boolean | Record<string, unknown> >
340
+ - type: \< boolean | Record\<string, unknown> >
341
341
 
342
342
  Mock JupyterLab settings in-memory or not.
343
343
  Possible values are:
344
344
 
345
345
  - true: JupyterLab settings will be mocked on a per test basis
346
+
346
347
  - false: JupyterLab settings won't be mocked (Be careful it will read & write settings local files)
347
- - Record<string, unknown>: Mapping {pluginId: settings} that will be default user settings
348
+
349
+ - Record\<string, unknown>: Mapping {pluginId: settings} that will be default user settings
348
350
 
349
351
  The default value is `galata.DEFAULT_SETTINGS`
350
352
 
@@ -370,13 +372,13 @@ test('should return mocked settings', async ({ page }) => {
370
372
 
371
373
  ### sessions
372
374
 
373
- - type: <Map<string, Session.IModel> | null>
375
+ - type: \<Map\<string, Session.IModel> | null>
374
376
 
375
377
  Sessions created during the test.
376
378
  Possible values are:
377
379
 
378
380
  - null: The sessions API won't be mocked
379
- - Map<string, Session.IModel>: The sessions created during a test.
381
+ - Map\<string, Session.IModel>: The sessions created during a test.
380
382
  By default the sessions created during a test will be tracked and disposed at the end.
381
383
 
382
384
  Example:
@@ -400,13 +402,13 @@ test('should return the active sessions', async ({ page, sessions }) => {
400
402
 
401
403
  ### terminals
402
404
 
403
- - type: < Map<string, TerminalAPI.IModel> | null >
405
+ - type: \< Map\<string, TerminalAPI.IModel> | null >
404
406
 
405
407
  Terminals created during the test.
406
408
  Possible values are:
407
409
 
408
410
  - null: The Terminals API won't be mocked
409
- - Map<string, TerminalsAPI.IModel>: The Terminals created during a test.
411
+ - Map\<string, TerminalsAPI.IModel>: The Terminals created during a test.
410
412
  By default the Terminals created during a test will be tracked and disposed at the end.
411
413
 
412
414
  Example:
@@ -437,7 +439,7 @@ test('should return the active terminals', async ({ page, terminals }) => {
437
439
 
438
440
  ### tmpPath
439
441
 
440
- - type: < string >
442
+ - type: \< string >
441
443
 
442
444
  Unique test temporary path created on the server.
443
445
 
@@ -477,7 +479,7 @@ Benchmark of JupyterLab is done using Playwright. The actions measured are:
477
479
  Two files are tested: a notebook with many code cells and another with many markdown cells.
478
480
 
479
481
  The test is run on the CI by comparing the result in the commit at which a PR branch started and the PR branch head on
480
- the same CI job to ensure using the same hardware.
482
+ the same CI job to ensure using the same hardware.\
481
483
  The benchmark job is triggered on:
482
484
 
483
485
  - Approved PR review
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jupyterlab/galata",
3
- "version": "4.4.0",
3
+ "version": "4.4.1",
4
4
  "description": "JupyterLab UI Testing Framework",
5
5
  "homepage": "https://github.com/jupyterlab/jupyterlab",
6
6
  "bugs": {
@@ -47,14 +47,14 @@
47
47
  "test:update": "playwright test --update-snapshots && jlpm test:benchmark:update"
48
48
  },
49
49
  "dependencies": {
50
- "@jupyterlab/application": "^3.5.0",
51
- "@jupyterlab/cells": "^3.5.0",
52
- "@jupyterlab/coreutils": "^5.5.0",
53
- "@jupyterlab/docmanager": "^3.5.0",
54
- "@jupyterlab/nbformat": "^3.5.0",
55
- "@jupyterlab/notebook": "^3.5.0",
56
- "@jupyterlab/services": "^6.5.0",
57
- "@jupyterlab/settingregistry": "^3.5.0",
50
+ "@jupyterlab/application": "^3.5.1",
51
+ "@jupyterlab/cells": "^3.5.1",
52
+ "@jupyterlab/coreutils": "^5.5.1",
53
+ "@jupyterlab/docmanager": "^3.5.1",
54
+ "@jupyterlab/nbformat": "^3.5.1",
55
+ "@jupyterlab/notebook": "^3.5.1",
56
+ "@jupyterlab/services": "^6.5.1",
57
+ "@jupyterlab/settingregistry": "^3.5.1",
58
58
  "@lumino/algorithm": "^1.9.0",
59
59
  "@lumino/coreutils": "^1.11.0",
60
60
  "@playwright/test": "^1.16.2",