feat(adapter): rename config helper to createConfig (#37)

* feat(adapter): rename config helper to `createConfig`

* add breaking changes file

Author: tanner-reits

BREAKING_CHANGES.md

@@ -0,0 +1,12 @@
+# Breaking Changes
+
+This is a list of all breaking changes introduced in the Stencil Playwright adapter. This document is broken into two sections:
+
+1. Breaking changes introduced in experimental versions (i.e. pre-1.0)
+2. Breaking changes introduced in major releases
+
+## Experimental Releases
+
+### v0.2.0
+
+- `createStencilPlaywrightConfig` renamed to `createConfig`

README.md

@@ -31,26 +31,26 @@ For full documentation, please see the [Playwright testing docs on the official
    // playwright.config.ts
 
    import { expect } from '@playwright/test';
-   import { matchers, createStencilPlaywrightConfig } from '@stencil/playwright';
+   import { matchers, createConfig } from '@stencil/playwright';
 
    expect.extend(matchers);
 
-   export default createStencilPlaywrightConfig();
+   export default createConfig();
    ```
 
 1. At this point, any tests can be executed using `npx playwright test` (or by updating the project's test command in the `package.json`). By default, Playwright's test matcher
    is configured to run all tests matching the pattern `*.e2e.ts`. This can be changed by overriding the default matcher using the
-   [`createStencilPlaywrightConfig()` function](#createstencilplaywrightconfigoverrides-createstencilplaywrightconfigoptions-promiseplaywrighttestconfig):
+   [`createConfig()` function](#createconfigoverrides-createstencilplaywrightconfigoptions-promiseplaywrighttestconfig):
 
    ```ts
    // playwright.config.ts
 
    import { expect } from '@playwright/test';
-   import { matchers, createStencilPlaywrightConfig } from '@stencil/playwright';
+   import { matchers, createConfig } from '@stencil/playwright';
 
    expect.extend(matchers);
 
-   export default createStencilPlaywrightConfig({
+   export default createConfig({
      // Change which test files Playwright will execute
      testMatch: '*.spec.ts',
      // Any other Playwright config option can also be overridden
@@ -122,7 +122,7 @@ test.describe('my-component', () => {
 
 ## API
 
-### `createStencilPlaywrightConfig(overrides?: CreateStencilPlaywrightConfigOptions): Promise<PlaywrightTestConfig>`
+### `createConfig(overrides?: CreateStencilPlaywrightConfigOptions): Promise<PlaywrightTestConfig>`
 
 Returns a [Playwright test configuration](https://playwright.dev/docs/test-configuration#introduction).
 
@@ -136,11 +136,11 @@ as some options to override specific values in the config options related to the
 // playwright.config.ts
 
 import { expect } from '@playwright/test';
-import { matchers, createStencilPlaywrightConfig } from '@stencil/playwright';
+import { matchers, createConfig } from '@stencil/playwright';
 
 expect.extend(matchers);
 
-export default createStencilPlaywrightConfig({
+export default createConfig({
   // Change which test files Playwright will execute
   testMatch: '*.spec.ts',
 

src/create-config.ts

@@ -31,9 +31,7 @@ export type CreateStencilPlaywrightConfigOptions = Partial<PlaywrightTestConfig>
  * @param overrides Values to override in the default config. Any Playwright config option can be overridden.
  * @returns A {@link PlaywrightTestConfig} object
  */
-export const createStencilPlaywrightConfig = async (
-  overrides?: CreateStencilPlaywrightConfigOptions,
-): Promise<PlaywrightTestConfig> => {
+export const createConfig = async (overrides?: CreateStencilPlaywrightConfigOptions): Promise<PlaywrightTestConfig> => {
   const { webServerUrl, baseURL, stencilEntryPath, stencilNamespace } = await loadConfigMeta();
 
   // Set the Stencil namespace and entry path as environment variables so we can use them when constructing

src/playwright-page.ts

@@ -32,7 +32,7 @@ type CustomFixtures = {
  */
 async function extendPageFixture(page: E2EPage) {
   // Make sure the Stencil namespace and entry path are set on the process so we can use them in the `setContent` tests.
-  // These wouldn't be set if the user didn't setup the Playwright config with the `createStencilPlaywrightConfig()` helper.
+  // These wouldn't be set if the user didn't setup the Playwright config with the `createConfig()` helper.
   if (!process.env[ProcessConstants.STENCIL_NAMESPACE] || !process.env[ProcessConstants.STENCIL_ENTRY_PATH]) {
     const { stencilNamespace, stencilEntryPath } = await loadConfigMeta();
 

src/test/create-config.spec.ts

@@ -1,4 +1,4 @@
-import { createStencilPlaywrightConfig } from '../create-config';
+import { createConfig } from '../create-config';
 
 // Mock the loadConfigMeta function to just return the default values
 jest.mock('../load-config-meta', () => ({
@@ -10,9 +10,9 @@ jest.mock('../load-config-meta', () => ({
   }),
 }));
 
-describe('createStencilPlaywrightConfig', () => {
+describe('createConfig', () => {
   it('should create a default config', async () => {
-    const config = await createStencilPlaywrightConfig();
+    const config = await createConfig();
 
     expect(config).toEqual({
       testMatch: '*.e2e.ts',
@@ -30,7 +30,7 @@ describe('createStencilPlaywrightConfig', () => {
   });
 
   it('should override the default config', async () => {
-    const config = await createStencilPlaywrightConfig({
+    const config = await createConfig({
       webServerCommand: 'npm start -- --no-open --port 4444',
       testDir: 'tests/e2e',
     });