Skip to content
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

chore: re-enable doc-check for Typescript snippets #2250

Merged
merged 15 commits into from
Jan 31, 2024

Conversation

maschad
Copy link
Member

@maschad maschad commented Nov 21, 2023

Title

chore: enable typescript docs verification for example snippets

Description

This had been disabled leading to some erroneous Typescript snippets in the examples

Notes & open questions

Change checklist

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation if necessary (this includes comments as well)
  • I have added tests that prove my fix is effective or that my feature works

@maschad maschad requested a review from a team as a code owner November 21, 2023 03:05
@@ -19,6 +19,7 @@
"sourceType": "module"
}
},
"exports": {},
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a hack for now given that typescript docs verifier relies on the exports for its check

@maschad maschad changed the title chore: re-enable doc-check chore: re-enable doc-check for Typescript snippets Nov 21, 2023
doc/METRICS.md Outdated Show resolved Hide resolved
Copy link
Member

@achingbrain achingbrain left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are some good doc improvements in here so I'd like to merge this but where is the bit of the PR that re-enables doc-check for TypeScript snippets like the title says?

@maschad
Copy link
Member Author

maschad commented Nov 28, 2023

Strange, I had assumed CI was running the command and that the actual doc-check command was a no-op, which is what this PR addressed. Turns out the CI was also a no-op as well, so I pushed a commit to fix in de72f20.

It also turns out a recent typescript upgrade broke ts-node which typescript-docs-verifier depends on so I am using a fixed Typescript version until that gets resolved and the ts-node fix should bubble upstream.

doc/package.json Outdated Show resolved Hide resolved
@achingbrain achingbrain merged commit e1db332 into libp2p:main Jan 31, 2024
22 checks passed
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.

3 participants