{"id":20560098,"url":"https://github.com/webdriverio/webdriverio-schematics","last_synced_at":"2025-10-23T23:11:35.016Z","repository":{"id":37966724,"uuid":"347904952","full_name":"webdriverio/webdriverio-schematics","owner":"webdriverio","description":"Add WebdriverIO to an Angular CLI project","archived":false,"fork":false,"pushed_at":"2024-05-20T11:47:04.000Z","size":855,"stargazers_count":18,"open_issues_count":20,"forks_count":8,"subscribers_count":12,"default_branch":"main","last_synced_at":"2025-09-10T13:28:03.419Z","etag":null,"topics":["angular","cli","hacktoberfest","ng","schematics","tooling","webdriverio"],"latest_commit_sha":null,"homepage":"https://webdriver.io","language":"TypeScript","has_issues":true,"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/webdriverio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"tidelift":"npm/webdriverio","open_collective":"webdriverio"}},"created_at":"2021-03-15T09:18:08.000Z","updated_at":"2024-03-04T06:44:01.000Z","dependencies_parsed_at":"2024-03-19T03:06:16.920Z","dependency_job_id":"36700a1a-8860-4a42-a9c2-4a5c883eec42","html_url":"https://github.com/webdriverio/webdriverio-schematics","commit_stats":{"total_commits":94,"total_committers":11,"mean_commits":8.545454545454545,"dds":0.4148936170212766,"last_synced_commit":"2667a203fb4cb89805077dd77341a03ead257823"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/webdriverio/webdriverio-schematics","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webdriverio%2Fwebdriverio-schematics","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webdriverio%2Fwebdriverio-schematics/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webdriverio%2Fwebdriverio-schematics/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webdriverio%2Fwebdriverio-schematics/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/webdriverio","download_url":"https://codeload.github.com/webdriverio/webdriverio-schematics/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webdriverio%2Fwebdriverio-schematics/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":280706850,"owners_count":26376996,"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","status":"online","status_checked_at":"2025-10-23T02:00:06.710Z","response_time":142,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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","cli","hacktoberfest","ng","schematics","tooling","webdriverio"],"created_at":"2024-11-16T03:53:12.438Z","updated_at":"2025-10-23T23:11:34.970Z","avatar_url":"https://github.com/webdriverio.png","language":"TypeScript","readme":"WebdriverIO Angular Schematic [![Test](https://github.com/webdriverio/webdriverio-schematics/actions/workflows/test.yaml/badge.svg)](https://github.com/webdriverio/webdriverio-schematics/actions/workflows/test.yaml)\n=============================\n\n\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"WebdriverIO Schematic Logo\" src=\"/.github/assets/logo.png\" width=300 /\u003e\n\u003c/p\u003e\n\nAdd [WebdriverIO](https://webdriver.io) to an Angular CLI project\n\nThis schematic will:\n\n- install WebdriverIO and its dependencies\n- add necessary files for WebdriverIO 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 @wdio/schematics\n```\n\nWith the custom builder installed, you can run WebdriverIO with the following commands:\n\n```shell script\nng e2e\n```\n\nor\n\n```shell script\nng run {your-project-name}:wdio-run\n# or run wdio directly via\nnpx wdio run wdio.conf.js\n```\n\nThese two commands do the same thing. They will launch the WebdriverIO testrunner.\n\n#### Parameter Options\n\nWhen adding WebdriverIO Schematics to your project you can invoke the following options:\n\n| Option | Description |\n| ------ | ----------- |\n| `--removeProtractor` | When true, the protractor dependency and e2e directory will be removed from the project |\n| `--noWizard` | When true, it does not run the WebdriverIO setup wizard, requiring the user setup the framework by themselves |\n| `--noBuilder` | When true, the angular.json file will not be modified to add WebdriverIO commands, requiring the user to run WebdriverIO from the command line independent of the Angular CLI |\n| `--yes` | When true, it configures WebdriverIO with default settings. |\n| `--yarn` | When true, it uses yarn rather than npm. |\n\nFor example to add a basic WebdriverIO setup without going through the configuration wizard, just run:\n\n```sh\n$ ng add @wdio/schematics --yes\n```\n\nOnce WebdriverIO is added to your project you can apply the common [WDIO CLI options](https://webdriver.io/docs/clioptions) when triggering the test.\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\n$ npm 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\n$ npm run link:sandbox\n```\n\n🏃 **Run** the schematic\n\n```bash\n$ cd sandbox\n$ npx ng add @wdio/schematics\n```\n\n## E2E testing\n\nExecute the schematic against the sandbox.\n\n```bash\nnpm run test\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\n---\n\nParts of the implementation were based of [`@briebug/cypress-schematic`](https://github.com/briebug/cypress-schematic/blob/master/README.md). Thank you!\n","funding_links":["https://tidelift.com/funding/github/npm/webdriverio","https://opencollective.com/webdriverio"],"categories":["Plugins"],"sub_categories":["Miscellaneous"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebdriverio%2Fwebdriverio-schematics","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwebdriverio%2Fwebdriverio-schematics","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebdriverio%2Fwebdriverio-schematics/lists"}