Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bahmutov/cly
A prototype of Cypress CLI for quicker project scaffolding
https://github.com/bahmutov/cly
cli cypress cypress-io
Last synced: 8 days ago
JSON representation
A prototype of Cypress CLI for quicker project scaffolding
- Host: GitHub
- URL: https://github.com/bahmutov/cly
- Owner: bahmutov
- Created: 2019-02-01T02:06:14.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-27T18:46:06.000Z (3 months ago)
- Last Synced: 2024-10-03T14:14:36.455Z (3 months ago)
- Topics: cli, cypress, cypress-io
- Language: JavaScript
- Homepage:
- Size: 965 KB
- Stars: 34
- Watchers: 3
- Forks: 7
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# @bahmutov/cly [![gh status][gh image]][gh url]
> A prototype of Cypress CLI for quicker project scaffolding
[![NPM][npm-icon]][npm-url]
[![Build status][ci-image]][ci-url]
[![semantic-release][semantic-image]][semantic-url]
[![standard][standard-image]][standard-url]
[![renovate-app badge][renovate-badge]][renovate-app]
## Use
Requires [Node](https://nodejs.org/en/) version 8 or above with `npx` command, assumes you have installed Cypress already with `npm i -D cypress`
```sh
npx @bahmutov/cly init
```
Will output something like the following text on success
```sh
npx: installed 72 in 6.853s
scaffolding new Cypress project
✅ scaffolded "cypress" folder with a single example spec
you can configure additional options in cypress.json file
see https://on.cypress.io/configuration
```
Note: if there are Cypress files or folders already, the `cly` will stop.
Watch this utility in action in [this video](https://youtu.be/g9ToLSD_lbQ)
### TypeScript
You can scaffold Cypress specs written in TypeScript
```sh
npx @bahmutov/cly init --typescript
# or equivalent
npx @bahmutov/cly init -t
```
### Bare
Sometimes you just need a spec file, without any fixtures, support, or plugin files. Use `--bare` option to scaffold the minimal `cypress` test
```sh
npx @bahmutov/cly init --bare
# or equivalent
npx @bahmutov/cly init -b
```
### Version
You can specify version to scaffold using `--cv, --cypress-version ` argument. For example to scaffold for Cypress v4 run
```sh
npx @bahmutov/cly init --cv 4
```
Only the major version will be considered
```sh
npx @bahmutov/cly init --cypress-version 3.8.3
✅ scaffolded "cypress" folder with a single example spec (v3)
```
Notice that example folders for TypeScript have format `ts`.
## Debugging
Run this module with environment variable to see verbose logs
```
DEBUG=@bahmutov/cly
```
### Small print
Author: Gleb Bahmutov <[email protected]> © 2019
* [@bahmutov](https://twitter.com/bahmutov)
* [glebbahmutov.com](https://glebbahmutov.com)
* [blog](https://glebbahmutov.com/blog)
License: MIT - do anything with the code, but don't blame me if it does not work.
Support: if you find any problems with this module, email / tweet /
[open issue](https://github.com/bahmutov/cly/issues) on Github
## MIT License
Copyright (c) 2019 Gleb Bahmutov <[email protected]>
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
[npm-icon]: https://nodei.co/npm/@bahmutov/cly.svg?downloads=true
[npm-url]: https://npmjs.org/package/@bahmutov/cly
[ci-image]: https://circleci.com/gh/bahmutov/cly/tree/master.svg?style=svg
[ci-url]: https://circleci.com/gh/bahmutov/cly/tree/master
[semantic-image]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
[semantic-url]: https://github.com/semantic-release/semantic-release
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
[standard-url]: http://standardjs.com/
[renovate-badge]: https://img.shields.io/badge/renovate-app-blue.svg
[renovate-app]: https://renovateapp.com/
[gh image]: https://github.com/bahmutov/cly/workflows/ci/badge.svg?branch=master
[gh url]: https://github.com/bahmutov/cly/actions