@stencil/playwright 0.1.0-dev.1710423801.d98b1c3

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.
package/LICENSE.md ADDED
@@ -0,0 +1,27 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2019-present Drifty Co.
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
22
+
23
+ -----------------------------------------
24
+ Third-party components, software, and/or libraries (collectively, "components")
25
+ are included under the licenses specified by their authors. For information
26
+ about these third-party licenses, refer to the separate legal notices governing
27
+ such components at NOTICE file at the top level of the package.
package/README.md ADDED
@@ -0,0 +1 @@
1
+ # @stencil/playwright
@@ -0,0 +1,29 @@
1
+ import { PlaywrightTestConfig } from '@playwright/test';
2
+ /**
3
+ * Options for creating a Playwright config for Stencil projects. This extends the default Playwright config
4
+ * with some additional options specific to overriding options for the Playwright dev server.
5
+ */
6
+ export type CreateStencilPlaywrightConfigOptions = Partial<PlaywrightTestConfig> & {
7
+ /**
8
+ * The command to execute to start the dev server. This can be a bash command or a local npm script.
9
+ *
10
+ * Defaults to `npm start -- --no-open`.
11
+ */
12
+ webServerCommand?: string;
13
+ /**
14
+ * The maximum time to wait for the dev server to start before aborting.
15
+ *
16
+ * Defaults to `60000` (60 seconds).
17
+ */
18
+ webServerTimeout?: number;
19
+ };
20
+ /**
21
+ * Helper function to easily create a Playwright config for Stencil projects. This function will
22
+ * automatically load the Stencil config meta to set default values for the Playwright config respecting the
23
+ * Stencil dev server configuration, and set the Stencil namespace and entry path as environment variables for use
24
+ * in the Playwright tests.
25
+ *
26
+ * @param overrides Values to override in the default config. Any Playwright config option can be overridden.
27
+ * @returns A {@link PlaywrightTestConfig} object
28
+ */
29
+ export declare const createStencilPlaywrightConfig: (overrides?: CreateStencilPlaywrightConfigOptions) => Promise<PlaywrightTestConfig>;