Yeoman generator for PUBLIC Node packages from Cypress.io team
npm install -g yo generator-node-cypress
In a new project folder
git init
git remote add origin <remote git>
yo node-cypress
Answer a few questions and you should be all set.
- Targeted at public GitHub repos
- Default
.npmrcand.gitignorefiles - Git hooks and message validation using pre-git
- Linting and auto formatting using eslint and
prettier-eslint using
npm run lint - Showing open Git issues via
git-issues using
npm run issues - Unit testing with Mocha using
npm run unit - Packaged size reporting on pre-push hook using
npm run size - Running Node Security Project check on
pre-push - Checking if you are trying to commit
sensitive files
using
npm run ban - License check of production dependencies with
license-checker using
npm run license - Outdated, missing local and unused dependencies check with
deps-ok and
dependency-check
using
npm run depsandnpm run unused-deps - Semantic release setup using semantic-action
See npm run output for the full list of scripts.
Run the generator with environment variable DEBUG set to "gen"
DEBUG=gen yo node-cypress
This generator assumes there is already a remote Git (probably GitHub) repository where all code will live. Please create it first and then set it before running generator
git init
git remote add origin <remote git>
yo node-cypress
Author: Gleb Bahmutov Cypress.io © 2018
License: MIT - do anything with the code, but don't blame me if it does not work.
Spread the word: tweet, star on github, etc.
Support: if you find any problems with this module, email / tweet / open issue on Github
Copyright (c) 2018 Cypress.io
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.