Modern Wallaby JS Starter (TypeScript + Babel + Jest)

Notice: If you have any propositions feel free to make an issue or create a pull request.

Features

• 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 via npm
• .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)

Ways to use

1. Clone as is

   1. git clone [email protected]:korniychuk/wallaby-ts-starter.git
   2. cd wallaby-ts-starter
   3. yarn

2. Fork

   0. Click Fork git button
   1. git clone [email protected]:YOUR_GIT_NAME/wallaby-ts-starter.git
   2. cd wallaby-ts-starter
   3. yarn

3. Creating from template

   0. Click Fork git button
   1. Create new repository and specify template
   2. git clone [email protected]:YOUR_GIT_NAME/NEW_REPOSITORY_NAME.git
   3. cd NEW_REPOSITORY_NAME
   4. yarn

4. Using with already cloned repository as an additional origin for pulling updates

   1. Automatically

      npm run merge-tpl-repo

   2. Manually

      1. git remote add template [email protected]:korniychuk/wallaby-ts-starter.git
      2. git fetch template
      3. git merge --allow-unrelated-histories template/master

How to

How to use NodeJS version from the .nvmrc

1. Install NVM

2. 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.

How to make a build

npm run build

How to run lint

• Just show problems npm run lint
• Fix problems if it is possible npm run lint:fix

How to run tests

• 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

Author

Anton Korniychuk