mirror of
https://github.com/puppeteer/puppeteer
synced 2024-06-14 14:02:48 +00:00
157c883d7d
<!-- Thanks for submitting a pull request! Please provide enough information so that others can review your pull request. --> **What kind of change does this PR introduce?** Fix typos. <!-- E.g. a bugfix, feature, refactoring, build related change, etc… --> **Did you add tests for your changes?** Nope. **If relevant, did you update the documentation?** Yes. **Summary** <!-- Explain the **motivation** for making this change. What existing problem does the pull request solve? --> <!-- Try to link to an open issue for more information. --> Fix typos found via `codespell -S package-lock.json -L currenty,afterall` **Does this PR introduce a breaking change?** Nope. <!-- If this PR introduces a breaking change, please describe the impact and a migration path for existing applications. --> **Other information** Co-authored-by: Alex Rudenko <OrKoN@users.noreply.github.com>
52 lines
2.2 KiB
Markdown
52 lines
2.2 KiB
Markdown
# Puppeteer Angular Schematic
|
|
|
|
Adds Puppeteer-based e2e tests to your Angular project.
|
|
|
|
## Usage
|
|
|
|
Run the command below in an Angular CLI app directory and follow the prompts.
|
|
_Note this will add the schematic as a dependency to your project._
|
|
|
|
```bash
|
|
ng add @puppeteer/ng-schematics
|
|
```
|
|
|
|
Or you can use the same command followed by the [options](#options) below.
|
|
|
|
Currently, this schematic supports the following test frameworks:
|
|
|
|
- **Jasmine** [https://jasmine.github.io/]
|
|
- **Jest** [https://jestjs.io/]
|
|
- **Mocha** [https://mochajs.org/]
|
|
- **Node Test Runner** _(Experimental)_ [https://nodejs.org/api/test.html]
|
|
|
|
With the schematics installed you can run E2E tests:
|
|
|
|
```bash
|
|
ng e2e
|
|
```
|
|
|
|
> Note: Command spawns it's own server on the same port `ng serve` does.
|
|
|
|
## Options
|
|
|
|
When adding schematics to your project you can to provide following options:
|
|
|
|
| Option | Description | Value | Required |
|
|
| -------------------- | ----------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | -------- |
|
|
| `--isDefaultTester` | When true, replaces default `ng e2e` command. | `boolean` | `true` |
|
|
| `--exportConfig` | When true, creates an empty [Puppeteer configuration](https://pptr.dev/guides/configuration) file. (`.puppeteerrc.cjs`) | `boolean` | `true` |
|
|
| `--testingFramework` | The testing framework to install along side Puppeteer. | `"jasmine"`, `"jest"`, `"mocha"`, `"node"` | `true` |
|
|
|
|
## Contributing
|
|
|
|
Check out our [contributing guide](https://pptr.dev/contributing) to get an overview of what you need to develop in the Puppeteer repo.
|
|
|
|
### Unit Testing
|
|
|
|
The schematics utilize `@angular-devkit/schematics/testing` for verifying correct file creation and `package.json` updates. To execute the test suit:
|
|
|
|
```bash
|
|
npm run test
|
|
```
|