Skip to content

Commit

Permalink
Remove runner-shared and runner-ct comments.
Browse files Browse the repository at this point in the history
  • Loading branch information
sainthkh committed Aug 2, 2022
1 parent eaefe4a commit 02a4378
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 15 deletions.
2 changes: 0 additions & 2 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,6 @@
/packages/rewriter/ @cypress-io/end-to-end
/packages/root/ @cypress-io/end-to-end
/packages/runner/ @cypress-io/end-to-end
/packages/runner-ct/ @cypress-io/component-testing
/packages/runner-shared/ @cypress-io/end-to-end
/packages/server/ @cypress-io/end-to-end
/packages/socket/ @cypress-io/end-to-end
/packages/static/ @cypress-io/end-to-end
Expand Down
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,8 @@ system-tests/lib/fixtureDirs.ts
# from npm/webpack-dev-server
/npm/webpack-dev-server/cypress/videos

# from runner-ct
/packages/runner-ct/cypress/screenshots
# from runner
/packages/runner/cypress/screenshots

# from errors
/packages/errors/__snapshot-images__
Expand Down
7 changes: 0 additions & 7 deletions .vscode/terminals.json
Original file line number Diff line number Diff line change
Expand Up @@ -83,13 +83,6 @@
"cwd": "[cwd]/packages/runner",
"command": "yarn watch"
},
{
"name": "packages/runner-ct watch",
"focus": true,
"onlySingle": true,
"cwd": "[cwd]/packages/runner-ct",
"command": "yarn watch"
},
{
"name": "packages/driver cypress open",
"focus": true,
Expand Down
4 changes: 2 additions & 2 deletions packages/app/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,13 +91,13 @@ The terminology can get a bit confusing as Vue Router's `params` are not the que

## Using existing, Vite-incompatible modules

Some of our modules, like `@packages/reporter`, `@packages/driver` and `@packages/runner-shared` cannot be easily
Some of our modules, like `@packages/reporter`, `@packages/driver` and `@packages/runner` cannot be easily
used with Vite due to circular dependencies and modules that do not have compatible ESM builds.

To work around this, when consuming existing code, it is bundled with webpack and made available under the
`window.UnifiedRunner` namespace. It is injected via [`injectBundle`](./src/runner/injectBundle.ts).

To add more code to the bundle, add it in the bundle root, `@packages/runner-ct/src/main.tsx` and attach it to
To add more code to the bundle, add it in the bundle root, `@packages/runner/src/main.tsx` and attach it to
`window.UnifiedRunner`.

As a rule of thumb, avoid importing from the older, webpack based modules into this package. Instead, if you want to consume code from those older, webpack bundled modules, you should add them to the webpack root and consume them via `window.UnifiedRunner`. Ideally, update [`index.d.ts`](./index.d.ts) to add the types, as well.
Expand Down
4 changes: 2 additions & 2 deletions packages/app/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,11 @@ declare global {

/**
* Any React components or general code needed from
* runner-shared, reporter or driver are also bundled with
* runner, reporter or driver are also bundled with
* webpack and made available via the window.UnifedRunner namespace.
*
* We cannot import the correct types, because this causes the linter and type
* checker to run on runner-shared and reporter, and it blows up.
* checker to run on runner and reporter, and it blows up.
*/
Reporter: any
shortcuts: {
Expand Down

0 comments on commit 02a4378

Please sign in to comment.