feat: add type coverage (starknet-io#1120)

irisdv · May 6, 2024 · eceda5d · eceda5d
1 parent 933220a
commit eceda5d
Show file tree

Hide file tree

Showing 11 changed files with 523 additions and 58 deletions.
diff --git a/.gitignore b/.gitignore
@@ -6,6 +6,7 @@
 .vscode
 .idea
 coverage
+coverage-ts
 dist
 node_modules
 npm-debug.log

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -103,6 +103,7 @@ For major changes that markedly transform the existing API or significantly alte
 - We’re using [Prettier](https://github.com/prettier/prettier) to format code, so don’t worry much about code formatting.
 - Don’t commit generated files, like minified JavaScript.
 - Don’t change the version number or changelog.
+- Use `npm run ts:coverage` to check the global type coverage rate and `npm run ts:coverage:report` to generate a complete report (summary displayed in the console, full HTML report available in the `coverage-ts` folder by launching `./coverage-ts/index.html` in your browser) and find files having low coverage.
 
 ## Need help?