Setup API Extractor and documenter #144
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pbricout
force-pushed
the
setup-api-extractor
branch
4 times, most recently
from
622bc6f to
49c1ab0
Compare
pbricout
force-pushed
the
setup-api-extractor
branch
from
49c1ab0 to
359c3e0
Compare
Anything in these files should be exported, let's simplify. API Extractor examples look like this.
Change the identation to 4. Reformat using `reformat` in VSCode. This will make review easier.
Initialisation steps: - `npx api-extractor init` to generate the initial configuration - `mkdir config` (following recommended practices) - `mv api-extractor.json config/api-extractor.jsonc` Output folder `etc` will produce the report it is recommended to keep this report to track and review API differences. Output folder `doc` will contain the API documentation in markdown format. Change build folder from `dist` to `lib` which is the api-extractor default (so following api-extractor recommended). See: https://api-extractor.com/ https://api-extractor.com/pages/setup/generating_docs/
- add some TSDoc public tags
This will allow to better re-use the types.
- use `npm run build-all`
pbricout
force-pushed
the
setup-api-extractor
branch
from
359c3e0 to
d420664
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Can be reviewed commit by commit, each commit contains a message with details.
Unfortunately, it seems the API-extractor/API-documenter, does not deal well with callable interfaces and types and especially the ones with overloads. I could find an easy to document the overloads. Currently the documentation for each overload of the ReadCallback is ignored.
Summary of the commit messages:
Simplify index exports
Anything in these files should be exported, let's simplify.
API Extractor examples look like this.
Reformat tsconfig.json
Change the identation to 4.
Reformat using
reformatin VSCode.This will make review easier.
Setup API Extractor and API Documenter
Initialisation steps:
npx api-extractor initto generate the initial configurationmkdir config(following recommended practices)mv api-extractor.json config/api-extractor.jsoncOutput folder
etcwill produce the report it is recommendedto keep this report to track and review API differences.
Output folder
docwill contain the API documentation inmarkdown format.
Change build folder from
disttolibwhich is the api-extractordefault (so following api-extractor recommended).
See:
https://api-extractor.com/
https://api-extractor.com/pages/setup/generating_docs/
Configure API extractor
Add TSDoc public tags
Update package.json
Add more API documentation