search

zestedesavoir / zmarkdown

Live demo: https://zestedesavoir.github.io/zmarkdown/
MIT License
226 stars 53 forks source link

remark-abbr: TypeScript type definitions #419

Closed LukeCarrier closed 3 years ago

LukeCarrier commented 4 years ago

This PR is a follow on from the query in https://github.com/zestedesavoir/zmarkdown/issues/384#issuecomment-706429418

I've added TypeScript definitions (ambient modules) for the remark-abbr module, and ensured that they're published as part of npm pack.

I wasn't quite sure how best to test the definitions as part of your dev/test workflow, but I've included a configuration for dtslint which runs as part of test. Feedback welcome!

StaloneLab commented 4 years ago

I hadn't look at it in depth yet, but I was expecting these to go in the DefinitelyTyped repository instead of this repository. I mentioned it in my reply on your comment, but maybe didn't made it clear. Do you think there's a need to have them inside this repo instead of using DefinitelyTyped?

Anyway, thanks for having taken time to write the typings.

LukeCarrier commented 4 years ago

It was easier to get them working here, as to get them into DefinitelyTyped we'd to get a couple of dependencies (remark-abbr and unified) whitelisted in their linting tool, as by default only packages in DT itself are available.

I'm happy to move them into DT if you prefer; sorry for glossing over that point.

StaloneLab commented 4 years ago

If that's not a problem for you, I'd prefer them in the DefinitelyTyped reporistory. Don't know what would work better: should I review the typings here, so that you can put them directly on DT, or you can mention me in your PR on their side to get a review.

Anyway, I'll keep this PR opened to keep track of it, and close it when typings are merged into DT.

LukeCarrier commented 4 years ago

I'll link the PRs in DT once they're open 🙂

LukeCarrier commented 4 years ago

I've raised the two PRs:

StaloneLab commented 3 years ago

I see the two PRs have been merged. Is everything fine or do we need to do something here?

LukeCarrier commented 3 years ago

No action necessary 😃

StaloneLab commented 3 years ago

Thanks once more for the work done!