Skip to content

Commit

Permalink
docs(readme): add desc for test and coverage section
Browse files Browse the repository at this point in the history
  • Loading branch information
mohammadGh committed Feb 28, 2024
1 parent ed88519 commit 48a4e17
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,26 @@ we use `Commitizen` for conventional commits. `husky` is used to enforce convent
## Test & Test Coverage
`Vitest` is used for running tests and measure test coverage.

`coverage-v8` is used to obtain coverage metrics.

The test and coverage config file is `vitest.config.ts`. for example to exclude config files in the root of project from coverage analysis, we config `vitest.config.ts` like follow:

```js
import { configDefaults, defineConfig } from 'vitest/config'

export default defineConfig({
test: {
coverage: {
exclude: [
...configDefaults.exclude,
'*.config.js',
'*.config.ts',
],
},
},
})
```

## Release-it for Releasing
We use `release-it` for version management and publish to anywhere (npm or github). We also use its hooks to execute any command we need to test, build, and publish our project.

Expand Down

0 comments on commit 48a4e17

Please sign in to comment.