Interested in TypeScript definitions?

[wkillerud]

Hello!

I have begun making a TypeScript definition file in https://github.com/mrmlnc/vscode-scss/pull/156 for a proof of concept that uses sassdoc.parse to show docs in VS Code.

I would like to expand the type definition to cover the rest of SassDoc, and was wondering if you'd be interested in shipping TypeScript definitions with this package?

In practice it means:

• package.json will have a new types property pointing to the definition file
• the definition file is included in the published package via the files property
• any changes to the JavaScript API should ideally include an updated definition file going forward – I'll be happy to help maintain them

I can also publish a package through DefinetlyTyped if you'd rather not include it here. Co-location makes it easier to say in sync though.

[pascalduez]

Hello,

I see no objections for adding a definitions file and shipping it.
Basically we should wait for other maintainers validation.
Don't hesitate to ping use again if it takes too long.

[wkillerud]

Hey @pascalduez. Just checking in on this 😄

I've been working on improving the SassDoc integration on wkillerud/vscode-scss. I ended up building a library in TypeScript with just the parser to reduce the bundle size for the extension. sassdoc brings in the theme stuff, which was overkill for my needs.

That said, I'd still love to contribute type definitions for sassdoc and scss-comment-parser. I think I'm about 85%-90% there already on the branch feat/types linked below:

• wkillerud/sassdoc
• wkillerud/scss-comment-parser