test-stg

Description

test-stg is good option if You want to run jest unit tests only to staged js, ts, jsx, tsx files

Content table

• Install
• Features
• Use
• Contribute
• License

Install

1npm i -D test-stg

note: you must have jest installed

Features

test-stg assumes that your proyect has one of the next structures

Structure A

1--src
2    |__components
3    |   |__tests
4    |   |   |_app.test.js
5    |   |_app.js
6    |
7    |__pages
8        |__tests
9        |   |_home.test.jsx
10        |_home.jsx

or

Structure B

1--src
2    |__components
3    |   |_app.js
4    |
5    |__pages
6    |   |_home.jsx
7    |
8    |__tests
9        |__componets
10        |   |_app.test.js
11        |__pages
12            |_home.test.jsx

test-stg command accept two params, the first one to set build pattern 1 for Structure A and 2 for Structure B default value is 1. The second param is the name used for test folder and extention file eg test, tests, expect, etc. default value is 'test'

Use

Just run test-stg command to run unit tests

1npx test-stg 1 tests

It is a good idea to use test-stg with husky and lint-staged to automate testing process

1{
2    "*.{js,jsx,tsx,ts}": [
3            'prettier --write',
4            'eslint --fix',
5            'test-stg 1 tests',
6        ],
7    "*.{md,yml,css}": ['prettier --write'],
8}

Contribute

Contributions are always welcome

License

This proyect uses MIT license.