{"id":13406813,"url":"https://github.com/briebug/cypress-schematic","last_synced_at":"2025-03-14T11:30:45.493Z","repository":{"id":34067942,"uuid":"167253160","full_name":"briebug/cypress-schematic","owner":"briebug","description":"**⛔️  DEPRECATED** Add cypress to an Angular CLI project","archived":true,"fork":false,"pushed_at":"2023-07-19T05:26:16.000Z","size":1511,"stargazers_count":154,"open_issues_count":57,"forks_count":25,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-10-02T20:37:08.355Z","etag":null,"topics":["angular","angular-builders","angular-schematics","cypress","cypress-schematic","deprecated","e2e-tests","hacktoberfest"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/briebug.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2019-01-23T20:58:36.000Z","updated_at":"2024-01-24T01:23:34.000Z","dependencies_parsed_at":"2023-02-18T10:00:36.828Z","dependency_job_id":"e5da6d00-87bd-4a05-aed2-5cd8fac05c7f","html_url":"https://github.com/briebug/cypress-schematic","commit_stats":{"total_commits":152,"total_committers":16,"mean_commits":9.5,"dds":0.506578947368421,"last_synced_commit":"e87bbc46ae43e47feb78b6ec4084a50bdf67bb49"},"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/briebug%2Fcypress-schematic","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/briebug%2Fcypress-schematic/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/briebug%2Fcypress-schematic/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/briebug%2Fcypress-schematic/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/briebug","download_url":"https://codeload.github.com/briebug/cypress-schematic/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243569101,"owners_count":20312358,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["angular","angular-builders","angular-schematics","cypress","cypress-schematic","deprecated","e2e-tests","hacktoberfest"],"created_at":"2024-07-30T19:02:39.957Z","updated_at":"2025-03-14T11:30:44.396Z","avatar_url":"https://github.com/briebug.png","language":"TypeScript","readme":"# ⛔️ DEPRECATED ⛔️ Cypress Angular Schematic\n\n[![npm (scoped)](https://img.shields.io/npm/v/@briebug/cypress-schematic.svg)](https://www.npmjs.com/package/@briebug/cypress-schematic)\n![Downloads](https://img.shields.io/npm/dm/@briebug/cypress-schematic.svg)\n\n\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"Cypress Schematic Logo\" src=\"/cypress-schematic-logo-v2.png\" width=300 /\u003e\n\u003c/p\u003e\n\n## ⛔️ DEPRECATED ⛔️\n### 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!\n\n\n### Thank you\nThank 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.\n\n\u003chr\u003e\n\nAdd [Cypress](https://cypress.io) to an Angular CLI project\n\nThis schematic will:\n\n- install Cypress, its dependencies, and new scripts\n- add necessary files for Cypress to work with Angular \u0026 Typescript\n- prompt for removal of Protractor files and configuration\n\n## Usage 🚀\n\nRun as one command in an Angular CLI app directory. Note this will add the schematic as a dependency to your project.\n\n```shell\nng add @briebug/cypress-schematic\n```\n\nWith the custom builder installed, you can run cypress with the following commands:\n\n```shell script\nng e2e\n```\n\n```shell script\nng run {your-project-name}:cypress-open\n```\n\nThese two commands do the same thing. They will launch the (Electron) Cypress Test Runner in watch mode.\n\n```shell script\nng run {your-project-name}:cypress-run\n```\n\nThis command will open the (Electron) Cypress Test Runner and run your tests one time, with output to your terminal.\n\n#### Options\n\n| Option                | Description                                                                                                                                                                                                 |\n| --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| addCypressTestScripts | This will add Cypress `open` and `run` command scripts to your `package.json`. Include `--addCypressTestScripts` in your `ng add` command.                                                                  |\n| 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. |\n\n## Issues\n\nIssues with this schematic can be filed [here](https://github.com/briebug/cypress-schematic/issues/new/choose).\n\nIf 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!\n\n## Development 🛠\n\n### Getting started\n\n⚙ [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.\n\n⬇ **Install** the dependencies for the schematic and the sandbox application\n\n```bash\nnpm i \u0026\u0026 cd sandbox \u0026\u0026 npm i \u0026\u0026 cd ..\n```\n\n🖇 **Link** the schematic in the sandbox to run locally\n\n```bash\nnpm run link:sandbox\n```\n\n🏃 **Run** the schematic\n\n```bash\nnpm run build:clean:launch\n```\n\n## E2E testing\n\nExecute the schematic against the sandbox. Then run linting, unit \u0026 e2e tests and a prod build in the sandbox.\n\n```bash\nnpm run test\n```\n\n## Unit Testing\n\nRun the unit tests using Jasmine as a runner and test framework.\n\n```bash\nnpm run test:unit\n```\n\n## Reset the sandbox\n\nRunning 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.\n\n```bash\nnpm run clean\n```\n","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbriebug%2Fcypress-schematic","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbriebug%2Fcypress-schematic","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbriebug%2Fcypress-schematic/lists"}