Skip to content

build: add scripts to generate API document into README.md#28

Open
Atry wants to merge 6 commits intoryansonshine:mainfrom
Atry:typedoc
Open

build: add scripts to generate API document into README.md#28
Atry wants to merge 6 commits intoryansonshine:mainfrom
Atry:typedoc

Conversation

@Atry
Copy link
Copy Markdown
Contributor

@Atry Atry commented Jan 16, 2023

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/57052392

Pull-Request Checklist

  • Code is up-to-date with the main branch
  • npm run lint passes with this change
  • npm run test passes with this change
  • This pull request links relevant issues as Fixes #0000
  • There are new or updated unit tests validating the change
  • Documentation has been updated to reflect this change
  • The new commits follow conventions outlined in the conventional commit spec

Fixes #26

@codecov
Copy link
Copy Markdown

codecov Bot commented Jan 16, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (4fe79a6) to head (d142d54).
Report is 5 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

Comment thread src/index.ts Outdated
Comment thread typedoc.json Outdated
Comment thread package.json Outdated
Comment thread package.json
"typedoc:watch": "typedoc --watch",
"test:watch": "jest --watch",
"test": "jest --coverage",
"watch": "npm-run-all --race --parallel *:watch",
Copy link
Copy Markdown

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?

Atry and others added 3 commits March 12, 2025 20:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Generating API document

2 participants