mirror/cypress
1
0
Fork 0
mirror of https://github.com/cypress-io/cypress.git synced 2026-02-25 10:30:39 -06:00
Code Issues Packages Projects Releases Wiki Activity

Update packages entries that are out of date.

Browse Source
This commit is contained in:
Emily Rohrbough
2022-09-22 09:44:24 -05:00
parent c81ba75f7f
commit d0141cee24
3 changed files with 16 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
CONTRIBUTING.md
View File

@@ -259,22 +259,33 @@ Here is a list of the core packages in this repository with a short description,
| Folder Name | Package Name | Purpose |
| :------------------------------------ | :---------------------- | :--------------------------------------------------------------------------- |
| [cli](./cli) | `cypress` | The command-line tool that is packaged as an `npm` module. |
| [app](./packages/app) | `@packages/app` | The the front-end for the Cypress App that renders in the launched browser instance. |
| [config](./packages/config) | `@packages/config` | The Cypress configuration types and validation used in the server, data-context and driver. |
| [data-context](./packages/data-context) | `@packages/data-context` | Centralized data access for the Cypress application. |
| [driver](./packages/driver) | `@packages/driver` | The code that is used to drive the behavior of the API commands. |
| [electron](./packages/electron) | `@packages/electron` | The Cypress implementation of Electron. |
| [example](./packages/example) | `@packages/example` | Our example kitchen-sink application. |
| [extension](./packages/extension) | `@packages/extension` | The Cypress Chrome browser extension |
| [frontend-shared](./packages/frontend-shared) | `@packages/frontend-shared` | Shared components and styles used in the `app` and `launchpad`. |
| [graphql](./packages/graphql) | `@packages/graphql` | The GraphQL layer that the `launchpad` and `app` use to interact with the `server`. |
| [https-proxy](./packages/https-proxy) | `@packages/https-proxy` | This does https proxy for handling http certs and traffic. |
| [icons](./packages/icons) | `@packages/icons` | The Cypress icons. |
| [launcher](./packages/launcher) | `@packages/launcher` | Finds and launches browsers installed on your system. |
| [launchpad](./packages/launchpad) | `@packages/launcher` | The portal to running Cypress that displays in `open` mode. |
| [net-stubbing](./packages/net-stubbing) | `@packages/net-stubbing` | Contains server side code for Cypress' network stubbing features. |
| [network](./packages/network) | `@packages/network` | Various utilities related to networking. |
| [proxy](./packages/proxy) | `@packages/proxy` | Code for Cypress' network proxy layer. |
| [launcher](./packages/launcher) | `@packages/launcher` | Finds and launches browsers installed on your system. |
| [reporter](./packages/reporter) | `@packages/reporter` | The reporter shows the running results of the tests (The Command Log UI). |
| [resolve-dist](./packages/resolve-dist) | `@packages/resolve-dist` | Centralizes the resolution of paths to compiled/static assets from server-side code.. |
| [rewriter](./packages/rewriter) | `@packages/rewriter` | The logic to rewrite JS and HTML that flows through the Cypress proxy.
| [root](./packages/root) | `@packages/root` | Dummy package pointing at the root of the repository. |
| [runner](./packages/runner) | `@packages/runner` | The runner is the minimal "chrome" around the user's application under test. |
| [runner](./packages/runner) | `@packages/runner` | (deprecated) The runner is the minimal "chrome" around the user's application under test. |
| [scaffold-config](./packages/scaffold-config) | `@packages/scaffold-config` | The logic related to scaffolding new projects using launchpad. |
| [server](./packages/server) | `@packages/server` | The <3 of Cypress. This orchestrates everything. The backend node process. |
| [server-ct](./packages/server-ct) | `@packages/server-ct` | Some Component Testing specific overrides. Mostly extends functionality from `@packages/server` |
| [socket](./packages/socket) | `@packages/socket` | A wrapper around socket.io to provide common libraries. |
| [ts](./packages/ts) | `@packages/ts` | A centralized version of typescript. |
| [types](./packages/types) | `@packages/types` | The shared internal Cypress types. |
| [web-config](./packages/web-config) | `@packages/ui-components` | The web-related configuration. |
Public packages live within the [`npm`](./npm) folder and are standalone modules that get independently published to npm under the `@cypress/` namespace. These packages generally contain extensions, plugins, or other packages that are complementary to, yet independent of, the main Cypress app.

2
packages/config/README.md
View File

@@ -1,6 +1,6 @@
# Config
The `config` package contains the configuration types and validation used in both the `server` and the `driver` for setting the Cypress configuration values.
The `config` package contains the configuration types and validation used in both the `server`, the `data-context` and the `driver` for setting the Cypress configuration values.
## Testing

2
packages/graphql/README.md
View File

@@ -1,6 +1,6 @@
# GraphQL
The GraphQL layer that `@packages/launchpad` and `@packages/runner` use to interact with `@packages/server`.
The GraphQL layer that `@packages/launchpad` and `@packages/app` use to interact with `@packages/server`.
With the goal of type safety, several tools and abstractions are used. The technologies are: