Add a .d.ts file…#9
Draft
savetheclocktower wants to merge 6 commits into
Draft
Conversation
…and some tests to ensure the `.d.ts` document everything in the `Repository` interface (and nothing that isn't there).
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
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.
…and some tests to ensure the
.d.tsdocument everything in theRepositoryinterface (and nothing that isn't there).This one builds on #8 and thus will stay in draft until that PR lands.
I was looking for ways to add inline documentation for this module. Ordinarily I'd prefer to write JSDoc comments and then use tooling to generate a
.d.tsfrom that… butgit-utilsdefines some methods in JS and some methods in the native C++ bindings. Hence there's no place to hang a JSDoc comment for about half the methods.Instead, I've hand-authored a
.d.tsfile. To ensure that the definitions are in sync with what actually exists in the repo, there's a newspec/api-surface-spec.jssuite that inspects the.d.tsand theRepositoryclass and ensures they agree.