-
Notifications
You must be signed in to change notification settings - Fork 41
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
build: add scripts to generate API document into README.md #28
base: main
Are you sure you want to change the base?
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #28 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 1 1
Lines 1 1
Branches 1 1
=========================================
Hits 1 1 ☔ View full report in Codecov by Sentry. |
"test:watch": "jest --watch", | ||
"test": "jest --coverage", | ||
"watch": "npm-run-all --race --parallel *:watch", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This seems to be the "main" command, right?
Co-authored-by: 34j <[email protected]>
Co-authored-by: 34j <[email protected]>
Co-authored-by: 34j <[email protected]>
Description of change
Added
npm run watch
to continuously build, test and generate API docs. The approach is described at https://stackoverflow.com/questions/56918621/is-it-possible-to-generate-single-page-doc-html-with-typedoc-for-typescript-proj/57052392Pull-Request Checklist
main
branchnpm run lint
passes with this changenpm run test
passes with this changeFixes #0000
Fixes #26