Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/briebug/cypress-schematic
**⛔️ DEPRECATED** Add cypress to an Angular CLI project
https://github.com/briebug/cypress-schematic
angular angular-builders angular-schematics cypress cypress-schematic deprecated e2e-tests hacktoberfest
Last synced: about 2 months ago
JSON representation
**⛔️ DEPRECATED** Add cypress to an Angular CLI project
- Host: GitHub
- URL: https://github.com/briebug/cypress-schematic
- Owner: briebug
- License: mit
- Archived: true
- Created: 2019-01-23T20:58:36.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-07-19T05:26:16.000Z (about 1 year ago)
- Last Synced: 2024-06-30T15:31:17.657Z (3 months ago)
- Topics: angular, angular-builders, angular-schematics, cypress, cypress-schematic, deprecated, e2e-tests, hacktoberfest
- Language: TypeScript
- Homepage:
- Size: 1.44 MB
- Stars: 154
- Watchers: 6
- Forks: 25
- Open Issues: 57
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# ⛔️ DEPRECATED ⛔️ Cypress Angular Schematic
[](https://www.npmjs.com/package/@briebug/cypress-schematic)
## ⛔️ DEPRECATED ⛔️
### This Angular Schematic has been adopted by Cypress and will be maintained in their repository by the Cypress Team moving forward. Head over to https://github.com/cypress-io/cypress/tree/develop/npm/cypress-schematic for more info, and feel free to contribute!
### Thank you
Thank you to the contributors of this library [@muuvmuuv](https://github.com/muuvmuuv), [@konstantindenerz](https://github.com/konstantindenerz), [@cexbrayat](https://github.com/cexbrayat), [@MrCube42](https://github.com/MrCube42), [@devinshoemaker](https://github.com/devinshoemaker), [@Ant59](https://github.com/Ant59), [@NileshPatel17](https://github.com/NileshPatel17), [@timtim5174](https://github.com/timtim5174), [@tabuckner](https://github.com/tabuckner), and [@bovandersteene](https://github.com/bovandersteene). Thank you [@schuchard](https://github.com/schuchard) for pioneering the sandbox approach for developing Angular schematics.
Add [Cypress](https://cypress.io) to an Angular CLI project
This schematic will:
- install Cypress, its dependencies, and new scripts
- add necessary files for Cypress to work with Angular & Typescript
- prompt for removal of Protractor files and configuration
## Usage 🚀
Run as one command in an Angular CLI app directory. Note this will add the schematic as a dependency to your project.
```shell
ng add @briebug/cypress-schematic
```
With the custom builder installed, you can run cypress with the following commands:
```shell script
ng e2e
```
```shell script
ng run {your-project-name}:cypress-open
```
These two commands do the same thing. They will launch the (Electron) Cypress Test Runner in watch mode.
```shell script
ng run {your-project-name}:cypress-run
```
This command will open the (Electron) Cypress Test Runner and run your tests one time, with output to your terminal.
#### Options
| Option | Description |
| --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| addCypressTestScripts | This will add Cypress `open` and `run` command scripts to your `package.json`. Include `--addCypressTestScripts` in your `ng add` command. |
| noBuilder | This will skip the builder addition, leaving the `angular.json` file unmodified and requiring you to run Cypress from the command line or through your IDE. Include `--noBuilder` in your `ng add` command. |
## Issues
Issues with this schematic can be filed [here](https://github.com/briebug/cypress-schematic/issues/new/choose).
If you want to contribute (or have contributed in the past), feel free to add yourself to the list of contributors in the `package.json` before you open a PR!
## Development 🛠
### Getting started
⚙ [Node.js and npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) are required for the scripts. Make sure it's installed on your machine.
⬇ **Install** the dependencies for the schematic and the sandbox application
```bash
npm i && cd sandbox && npm i && cd ..
```
🖇 **Link** the schematic in the sandbox to run locally
```bash
npm run link:sandbox
```
🏃 **Run** the schematic
```bash
npm run build:clean:launch
```
## E2E testing
Execute the schematic against the sandbox. Then run linting, unit & e2e tests and a prod build in the sandbox.
```bash
npm run test
```
## Unit Testing
Run the unit tests using Jasmine as a runner and test framework.
```bash
npm run test:unit
```
## Reset the sandbox
Running the schematic locally makes file system changes. The sandbox is version controlled so that viewing a diff of the changes is trivial. After the schematic has run locally, reset the sandbox with the following.
```bash
npm run clean
```