3rd overload signature of FrozenProcessor.run should accept ParseTree instead of CompileTree

[alvinleung1996]

Initial checklist

• I read the support docs
• I read the contributing guide
• I agree to follow the code of conduct
• I searched issues and couldn’t find anything (or linked relevant results below)

Affected packages and versions

unified 10.1.0

Link to runnable example

No response

Steps to reproduce

The 3rd overload signature of FrozenProcessor.run is incorrect.

unified/index.d.ts

Lines 307 to 321 in c3ba2cd

	/**
	* Run transforms on the given node.
	*
	* @param node
	* Tree to transform.
	* @param file
	* File associated with `node`.
	* `VFile` or anything that can be given to `new VFile()`.
	* @returns
	* Promise that resolves to the resulting tree.
	*/
	run(
	node: Specific<Node, CompileTree>,
	file?: VFileCompatible | undefined
	): Promise<Specific<Node, CompileTree>>

Expected behavior

run(
    node: Specific<Node, ParseTree>,
    file?: VFileCompatible | undefined
): Promise<Specific<Node, CompileTree>>

Actual behavior

run(
    node: Specific<Node, CompileTree>,
    file?: VFileCompatible | undefined
): Promise<Specific<Node, CompileTree>>

Runtime

Node v16

Package manager

Other (please specify in steps to reproduce)

OS

Linux

Build and bundle tools

Webpack

[wooorm]

Why? ParseTree is the input tree. CompileTree is the output tree.

[ChristianMurphy]

I'd second the why question.
@alvinleung1996 do you have an example where an input or output which should be supported, is not supported?

[alvinleung1996]

Why? ParseTree is the input tree. CompileTree is the output tree.

For the first and second overload, ParseTree is the input tree and CompileTree is the output tree. But for the third one, CompileTree is the input tree and CompileTree is the output tree, which is inconsistent with the first two overloads and is incorrect.

unified/index.d.ts

Lines 273 to 321 in c3ba2cd

	/**
	* Run transforms on the given tree.
	*
	* @param node
	* Tree to transform.
	* @param callback
	* Callback called with an error or the resulting node.
	* @returns
	* Nothing.
	*/
	run(
	node: Specific<Node, ParseTree>,
	callback: RunCallback<Specific<Node, CompileTree>>
	): void
	/**
	* Run transforms on the given node.
	*
	* @param node
	* Tree to transform.
	* @param file
	* File associated with `node`.
	* `VFile` or anything that can be given to `new VFile()`.
	* @param callback
	* Callback called with an error or the resulting node.
	* @returns
	* Nothing.
	*/
	run(
	node: Specific<Node, ParseTree>,
	file: VFileCompatible | undefined,
	callback: RunCallback<Specific<Node, CompileTree>>
	): void
	/**
	* Run transforms on the given node.
	*
	* @param node
	* Tree to transform.
	* @param file
	* File associated with `node`.
	* `VFile` or anything that can be given to `new VFile()`.
	* @returns
	* Promise that resolves to the resulting tree.
	*/
	run(
	node: Specific<Node, CompileTree>,
	file?: VFileCompatible | undefined
	): Promise<Specific<Node, CompileTree>>

[wooorm]

Ah, I misunderstood. Thanks for clarifying!
I think you’re right. Care to create a pull request solving it?

[alvinleung1996]

Ah, I misunderstood. Thanks for clarifying! I think you’re right. Care to create a pull request solving it?

OK, I will create a pull request for it.