Notice: If you have any propositions feel free to make an issue or create a pull request.
- Wallaby JS works out of the box without any additional config
Notice: How to run in "Without Configuration" mode (Official Wallaby JS Guide) - ESLint for linting JS & TS files (TSLint is deprecated in 2019). Basic rules configured.
- Very strict linting config (airbnb + unicorn + some other plugins)
- Unit Testing via Jest 27+
- Additional Jest matchers from
jest-extended
configured - TypeScript 4.3+ via Babel
- Yarn for packages installation and
check-yarn
utility to prevent packages installation vianpm
.nvmrc
- Nothing platform related. This repository template can be used for NodeJS and for Browser development.
- Git hooks via husky
- Utility to automatically pull updates from this template repository (
npm run tpl-repo:merge
)
-
Clone as is
git clone git@github.com:korniychuk/wallaby-ts-starter.git
cd wallaby-ts-starter
yarn
-
Fork
- Click Fork git button
git clone git@github.com:YOUR_GIT_NAME/wallaby-ts-starter.git
cd wallaby-ts-starter
yarn
-
Creating from template
-
Using with already cloned repository as an additional origin for pulling updates
-
Automatically
npm run merge-tpl-repo
-
Manually
git remote add template git@github.com:korniychuk/wallaby-ts-starter.git
git fetch template
git merge --allow-unrelated-histories template/master
-
-
Install NVM
-
Use
.nvmrc
file one of the next ways:- Execute
nvm use
in the project root directory - Install NVM Loader and your .nvmrc will be loaded automatically when you open the terminal.
- Execute
npm run build
- Just show problems
npm run lint
- Fix problems if it is possible
npm run lint:fix
-
All tests
npm run test
npm run test:watch
-
Specific tests
npm run test -- src/my.spec.ts
npm run test:watch -- src/my.spec.ts
Anton Korniychuk |
---|