fix: Updated doc-check to generate config + format errors #1255
Conversation
There was a problem hiding this comment.
A couple of nits, comments inline.
Can you add a test or two please - they don't have to be complicated, just something that ensures we don't break this feature in future.
See the dep-check tests as an example - there are known good and known bad projects in the fixtures folder, the tests run the command over the sample projects and assert that it succeeded or failed.
|
Strange CI failure as all these tests pass on my local env 🤔 |
|
It seems that the underlying library i.e. https://github.com/bbc/typescript-docs-verifier does not properly compile snippets on Windows due to path resolution methods. I raised an issue. In the interim we could consider ignoring the tests on windows since this particular tool is less likely to run on that OS. |
|
If Windows fails the doc-check, instead of skipping the the doc-check tests the command itself should end early on Windows and print a message - for example see how coverage is skipped at the moment, though it'd be better if it printed the relevant GH issue too, #1195 in this case. Otherwise we could ship this, then someone who happens to do their dev on windows will find |
maschad
force-pushed
the
feat/add-ts-config-docs-verifier
branch
from
429165b to
e15497e
Compare
achingbrain
changed the title
## [39.0.9](v39.0.8...v39.0.9) (2023-05-26) ### Bug Fixes * Updated doc-check to generate config + format errors ([#1255](#1255)) ([c97f9bf](c97f9bf))
|
🎉 This PR is included in version 39.0.9 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Closes #1273
Related: libp2p/js-libp2p#1505