types: add JSDoc based TypeScript typings

transitive-bullshit / check-links

Robustly checks an array of URLs for liveness. Extremely fast ⚡

MIT License

334 stars 10 forks source link

types: add JSDoc based TypeScript typings #23

Closed ChristianMurphy closed 1 year ago

ChristianMurphy commented 1 year ago

Changes:

Uses JSDoc comments to generate TypeScript typings
Fixes usage of http.Agent() removing unsupported options (detected by typescript)
Fixes usage of pMemoize which has replaced maxAge option, with using ExpiryMap as the cache option (detected by typescript)

Goals:

Keep changes to existing code to minimum needed, while also achieving: 100% type coverage and passing type checks
Use plain JavaScript, so code from GitHub can be used directly, without needing to compile. Typings can be generated for TypeScript/npm publishing, but are optional

ChristianMurphy commented 1 year ago

Friendly ping @transitive-bullshit 🔔 Any thoughts on this PR or the approach as a whole?

transitive-bullshit commented 1 year ago

Friendly ping @transitive-bullshit 🔔

Thanks & for sure. Sometimes I'm all over the place and friendly pings are always appreciated 😃

Any thoughts on this PR or the approach as a whole?

It looks great. The next step would be to move to TS, but this is a perfect stopgap.

transitive-bullshit commented 1 year ago

Published as v2.1.0

ChristianMurphy commented 1 year ago

Published as v2.1.0

Thanks! Did the build script get run during the publish? (I think npm does, not sure if pnpm does also) And if so did it pass locally as it did on CI? The build shows the updates to the .js files, but doesn't seem to include the .d.ts files.

transitive-bullshit commented 1 year ago

Hmmm weird; yes, it passes tests locally. I just re-ran build and published v2.1.1

ChristianMurphy commented 1 year ago

Hmm, still missing the types https://unpkg.com/browse/check-links@2.1.1/lib/. It might be the ignore causing issues, https://github.com/transitive-bullshit/check-links/pull/24 may help