mirror of https://github.com/cypress-io/cypress.git synced 2026-02-05 23:00:03 -06:00

Files

Gleb Bahmutov 143eccd607 add TypeScript definitions for the cypress npm module (#3826 )

* WIP: start TS definition for Cypress NPM module

* describe run and open options

* add jsdoc and make options optional

* fix expected type

* add more properties to Cypress config interface

* explain all config properties

* more definitions

* add types for test results

* export = cypress in NPM module

* remove ts ignore that is no longer needed

2019-04-03 11:25:36 -04:00

__snapshots__

Downgrade cachedir and commander packages back to versions that support Node 4

2019-03-15 12:31:33 +06:30

bin

Issue 156 cli node 0.12 (#158 )

2017-06-19 12:14:06 -04:00

lib

Handle lowercase environment variable names in proxy (#3866 )

2019-04-03 08:23:07 -04:00

schema

schema: update videoCompression to allow boolean, close #2140 (#2142 )

2018-07-23 06:12:04 -04:00

scripts

remove stray circleci line, more CLI types comments

2019-03-05 13:09:50 -05:00

test

Improved proxy support (#3531 )

2019-03-31 23:39:10 -04:00

types

add TypeScript definitions for the cypress npm module (#3826 )

2019-04-03 11:25:36 -04:00

.babelrc

Issue 156 cli node 0.12 (#158 )

2017-06-19 12:14:06 -04:00

.npmrc

cli: specify exact prod dependency versions, close #164

2017-06-20 13:33:58 -04:00

.release.json

cli: copy .release.json into build

2017-06-19 17:07:07 -04:00

index.js

cli: normalized all start methods

2017-09-04 00:00:41 -04:00

NPM_README.md

WIP cleanup npm cli readme

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

package.json

bump dep to support node 4 in the CLI

2019-04-03 02:50:38 -04:00

README.md

move 3rd party types to dev dependencies in CLI NPM package (#3425 )

2019-03-05 12:49:42 -05:00

README.md

Cypress CLI source

This folder is used to build Cypress NPM module.

Building

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

Testing

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 ~/git/cypress/cli/build/cypress-3.1.5.tgz --ignore-scripts

Which installs the tgz file we have just built from folder ~/git/cypress/cli/build.