Type definitions

[uetchy]

Summary

Fixes #47

Added .d.ts file to each package.

• remark-math
• rehype-katex
• rehype-mathjax
• remark-html-katex

Discussion

• Should options have index signature [index: string]: unknown as unified.Settings did?
  • pros: can pass additional options like {position: boolean}
    • another way to deal with it is to explicitly add {position: boolean} to the definition files.
    • or just let users add .use({settings: {position: false}}) to the end of the chain.
  • cons: it will disable key missing errors that help users noticing a typo.

[ChristianMurphy]

Thanks @uetchy!
Could you add dtslint type tests? (see remarkjs/remark-rehype#13, or any of the other typing PRs for an example)

[ChristianMurphy]

remark/unified generally doesn't use peerDependencies, they can cause trouble.
Generally dependencies or devDependencies are used.

[uetchy]

ok. I'll move it to dependencies.

[wooorm]

Sorry, I want to reopen this!

While I think including a package for types is fine (e.g., types/hast, vfile). I don’t think we should do it for unified. I think it should be removed from dependencies, and a note added in the readme that they should be installed (although: plugins don’t make sense w/o unified, so they probably always are installed).

[uetchy]

@ChristianMurphy I think all issues you mentioned are resolved now.

[ChristianMurphy]

Thanks @uetchy !
Would it be possible to add some simple type tests for dtslint?
Something simple like:

unified().use(rehypeKatex);
unified().use(rehypeKatex, {output: 'html'});

// $ExpectError
unified().use(rehypeKatex, {noteARealOption: true});

for each typing

[ChristianMurphy]

Should options have index signature [index: string]: unknown as unified.Settings did?

Generally that is used when settings are generic.
In unified the index signature is a fallback if a package doesn't define it's own settings.
In this case, concrete settings would be preferred, listing out each attribute an its type.

[uetchy]

Would it be possible to add some simple type tests for dtslint?
[omit]
for each typing

@ChristianMurphy Added type test for each package!

[wooorm]

Sorry, I want to reopen this!

While I think including a package for types is fine (e.g., types/hast, vfile). I don’t think we should do it for unified. I think it should be removed from dependencies, and a note added in the readme that they should be installed (although: plugins don’t make sense w/o unified, so they probably always are installed).

[pd4d10]

Any news?

[wooorm]

The changes generally look good, but I’m not a fan of the changes to the ordering of package.json props. Could you revert those?

[wooorm]

B-E-A-UTIFUL!

[wooorm]

Thanks @uetchy, released!!! ✨