TypeScript definitions for PluginContext are Incorrect

[wangweixuan]

• Rollup Version: 1.16.3
• Operating System (or Browser): not concerned
• Node Version: not concerned

How Do We Reproduce?

I want to write a plugin in TypeScript, for example:

import { PluginImpl } from 'rollup'

export const myPlugin: PluginImpl<{ }> = () => {
  return {
    name: 'my-plugin',

    transform(code, id) {
      this.error('There is something wrong.', 42) // Here
      return undefined
    }
  }
}

Expected Behavior

The code compiles and runs. The plugin reports an error at the 42^nd character position in any file.

Actual Behavior

The code won't compile. TypeScript complains that Argument of type '42' is not assignable to parameter of type '{ column: number; line: number; }'.

What's Wrong

In Rollup's type definition file:

rollup/src/rollup/types.d.ts

Line 125 in 1739459

error: (err: RollupError | string, pos?: { column: number; line: number }) => never;

rollup/src/rollup/types.d.ts

Line 149 in 1739459

warn: (warning: RollupWarning | string, pos?: { column: number; line: number }) => void;

While in the document:
https://github.com/rollup/rollup/blob/master/docs/05-plugin-development.md#thiserrorerror-string--error-position-number--void

this.error(error: string | Error, position?: number) => void

https://github.com/rollup/rollup/blob/master/docs/05-plugin-development.md#thiswarnwarning-string--rollupwarning-position-number-

this.warn(warning: string | RollupWarning, position?: number)

[lukastaegert]

Thanks for spotting this! As a matter of fact, both should work—at least there are tests for them. I will have a look at definitions and docs.

[lukastaegert]

Fix at #2975