playwright 1.50.0 → 1.50.1

package/lib/common/config.js

@@ -161,8 +161,7 @@ class FullProjectInternal {
     this.teardown = void 0;
     this.fullConfig = fullConfig;
     const testDir = takeFirst(pathResolve(configDir, projectConfig.testDir), pathResolve(configDir, config.testDir), fullConfig.configDir);
-    const defaultSnapshotPathTemplate = '{snapshotDir}/{testFileDir}/{testFileName}-snapshots/{arg}{-projectName}{-snapshotSuffix}{ext}';
-    this.snapshotPathTemplate = takeFirst(projectConfig.snapshotPathTemplate, config.snapshotPathTemplate, defaultSnapshotPathTemplate);
+    this.snapshotPathTemplate = takeFirst(projectConfig.snapshotPathTemplate, config.snapshotPathTemplate);
     this.project = {
       grep: takeFirst(projectConfig.grep, config.grep, defaultGrep),
       grepInvert: takeFirst(projectConfig.grepInvert, config.grepInvert, null),

package/lib/common/configLoader.js

@@ -206,7 +206,7 @@ function validateConfig(file, config) {
     if (!('current' in config.shard) || typeof config.shard.current !== 'number' || config.shard.current < 1 || config.shard.current > config.shard.total) throw (0, _util.errorWithFile)(file, `config.shard.current must be a positive number, not greater than config.shard.total`);
   }
   if ('updateSnapshots' in config && config.updateSnapshots !== undefined) {
-    if (typeof config.updateSnapshots !== 'string' || !['all', 'none', 'missing'].includes(config.updateSnapshots)) throw (0, _util.errorWithFile)(file, `config.updateSnapshots must be one of "all", "none" or "missing"`);
+    if (typeof config.updateSnapshots !== 'string' || !['all', 'changed', 'missing', 'none'].includes(config.updateSnapshots)) throw (0, _util.errorWithFile)(file, `config.updateSnapshots must be one of "all", "changed", "missing" or "none"`);
   }
   if ('workers' in config && config.workers !== undefined) {
     if (typeof config.workers === 'number' && config.workers <= 0) throw (0, _util.errorWithFile)(file, `config.workers must be a positive number`);else if (typeof config.workers === 'string' && !config.workers.endsWith('%')) throw (0, _util.errorWithFile)(file, `config.workers must be a number or percentage`);

package/lib/matchers/expect.js

@@ -250,6 +250,8 @@ class ExpectMetaInfoProxyHandler {
         const jestError = (0, _matcherHint.isJestError)(e) ? e : null;
         const error = jestError ? new _matcherHint.ExpectError(jestError, customMessage, stackFrames) : e;
         if (jestError !== null && jestError !== void 0 && jestError.matcherResult.suggestedRebaseline) {
+          // NOTE: this is a workaround for the fact that we can't pass the suggested rebaseline
+          // for passing matchers. See toMatchAriaSnapshot for a counterpart.
           step.complete({
             suggestedRebaseline: jestError === null || jestError === void 0 ? void 0 : jestError.matcherResult.suggestedRebaseline
           });

package/lib/matchers/toMatchAriaSnapshot.js

@@ -30,7 +30,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  */
 
 async function toMatchAriaSnapshot(receiver, expectedParam, options = {}) {
-  var _options$timeout;
+  var _testInfo$_projectInt;
   const matcherName = 'toMatchAriaSnapshot';
   const testInfo = (0, _globals.currentTestInfo)();
   if (!testInfo) throw new Error(`toMatchAriaSnapshot() must be called during the test`);
@@ -41,17 +41,23 @@ async function toMatchAriaSnapshot(receiver, expectedParam, options = {}) {
     expected: ''
   };
   const updateSnapshots = testInfo.config.updateSnapshots;
+  const pathTemplate = (_testInfo$_projectInt = testInfo._projectInternal.expect) === null || _testInfo$_projectInt === void 0 || (_testInfo$_projectInt = _testInfo$_projectInt.toMatchAriaSnapshot) === null || _testInfo$_projectInt === void 0 ? void 0 : _testInfo$_projectInt.pathTemplate;
+  const defaultTemplate = '{snapshotDir}/{testFileDir}/{testFileName}-snapshots/{arg}{ext}';
   const matcherOptions = {
     isNot: this.isNot,
     promise: this.promise
   };
   let expected;
+  let timeout;
   let expectedPath;
   if ((0, _utils.isString)(expectedParam)) {
+    var _options$timeout;
     expected = expectedParam;
+    timeout = (_options$timeout = options.timeout) !== null && _options$timeout !== void 0 ? _options$timeout : this.timeout;
   } else {
+    var _expectedParam$timeou;
     if (expectedParam !== null && expectedParam !== void 0 && expectedParam.name) {
-      expectedPath = testInfo.snapshotPath((0, _util.sanitizeFilePathBeforeExtension)(expectedParam.name));
+      expectedPath = testInfo._resolveSnapshotPath(pathTemplate, defaultTemplate, [(0, _util.sanitizeFilePathBeforeExtension)(expectedParam.name)]);
     } else {
       let snapshotNames = testInfo[snapshotNamesSymbol];
       if (!snapshotNames) {
@@ -61,9 +67,10 @@ async function toMatchAriaSnapshot(receiver, expectedParam, options = {}) {
         testInfo[snapshotNamesSymbol] = snapshotNames;
       }
       const fullTitleWithoutSpec = [...testInfo.titlePath.slice(1), ++snapshotNames.anonymousSnapshotIndex].join(' ');
-      expectedPath = testInfo.snapshotPath((0, _utils.sanitizeForFilePath)((0, _util.trimLongString)(fullTitleWithoutSpec)) + '.yml');
+      expectedPath = testInfo._resolveSnapshotPath(pathTemplate, defaultTemplate, [(0, _utils.sanitizeForFilePath)((0, _util.trimLongString)(fullTitleWithoutSpec)) + '.yml']);
     }
     expected = await _fs.default.promises.readFile(expectedPath, 'utf8').catch(() => '');
+    timeout = (_expectedParam$timeou = expectedParam === null || expectedParam === void 0 ? void 0 : expectedParam.timeout) !== null && _expectedParam$timeou !== void 0 ? _expectedParam$timeou : this.timeout;
   }
   const generateMissingBaseline = updateSnapshots === 'missing' && !expected;
   if (generateMissingBaseline) {
@@ -79,7 +86,6 @@ async function toMatchAriaSnapshot(receiver, expectedParam, options = {}) {
       expected = `- none "Generating new baseline"`;
     }
   }
-  const timeout = (_options$timeout = options.timeout) !== null && _options$timeout !== void 0 ? _options$timeout : this.timeout;
   expected = unshift(expected);
   const {
     matches: pass,
@@ -138,6 +144,14 @@ async function toMatchAriaSnapshot(receiver, expectedParam, options = {}) {
         };
       } else {
         const suggestedRebaseline = `\`\n${(0, _utils.escapeTemplateString)(indent(typedReceived.regex, '{indent}  '))}\n{indent}\``;
+        if (updateSnapshots === 'missing') {
+          const message = 'A snapshot is not provided, generating new baseline.';
+          testInfo._hasNonRetriableError = true;
+          testInfo._failWithError(new Error(message));
+        }
+        // TODO: ideally, we should return "pass: true" here because this matcher passes
+        // when regenerating baselines. However, we can only access suggestedRebaseline in case
+        // of an error, so we fail here and workaround it in the expect implementation.
         return {
           pass: false,
           message: () => '',

package/lib/matchers/toMatchSnapshot.js

@@ -102,7 +102,8 @@ class SnapshotHelper {
       outputBasePath = testInfo._getOutputPath(sanitizedName);
       this.attachmentBaseName = sanitizedName;
     }
-    this.expectedPath = testInfo.snapshotPath(...expectedPathSegments);
+    const defaultTemplate = '{snapshotDir}/{testFileDir}/{testFileName}-snapshots/{arg}{-projectName}{-snapshotSuffix}{ext}';
+    this.expectedPath = testInfo._resolveSnapshotPath(configOptions.pathTemplate, defaultTemplate, expectedPathSegments);
     this.legacyExpectedPath = (0, _util.addSuffixToFilePath)(outputBasePath, '-expected');
     this.previousPath = (0, _util.addSuffixToFilePath)(outputBasePath, '-previous');
     this.actualPath = (0, _util.addSuffixToFilePath)(outputBasePath, '-actual');

package/lib/program.js

@@ -269,7 +269,7 @@ async function mergeReports(reportDir, opts) {
 function overridesFromOptions(options) {
   const shardPair = options.shard ? options.shard.split('/').map(t => parseInt(t, 10)) : undefined;
   let updateSnapshots;
-  if (['all', 'changed', 'missing', 'none'].includes(options.updateSnapshots)) updateSnapshots = options.updateSnapshots;else updateSnapshots = 'updateSnapshots' in options ? 'changed' : 'missing';
+  if (['all', 'changed', 'missing', 'none'].includes(options.updateSnapshots)) updateSnapshots = options.updateSnapshots;else updateSnapshots = 'updateSnapshots' in options ? 'changed' : undefined;
   const overrides = {
     forbidOnly: options.forbidOnly ? true : undefined,
     fullyParallel: options.fullyParallel ? true : undefined,

package/lib/runner/rebase.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.addSuggestedRebaseline = addSuggestedRebaseline;
 exports.applySuggestedRebaselines = applySuggestedRebaselines;
+exports.clearSuggestedRebaselines = clearSuggestedRebaselines;
 var _path = _interopRequireDefault(require("path"));
 var _fs = _interopRequireDefault(require("fs"));
 var _babelBundle = require("../transform/babelBundle");
@@ -36,6 +37,9 @@ function addSuggestedRebaseline(location, suggestedRebaseline) {
     code: suggestedRebaseline
   });
 }
+function clearSuggestedRebaselines() {
+  suggestedRebaselines.clear();
+}
 async function applySuggestedRebaselines(config, reporter) {
   if (config.config.updateSnapshots === 'none') return;
   if (!suggestedRebaselines.size) return;

package/lib/runner/tasks.js

@@ -267,6 +267,9 @@ function createLoadTask(mode, options) {
 function createApplyRebaselinesTask() {
   return {
     title: 'apply rebaselines',
+    setup: async () => {
+      (0, _rebase.clearSuggestedRebaselines)();
+    },
     teardown: async ({
       config,
       reporter

package/lib/worker/testInfo.js

@@ -383,15 +383,20 @@ class TestInfoImpl {
     const fullTitleWithoutSpec = this.titlePath.slice(1).join(' ');
     return (0, _utils.sanitizeForFilePath)((0, _util.trimLongString)(fullTitleWithoutSpec));
   }
-  snapshotPath(...pathSegments) {
+  _resolveSnapshotPath(template, defaultTemplate, pathSegments) {
     const subPath = _path.default.join(...pathSegments);
     const parsedSubPath = _path.default.parse(subPath);
     const relativeTestFilePath = _path.default.relative(this.project.testDir, this._requireFile);
     const parsedRelativeTestFilePath = _path.default.parse(relativeTestFilePath);
     const projectNamePathSegment = (0, _utils.sanitizeForFilePath)(this.project.name);
-    const snapshotPath = (this._projectInternal.snapshotPathTemplate || '').replace(/\{(.)?testDir\}/g, '$1' + this.project.testDir).replace(/\{(.)?snapshotDir\}/g, '$1' + this.project.snapshotDir).replace(/\{(.)?snapshotSuffix\}/g, this.snapshotSuffix ? '$1' + this.snapshotSuffix : '').replace(/\{(.)?testFileDir\}/g, '$1' + parsedRelativeTestFilePath.dir).replace(/\{(.)?platform\}/g, '$1' + process.platform).replace(/\{(.)?projectName\}/g, projectNamePathSegment ? '$1' + projectNamePathSegment : '').replace(/\{(.)?testName\}/g, '$1' + this._fsSanitizedTestName()).replace(/\{(.)?testFileName\}/g, '$1' + parsedRelativeTestFilePath.base).replace(/\{(.)?testFilePath\}/g, '$1' + relativeTestFilePath).replace(/\{(.)?arg\}/g, '$1' + _path.default.join(parsedSubPath.dir, parsedSubPath.name)).replace(/\{(.)?ext\}/g, parsedSubPath.ext ? '$1' + parsedSubPath.ext : '');
+    const actualTemplate = template || this._projectInternal.snapshotPathTemplate || defaultTemplate;
+    const snapshotPath = actualTemplate.replace(/\{(.)?testDir\}/g, '$1' + this.project.testDir).replace(/\{(.)?snapshotDir\}/g, '$1' + this.project.snapshotDir).replace(/\{(.)?snapshotSuffix\}/g, this.snapshotSuffix ? '$1' + this.snapshotSuffix : '').replace(/\{(.)?testFileDir\}/g, '$1' + parsedRelativeTestFilePath.dir).replace(/\{(.)?platform\}/g, '$1' + process.platform).replace(/\{(.)?projectName\}/g, projectNamePathSegment ? '$1' + projectNamePathSegment : '').replace(/\{(.)?testName\}/g, '$1' + this._fsSanitizedTestName()).replace(/\{(.)?testFileName\}/g, '$1' + parsedRelativeTestFilePath.base).replace(/\{(.)?testFilePath\}/g, '$1' + relativeTestFilePath).replace(/\{(.)?arg\}/g, '$1' + _path.default.join(parsedSubPath.dir, parsedSubPath.name)).replace(/\{(.)?ext\}/g, parsedSubPath.ext ? '$1' + parsedSubPath.ext : '');
     return _path.default.normalize(_path.default.resolve(this._configInternal.configDir, snapshotPath));
   }
+  snapshotPath(...pathSegments) {
+    const legacyTemplate = '{snapshotDir}/{testFileDir}/{testFileName}-snapshots/{arg}{-projectName}{-snapshotSuffix}{ext}';
+    return this._resolveSnapshotPath(undefined, legacyTemplate, pathSegments);
+  }
   skip(...args) {
     this._modifier('skip', args);
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "playwright",
-  "version": "1.50.0",
+  "version": "1.50.1",
   "description": "A high-level API to automate web browsers",
   "repository": {
     "type": "git",
@@ -56,7 +56,7 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "playwright-core": "1.50.0"
+    "playwright-core": "1.50.1"
   },
   "optionalDependencies": {
     "fsevents": "2.3.2"

package/types/test.d.ts

@@ -214,6 +214,27 @@ interface TestProject<TestArgs = {}, WorkerArgs = {}> {
        * [page.screenshot([options])](https://playwright.dev/docs/api/class-page#page-screenshot).
        */
       stylePath?: string|Array<string>;
+
+      /**
+       * A template controlling location of the screenshots. See
+       * [testProject.snapshotPathTemplate](https://playwright.dev/docs/api/class-testproject#test-project-snapshot-path-template)
+       * for details.
+       */
+      pathTemplate?: string;
+    };
+
+    /**
+     * Configuration for the
+     * [expect(locator).toMatchAriaSnapshot([options])](https://playwright.dev/docs/api/class-locatorassertions#locator-assertions-to-match-aria-snapshot-2)
+     * method.
+     */
+    toMatchAriaSnapshot?: {
+      /**
+       * A template controlling location of the aria snapshots. See
+       * [testProject.snapshotPathTemplate](https://playwright.dev/docs/api/class-testproject#test-project-snapshot-path-template)
+       * for details.
+       */
+      pathTemplate?: string;
     };
 
     /**
@@ -404,10 +425,14 @@ interface TestProject<TestArgs = {}, WorkerArgs = {}> {
 
   /**
    * This option configures a template controlling location of snapshots generated by
-   * [expect(page).toHaveScreenshot(name[, options])](https://playwright.dev/docs/api/class-pageassertions#page-assertions-to-have-screenshot-1)
+   * [expect(page).toHaveScreenshot(name[, options])](https://playwright.dev/docs/api/class-pageassertions#page-assertions-to-have-screenshot-1),
+   * [expect(locator).toMatchAriaSnapshot([options])](https://playwright.dev/docs/api/class-locatorassertions#locator-assertions-to-match-aria-snapshot-2)
    * and
    * [expect(value).toMatchSnapshot(name[, options])](https://playwright.dev/docs/api/class-snapshotassertions#snapshot-assertions-to-match-snapshot-1).
    *
+   * You can configure templates for each assertion separately in
+   * [testConfig.expect](https://playwright.dev/docs/api/class-testconfig#test-config-expect).
+   *
    * **Usage**
    *
    * ```js
@@ -416,7 +441,19 @@ interface TestProject<TestArgs = {}, WorkerArgs = {}> {
    *
    * export default defineConfig({
    *   testDir: './tests',
+   *
+   *   // Single template for all assertions
    *   snapshotPathTemplate: '{testDir}/__screenshots__/{testFilePath}/{arg}{ext}',
+   *
+   *   // Assertion-specific templates
+   *   expect: {
+   *     toHaveScreenshot: {
+   *       pathTemplate: '{testDir}/__screenshots__{/projectName}/{testFilePath}/{arg}{ext}',
+   *     },
+   *     toMatchAriaSnapshot: {
+   *       pathTemplate: '{testDir}/__snapshots__/{testFilePath}/{arg}{ext}',
+   *     },
+   *   },
    * });
    * ```
    *
@@ -447,27 +484,27 @@ interface TestProject<TestArgs = {}, WorkerArgs = {}> {
    * ```
    *
    * The list of supported tokens:
-   * - `{arg}` - Relative snapshot path **without extension**. These come from the arguments passed to the
-   *   `toHaveScreenshot()` and `toMatchSnapshot()` calls; if called without arguments, this will be an auto-generated
-   *   snapshot name.
+   * - `{arg}` - Relative snapshot path **without extension**. This comes from the arguments passed to
+   *   `toHaveScreenshot()`, `toMatchAriaSnapshot()` or `toMatchSnapshot()`; if called without arguments, this will be
+   *   an auto-generated snapshot name.
    *   - Value: `foo/bar/baz`
-   * - `{ext}` - snapshot extension (with dots)
+   * - `{ext}` - Snapshot extension (with the leading dot).
    *   - Value: `.png`
    * - `{platform}` - The value of `process.platform`.
    * - `{projectName}` - Project's file-system-sanitized name, if any.
    *   - Value: `''` (empty string).
    * - `{snapshotDir}` - Project's
-   *   [testConfig.snapshotDir](https://playwright.dev/docs/api/class-testconfig#test-config-snapshot-dir).
+   *   [testProject.snapshotDir](https://playwright.dev/docs/api/class-testproject#test-project-snapshot-dir).
    *   - Value: `/home/playwright/tests` (since `snapshotDir` is not provided in config, it defaults to `testDir`)
    * - `{testDir}` - Project's
-   *   [testConfig.testDir](https://playwright.dev/docs/api/class-testconfig#test-config-test-dir).
-   *   - Value: `/home/playwright/tests` (absolute path is since `testDir` is resolved relative to directory with
+   *   [testProject.testDir](https://playwright.dev/docs/api/class-testproject#test-project-test-dir).
+   *   - Value: `/home/playwright/tests` (absolute path since `testDir` is resolved relative to directory with
    *     config)
    * - `{testFileDir}` - Directories in relative path from `testDir` to **test file**.
    *   - Value: `page`
    * - `{testFileName}` - Test file name with extension.
    *   - Value: `page-click.spec.ts`
-   * - `{testFilePath}` - Relative path from `testDir` to **test file**
+   * - `{testFilePath}` - Relative path from `testDir` to **test file**.
    *   - Value: `page/page-click.spec.ts`
    * - `{testName}` - File-system-sanitized test title, including parent describes but excluding file name.
    *   - Value: `suite-test-should-work`
@@ -991,6 +1028,27 @@ interface TestConfig<TestArgs = {}, WorkerArgs = {}> {
        * [YIQ color space](https://en.wikipedia.org/wiki/YIQ) and defaults `threshold` value to `0.2`.
        */
       threshold?: number;
+
+      /**
+       * A template controlling location of the screenshots. See
+       * [testConfig.snapshotPathTemplate](https://playwright.dev/docs/api/class-testconfig#test-config-snapshot-path-template)
+       * for details.
+       */
+      pathTemplate?: string;
+    };
+
+    /**
+     * Configuration for the
+     * [expect(locator).toMatchAriaSnapshot([options])](https://playwright.dev/docs/api/class-locatorassertions#locator-assertions-to-match-aria-snapshot-2)
+     * method.
+     */
+    toMatchAriaSnapshot?: {
+      /**
+       * A template controlling location of the aria snapshots. See
+       * [testConfig.snapshotPathTemplate](https://playwright.dev/docs/api/class-testconfig#test-config-snapshot-path-template)
+       * for details.
+       */
+      pathTemplate?: string;
     };
 
     /**
@@ -1468,10 +1526,14 @@ interface TestConfig<TestArgs = {}, WorkerArgs = {}> {
 
   /**
    * This option configures a template controlling location of snapshots generated by
-   * [expect(page).toHaveScreenshot(name[, options])](https://playwright.dev/docs/api/class-pageassertions#page-assertions-to-have-screenshot-1)
+   * [expect(page).toHaveScreenshot(name[, options])](https://playwright.dev/docs/api/class-pageassertions#page-assertions-to-have-screenshot-1),
+   * [expect(locator).toMatchAriaSnapshot([options])](https://playwright.dev/docs/api/class-locatorassertions#locator-assertions-to-match-aria-snapshot-2)
    * and
    * [expect(value).toMatchSnapshot(name[, options])](https://playwright.dev/docs/api/class-snapshotassertions#snapshot-assertions-to-match-snapshot-1).
    *
+   * You can configure templates for each assertion separately in
+   * [testConfig.expect](https://playwright.dev/docs/api/class-testconfig#test-config-expect).
+   *
    * **Usage**
    *
    * ```js
@@ -1480,7 +1542,19 @@ interface TestConfig<TestArgs = {}, WorkerArgs = {}> {
    *
    * export default defineConfig({
    *   testDir: './tests',
+   *
+   *   // Single template for all assertions
    *   snapshotPathTemplate: '{testDir}/__screenshots__/{testFilePath}/{arg}{ext}',
+   *
+   *   // Assertion-specific templates
+   *   expect: {
+   *     toHaveScreenshot: {
+   *       pathTemplate: '{testDir}/__screenshots__{/projectName}/{testFilePath}/{arg}{ext}',
+   *     },
+   *     toMatchAriaSnapshot: {
+   *       pathTemplate: '{testDir}/__snapshots__/{testFilePath}/{arg}{ext}',
+   *     },
+   *   },
    * });
    * ```
    *
@@ -1511,27 +1585,27 @@ interface TestConfig<TestArgs = {}, WorkerArgs = {}> {
    * ```
    *
    * The list of supported tokens:
-   * - `{arg}` - Relative snapshot path **without extension**. These come from the arguments passed to the
-   *   `toHaveScreenshot()` and `toMatchSnapshot()` calls; if called without arguments, this will be an auto-generated
-   *   snapshot name.
+   * - `{arg}` - Relative snapshot path **without extension**. This comes from the arguments passed to
+   *   `toHaveScreenshot()`, `toMatchAriaSnapshot()` or `toMatchSnapshot()`; if called without arguments, this will be
+   *   an auto-generated snapshot name.
    *   - Value: `foo/bar/baz`
-   * - `{ext}` - snapshot extension (with dots)
+   * - `{ext}` - Snapshot extension (with the leading dot).
    *   - Value: `.png`
    * - `{platform}` - The value of `process.platform`.
    * - `{projectName}` - Project's file-system-sanitized name, if any.
    *   - Value: `''` (empty string).
    * - `{snapshotDir}` - Project's
-   *   [testConfig.snapshotDir](https://playwright.dev/docs/api/class-testconfig#test-config-snapshot-dir).
+   *   [testProject.snapshotDir](https://playwright.dev/docs/api/class-testproject#test-project-snapshot-dir).
    *   - Value: `/home/playwright/tests` (since `snapshotDir` is not provided in config, it defaults to `testDir`)
    * - `{testDir}` - Project's
-   *   [testConfig.testDir](https://playwright.dev/docs/api/class-testconfig#test-config-test-dir).
-   *   - Value: `/home/playwright/tests` (absolute path is since `testDir` is resolved relative to directory with
+   *   [testProject.testDir](https://playwright.dev/docs/api/class-testproject#test-project-test-dir).
+   *   - Value: `/home/playwright/tests` (absolute path since `testDir` is resolved relative to directory with
    *     config)
    * - `{testFileDir}` - Directories in relative path from `testDir` to **test file**.
    *   - Value: `page`
    * - `{testFileName}` - Test file name with extension.
    *   - Value: `page-click.spec.ts`
-   * - `{testFilePath}` - Relative path from `testDir` to **test file**
+   * - `{testFilePath}` - Relative path from `testDir` to **test file**.
    *   - Value: `page/page-click.spec.ts`
    * - `{testName}` - File-system-sanitized test title, including parent describes but excluding file name.
    *   - Value: `suite-test-should-work`
@@ -8685,20 +8759,22 @@ interface LocatorAssertions {
   /**
    * Asserts that the target element matches the given [accessibility snapshot](https://playwright.dev/docs/aria-snapshots).
    *
+   * Snapshot is stored in a separate `.yml` file in a location configured by `expect.toMatchAriaSnapshot.pathTemplate`
+   * and/or `snapshotPathTemplate` properties in the configuration file.
+   *
    * **Usage**
    *
    * ```js
    * await expect(page.locator('body')).toMatchAriaSnapshot();
-   * await expect(page.locator('body')).toMatchAriaSnapshot({ name: 'snapshot' });
-   * await expect(page.locator('body')).toMatchAriaSnapshot({ path: '/path/to/snapshot.yml' });
+   * await expect(page.locator('body')).toMatchAriaSnapshot({ name: 'body.yml' });
    * ```
    *
    * @param options
    */
   toMatchAriaSnapshot(options?: {
     /**
-     * Name of the snapshot to store in the snapshot (screenshot) folder corresponding to this test. Generates sequential
-     * names if not specified.
+     * Name of the snapshot to store in the snapshot folder corresponding to this test. Generates sequential names if not
+     * specified.
      */
     name?: string;