Add missing overloads

[NicoFraenzel]

Initial checklist

• I read the support docs
• I read the contributing guide
• I agree to follow the code of conduct
• I searched issues and discussions and couldn’t find anything or linked relevant results below
• I made sure the docs are up to date
• I included tests (or that’s not needed)

Description of changes

This PR adds two more overloads to the remarkRetext function to fix the TypeScript type definitions (see issue #18). One without any parameters and another with a common signature (as the compiler doesn't generate one without the @overload tag).

New overloads:

/**
 * ...
 *
 * @overload
 * @returns {TransformMutate}
 *
 * ...
 *
 * @overload
 * @param {Parser | Processor} [destination]
 *   Parser or processor (required).
 * @param {Options | null | undefined} [options]
 *   Configuration (optional).
 * @returns {TransformBridge | TransformMutate}
 *   Transform.
 *
 * ...
 */

Resulting type definitions:

export default function remarkRetext(): TransformMutate;
export default function remarkRetext(processor: Processor, options?: Options | null | undefined): TransformBridge;
export default function remarkRetext(parser: Parser, options?: Options | null | undefined): TransformMutate;
export default function remarkRetext(destination?: import("unified").Processor<import("nlcst").Root, undefined, undefined, undefined, undefined> | Parser | undefined, options?: Options | null | undefined): TransformBridge | TransformMutate;

This removes the need for @ts-expect-error in test.js and dependent projects.

[codecov]

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

Thanks for integrating Codecov - We've got you covered ☂️

[JounQin]

LGTM

[NicoFraenzel]

Sorry, my bad. Got confused there for a moment. New type definitions:

export default function remarkRetext(processor: Processor, options?: Options | null | undefined): TransformBridge;
export default function remarkRetext(parser: Parser, options?: Options | null | undefined): TransformMutate;
export default function remarkRetext(destination: Parser | Processor, options?: Options | null | undefined): TransformBridge | TransformMutate;

[wooorm]

I was applying this patch in rehype-remark, and confirmed:

const x = rehypeRemark(unified())
const y = rehypeRemark()
const p = Math.random() > 0.5 ? unified() : undefined
const z = rehypeRemark(p)

Before:

x: TransformBridge
y: TransformMutate
z: TransformBridge & TransformMutate // Note sure *why* TS decides this, but this is the problematic part

After:

x: TransformBridge
y: TransformMutate
z: TransformBridge | TransformMutate // Good

[wooorm]

thanks, released in 6.0.1!