search

szwacz / fs-jetpack

Better file system API for Node.js
MIT License
777 stars 41 forks source link

Update TypeScript definitions #83

Closed orta closed 5 years ago

orta commented 5 years ago

Makes it so you don't have to leave your editor to read the docs ❤️

papb commented 5 years ago

This is a great idea! However I have one question: this duplicates the documentation in README.md and types.d.ts. Do you have any idea on how to prevent them getting out of sync?

orta commented 5 years ago

Do you have any idea on how to prevent them getting out of sync?

It's been 9 months since the README got an update, I figured it's fine given the state of the maturity of the lib. Otherwise you could use something like danger to automate ensuring they're in sync

papb commented 5 years ago

@orta Makes sense, thanks!

szwacz commented 5 years ago

Released as v 2.2.3, I also think the duplication of docs won't be that big of an issue. Thanks!

papb commented 5 years ago

@szwacz You released on npm, but it looks like you forgot to create the github release?

szwacz commented 5 years ago

There you have it @papb :)