docs: improve documentation and fix typos across the project#246
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #246 +/- ##
==========================================
+ Coverage 89.40% 93.73% +4.33%
==========================================
Files 5 10 +5
Lines 434 447 +13
Branches 37 93 +56
==========================================
+ Hits 388 419 +31
+ Misses 46 28 -18 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
Woohoo! This should be it. Need to think how to name this PR and we're good to go |
| ```js | ||
| import { resolveFile } from "pkg-types"; | ||
| const filename = await resolveFile("README.md", { | ||
| import { findFile } from "pkg-types"; | ||
| const filename = await findFile("README.md", { | ||
| startingFrom: id, | ||
| rootPattern: /^node_modules$/, | ||
| matcher: (filename) => filename.endsWith(".md"), | ||
| test: (filename) => filename.endsWith(".md"), | ||
| }); |
There was a problem hiding this comment.
Couldn't find any references for resolveFile in git history. Still checking
There was a problem hiding this comment.
Running git log --all --full-history -S "resolveFile" -p shows that resolveFile never existed in the codebase since October 2021. Probably was existing before that, but I'm lazy to use manual search via GitHub 🙈
There was a problem hiding this comment.
Yep. Probably was a leftover from some experiments with API design in the past
safe to review now, don't merge until non draft plz, just checking for typos/extra spaces in other files to possibly cover with this pr.resolves #245 & related to #238