Utility for launching your applications on a per-test basis.
## Usage
### Install
```sh
npm install @epic-web/app-launcher
```
### Define launcher
```ts
// remix.launcher.ts
import { defineLauncher } from '@epic-web/app-launcher'
import getPort from 'get-port'
export const launcher = defineLauncher({
async context() {
return {
port: await getPort(),
}
},
env({ context }) {
return {
PORT: context.port.toString(),
}
},
command() {
return `npm start`
},
url({ context }) {
return `http://localhost:${context.port}`
},
})
```
### Use
```ts
import { launcher } from './remix.launcher.js'
test('renders the homepage', async ({ page }) => {
await using app = await launcher.run()
await page.goto(app.url.href)
await expect(page.getByText("Welcome!")).toBeVisible()
})
```
> [!NOTE]
> Calling `.run()` on the launcher returns a _diposable_ application object. Use the special `using` keyword to automatically close the application process once the test is done.
### Extend
You can create a launcher by _extending_ an existing launcher. Provide the launcher object you want to extend as the value of the `extends` property when creating a launcher:
```ts
import { remoteUtils } from 'msw/node'
import { launcher } from './remix.launcher.js'
export const launcher = defineLauncher({
extends: launcher,
async env() {
return {
[remoteUtils.variableName]: remoteUtils.getContextId(),
}
},
})
```
Extending an existing launcher will inherit the following of its properties:
- `env`
## API
### `defineLauncher(options)`
- `options` `
