wikimedia/typescript-types

TypeScript definitions for the Wikimedia Universe

typescript-types's Issues

Add linter to ensure MediaWiki.d.ts is always valid

I noticed #13 - we shouldn't need to have such fix commits because ideally there would be tests that validate the typescript for each patch. I don't know how such tests are added in github though

[Question] How do I handle types of other extensions?

Hi, If this is not a suitable place for questions, feel free to close this issue.
As a skin developer, I have called to some variables defined in extensions like below without @wikimedia/types-wikimedia.

code:

/** @type {EchoApi} */ var echoApi = new mw.echo.api.EchoApi();

.d.ts:

interface EchoApi {}
interface MediaWiki {
  echo: {
    api: {
      EchoApi: {
        new (): EchoApi;
      };
    };
  };
}

declare const mw: MediaWiki;

And I want to replace it with the library but I don't know how to. I think I have two options:

• Adding definitions for extensions to this repository.
• Extending types-wikimedia in my own skin.

About the second option, I couldn't find the syntax to extend global mw. (It may be because I am not familiar with TypeScript.)
What should I do?

Regards.

Doesn't support mw.util.addPortletLink

Raised in https://gerrit.wikimedia.org/r/c/mediawiki/skins/Vector/+/894766

Fix issues raised by linter

To make CI pass we had to downgrade some errors to warnings.

{
	"@typescript-eslint/ban-types": "warn",
	"@typescript-eslint/no-empty-interface": "warn",
	"@typescript-eslint/no-misused-new": "warn",
	"@typescript-eslint/triple-slash-reference": "warn"
}

Thes should probably be fixed.

Release 0.2.0

This is a reminder to release a new version of the library.
@DannyS712 is there any date we should work towards or anything you need for the next release for GlobalWatchlist ?