Hello! 👋 This repository uses Auto for releasing packages using PR labels.

✨ This PR can be merged but will not trigger a new release. To trigger a new release add the release label before merging.
NOTE: When merging a PR with the release label please avoid merging another PR. For further information see here.

I'm a bit sceptical to this. This will make it a little harder to overview and edit the Playwright config for plugin developers. And to my knowledge, Playwright don't offer any abstraction to merge configs (the way for example Webpack does with [https://www.npmjs.com/package/webpack-merge]).

Now that we're soon to release the new create-plugin update cmd that allows us to safely manipulate files outside the .config dir, is this really necessary? cc @jackw who initially raised this issue.

Merging the configs isn't a problem since playwright expects the default object exposed from that file to be the config. So you can use what ever merge util you want to merge multiple configs.

But I agree with your thoughts regarding the migrations. However, it might not be easy to migrate a file that is changed by the user. So moving the base to .config folder might be a good idea regardless. WDYT?

I'm a bit sceptical to this. This will make it a little harder to overview and edit the Playwright config for plugin developers. And to my knowledge, Playwright don't offer any abstraction to merge configs (the way for example Webpack does with [https://www.npmjs.com/package/webpack-merge]).

As others have also pointed out we can rely on spreading these configs but I believe Playwright does have some concept of merging configs via defineConfig which can take multiple configs. e.g. defineConfig(defaultConfig, {});.

However, the playwright team decided that the projects property should override which would result in needing to do:

export default defineConfig(defaultConfig, {
  projects: [
    ...defaultConfig.projects!,
    {
      name: 'firefox',
      use: { ...devices['Desktop Firefox'], storageState: 'playwright/.auth/admin.json' },
      dependencies: ['auth'],
    },
  ],
});

Whilst it was originally designed for webpack, webpack-merge isn't webpack specific. You can use it for any config including playwrights:

import { merge } from 'webpack-merge';
import defaultConfig from './.config/playwright.config';

const config = merge(defaultConfig, {
  projects: [
    {
      name: 'firefox',
      use: { ...devices['Desktop Firefox'], storageState: 'playwright/.auth/admin.json' },
      dependencies: ['auth'],
    },
  ],
});

export default defineConfig(config);

Now that we're soon to release the new create-plugin update cmd that allows us to safely manipulate files outside the .config dir, is this really necessary?

Within create-plugin, we have the concept of "put default configs in .config directory and extend in files in root of project" and I opened the issue to align our playwright config with this concept. I also agree with @mckn that even with migrations it's much easier to update a file in the .config directory as we consider them ours and document in the files and in our docs website that touching them is a bad idea.