mirror of https://github.com/cypress-io/cypress.git synced 2026-03-14 21:30:37 -05:00

Files

Josef Biehler 259bfbecbe add Loggable options to its() / invoke() command (#5519 )

* add Loggable options to its() command

* add test for new Loggable option for its()

* add loggable options to invoke()

* add type definition
fix: only set logger config once. afterwards other commands can overwrite the logger config as done in line 322
remove unused error message (usage was removed in a former commit)
remove test that is unnecessary now

* add check if its() was passed additional arguments next to options

* try to fix test

* do not log 'this' context

* from review: add additional tests and fix some edge cases

* add tests for combination of loggable options and numeric index

* fix wrong indentation

* write as 'functionName' and 'propertyName' to match other error message

* Update tests to reflect newly worded errors


Co-authored-by: Jennifer Shehane <shehane.jennifer@gmail.com>

2019-12-04 11:52:44 +06:30

__snapshots__

catch child process killed with a signal (#5810 )

2019-11-27 15:21:47 -05:00

bin

…

lib

cli: unnzip Cypress using unzip utility on Linux (#5851 )

2019-12-03 09:19:12 -05:00

schema

allow list of search patterns in testFiles config option (#5402 )

2019-10-31 11:26:47 -04:00

scripts

upgrade jQuery types to 3.3.31 to pass TS 3.6.2 check (#5230 )

2019-09-28 22:01:12 -04:00

test

cli: unnzip Cypress using unzip utility on Linux (#5851 )

2019-12-03 09:19:12 -05:00

types

add Loggable options to its() / invoke() command (#5519 )

2019-12-04 11:52:44 +06:30

.babelrc

…

.npmrc

…

.release.json

…

index.js

Catch env variable with reserved name CYPRESS_ENV 1621 (#1626 )

2019-09-23 11:59:49 -04:00

NPM_README.md

WIP cleanup npm cli readme

2017-09-02 22:51:07 -04:00

package.json

parse ~ in CYPRESS_CACHE_FOLDER env variable (#5393 )

2019-10-17 11:47:29 -04:00

README.md

Update cli readme to include link to npm module / add new responsibil… (#5339 )

2019-10-10 11:01:01 -04:00

README.md

CLI

The CLI is used to build the cypress npm module to be run within a terminal.

The CLI has the following responsibilities:

Allow users to print CLI commands
Allow users to install the Cypress executable
Allow users to print their current Cypress version
Allow users to run Cypress tests from the terminal
Allow users to open Cypress in the interactive Test Runner.
Allow users to verify that Cypress is installed correctly and executable
Allow users to manages the Cypress binary cache
Allow users to pass in options that change way tests are ran or recorded (browsers used, specfiles ran, grouping, parallelization)

Installing

The CLI's dependencies can be installed with:

cd cli
npm install

Building

See scripts/build.js. Note that the built npm package will include NPM_README.md as its public README file.

Testing

Automated

You can run unit tests with:

npm test

This will take and compare snapshots of the CLI output. To update snapshots, see snap-shot-it instructions: https://github.com/bahmutov/snap-shot-it#advanced-use

Manual

To build and test an NPM package:

npm install
npm run build

This creates build folder.

cd build; npm pack

This creates an archive, usually named cypress-<version>.tgz. You can install this archive from other projects, but because there is no corresponding binary yet (probably), skip binary download. For example from inside cypress-example-kitchensink folder

npm i ~/{your-dirs}/cypress/cli/build/cypress-3.3.1.tgz --ignore-scripts

Which installs the tgz file we have just built from folder Users/jane-lane/{your-dirs}/cypress/cli/build.