Set up API Extractor for generating API documentation #290
Conversation
This file contains 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
* master: Pull property registration out of exported namespaces
kasperisager
added
the
internal
* master: Correct test case title Add additional examples and include link in README Move shortlinks to bottom Correct workflow link Add initial docs on managing releases Add crawler example to README
* master: (477 commits) Add @siteimprove/alfa-selective package (#702) Implement `Hashable` for `Either<L, R>` Bump typescript from 4.1.3 to 4.1.4 (#701) Add @siteimprove/alfa-network package (#696) Rework @siteimprove/alfa-trilean package (#695) Add @siteimprove/alfa-sarif package (#694) Support `font` shorthand property (#693) Update changelog Add additional `Array` functions Bump highlight.js from 10.5.0 to 10.6.0 (#697) Add additional `Sequence` test case Remove unneeded test Clean up R69 tests Refactor JSON internals Adjust `Emitter<T>` and add tests Add additional JSON props to ARIA types Add some missing package references Formatting Housekeeping Swap some uses of `Ok.of()` for `Result.of()` ...
* master: (75 commits) Rework audit interviewers for CLI (#699) Rework `Hash` as an abstract class (#670) `NODE_AUTH_TOKEN` -> `GITHUB_TOKEN` Use `NODE_AUTH_TOKEN` for registry authentication v0.11.0 Add scripts for handling release tasks Update release workflow Update lockfile Upgrade to Yarn `master` Add version ranges to workspace references Add missing plugin Use `workspace:` protocol for local package references Remove Lerna and disable publish Revert "v0.11.0" Add missing release heading v0.11.0 Update changelog Additional allocation reductions Allow self-referencing `aria-labelledby` Bump actions/setup-node from v2.1.4 to v2.1.5 (#721) ...
|
The need for landing this is ever increasing as reiterated on a call I joined today with a prospect. I have added some additional issues to the list of blockers and so I'm afraid it's headed somewhat in the wrong direction 😞 |
* master: Switch to ES2018, take two Update to TypeScript 4.2
* main: Unbranch ARIA types (#729) Update change log Track ARIA editors draft (#728) Update workflows Shuffle around some change logs v0.12.0 Prepare release Normalize computed accessible names in SIA-R41 and SIA-R81 Make `Text#toString()` a little better Simplify empty `role` check Don't overwrite the source of inherited property values Accept spaces around CSS variable names in `var()` functions (#725) Deal with accessible names that are only whitespace Rework media query and handle media ranges (#722)
* main: Mark all public APIs
* main: Update lockfile
|
A patch for the last blocker is hopefully coming soon: microsoft/rushstack#1916 |
* main: Pin CodeQL action version Implement SIA-R78 (#854)
* main: Add missing release tags
* main: Write out some inferred types for documentation purposes
* main: Add missing export
|
Landing this now that everything is green and then we'll deal with the outstanding issues as patches are made available. I've still got some changes to make to the API overview, which I want to get done today. |
This was referenced Mar 8, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This pull request sets up API Extractor for generating API documentation as Markdown files. API Extractor was chosen as it seemed the most mature and feature-complete of the options available as outlined in #135. Additionally, it's backed by @microsoft and used for large projects such as the SharePoint Framework (https://docs.microsoft.com/en-us/javascript/api/sp-core-library).
In addition to generating API documentation, API Extractor also generates API report files that extract and track the public API surface exposed across packages: https://github.com/Siteimprove/alfa/blob/api-extractor/docs/review/api. During CI, API Extractor can then fail the build if the public API changes.
There are still some outstanding issues in API Extractor that we need resolutions to before this pull request can advance:
Closes #135.