Merge pull request #2479 from michaelwarren1106/master

thepassle · web-flow · commit b20cc19587fe · 2023-10-06T19:45:31.000+02:00
chore: add selectOption plugin correctly
diff --git a/.changeset/pink-socks-look.md b/.changeset/pink-socks-look.md
@@ -0,0 +1,6 @@
+---
+'@web/test-runner': patch
+'@web/test-runner-commands': patch
+---
+
+Add the selectOption plugin's exports and types correctly
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -24,7 +24,7 @@ git remote add upstream git@github.com:modernweb-dev/web.git
 Now that you have cloned the repository, ensure you have node 18+ installed, then run the following command to set up the development environment.
 
 ```sh
-npm run install
+npm install
 npm run build
 ```
 
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/test-runner-commands/browser/commands.d.ts b/packages/test-runner-commands/browser/commands.d.ts
@@ -8,6 +8,7 @@ import {
   RemoveFilePayload,
   SnapshotPluginConfig,
   SaveSnapshotPayload,
+  SelectOptionPayload,
   SendMousePayload,
 } from '../dist/index';
 
@@ -135,6 +136,23 @@ export function sendKeys(payload: SendKeysPayload): Promise<void>;
  **/
 export function sendMouse(payload: SendMousePayload): Promise<void>;
 
+/**
+ * Selects an option in a <select> element by value or label
+ * 
+ * @example
+ * ```
+ * it('natively selects an option by value', async () => {
+ *  const valueToSelect = 'first';
+ *  const select = document.querySelector('#testSelect');
+ *
+ *  await selectOption({ selector: '#testSelect', value: valueToSelect });
+ *
+ *  expect(select.value).to.equal(valueToSelect);
+ *});
+ *```
+ */
+export function selectOption(payload: SelectOptionPayload): Promise<void>;
+
 /**
  * Resets the mouse position to (0, 0) and releases mouse buttons.
  *
diff --git a/packages/test-runner-commands/plugins.mjs b/packages/test-runner-commands/plugins.mjs
@@ -4,6 +4,7 @@ import cjsEntrypoint from './dist/index.js';
 const {
   setViewportPlugin,
   emulateMediaPlugin,
+  selectOptionPlugin,
   setUserAgentPlugin,
   sendKeysPlugin,
   sendMousePlugin,
@@ -15,6 +16,7 @@ const {
 export {
   setViewportPlugin,
   emulateMediaPlugin,
+  selectOptionPlugin,
   setUserAgentPlugin,
   sendKeysPlugin,
   sendMousePlugin,
diff --git a/packages/test-runner-commands/src/index.ts b/packages/test-runner-commands/src/index.ts
@@ -1,5 +1,6 @@
 export { Viewport, setViewportPlugin } from './setViewportPlugin';
 export { Media, emulateMediaPlugin } from './emulateMediaPlugin';
+export { selectOptionPlugin, SelectOptionPayload } from './selectOptionPlugin';
 export { setUserAgentPlugin } from './setUserAgentPlugin';
 export { sendKeysPlugin, SendKeysPayload } from './sendKeysPlugin';
 export { sendMousePlugin, SendMousePayload } from './sendMousePlugin';
diff --git a/packages/test-runner/src/config/parseConfig.ts b/packages/test-runner/src/config/parseConfig.ts
@@ -2,6 +2,7 @@ import { CoverageConfig, TestRunnerCoreConfig, TestRunnerGroupConfig } from '@we
 import { chromeLauncher } from '@web/test-runner-chrome';
 import {
   emulateMediaPlugin,
+  selectOptionPlugin,
   setUserAgentPlugin,
   setViewportPlugin,
   sendKeysPlugin,
@@ -251,6 +252,7 @@ export async function parseConfig(
     setViewportPlugin(),
     emulateMediaPlugin(),
     setUserAgentPlugin(),
+    selectOptionPlugin(),
     filePlugin(),
     sendKeysPlugin(),
     sendMousePlugin(),
