github/puppeteer
0
0
Fork 0
mirror of https://github.com/puppeteer/puppeteer synced 2024-06-14 14:02:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: Update ng-schemactics README (#9269)

Browse Source 
**What kind of change does this PR introduce?**

Updates the README for `@puppeteer/ng-schematics` with better
information. Fixes broken command
This commit is contained in:
Nikolay Vitkov 2022-11-14 15:18:03 +01:00 committed by GitHub
parent 57f7366eb8
commit 1b3dfeca98
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
packages/ng-schematics/README.md
View File

@ -1,23 +1,41 @@
# Puppeteer Schematics Angular
# Puppeteer Angular Schematic
This schematics provide a simple set up of Puppeteer for an Angular project.
Adds Puppeteer-based e2e tests to your Angular project.
## Usage
Run the command in an Angular CLI app directory.
Run the command bellow 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 puppetter-schematics
ng add @puppeteer/ng-schematics
```
With the schematics installed, you can run E2E tests with your chose:
Or you can use the same command followed by the [options](#options) bellow.
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
npm run e2e
# or yarn e2e
```
## Options
When adding schematics to your project you can to provide following options:
| Option | Description | Value | Required |
| -------------------- | ----------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | -------- |
| `--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` |
### Unit Testing
The schematics utilize `@angular-devkit/schematics/testing` for verifying correct file creation and `package.json` updates. To execute the test suit: