orta / playground-dt-review

A plugin for reviewing DT modules in the Playground

DT Pull Request Reviewer Plugin

This is a plugin for the TypeScript Playground which makes it easier to review Pull Requests to DefinitelyTyped.

This plugin will install the new version of the types from the PR into the playground, giving you the chance to import them and decide if it acts like you think it does.

Running this plugin

• Click this link to install

or

• Open up the TypeScript Playground
• Go the "Plugins" in the sidebar
• Look for "Plugins from npm"
• Add "playground-dt-review"
• Reload the browser

Then it will show up as a tab in the sidebar.

Contributing

See CONTRIBUTING.md for the full details, however, TLDR:

git clone https://github.com/orta/playground-dt-review.git
cd playground-dt-review
yarn install
yarn start

Then tick the box for starting plugin development inside the TypeScript Playground.

playground-dt-review's Issues

Definitions from a PR are not actually injected correctly

Since this commit to TypeScript website addLibraryToRuntime() automatically prepends file:// to the path

So the Dt Review plugin is currently injecting invalid paths because it passes the complete URL to addLibraryToRuntime(), which results in the Playground loading the current release definitions instead of the proposed PR definitions

I already wrote a fix, will send a PR soon

Recursion bomb

Link in DefinitelyTyped/DefinitelyTyped#55847 keeps downloading files

Lodash empty export

Hello, I found a problem with using this plugin on my PR to DefinitelyTyped/lodash. When trying to import debounce function from lodash I'm getting an error: Module '"lodash"' has no exported member 'debounce'.

Check out this example: https://www.typescriptlang.org/play?&dtPR=56299&install-plugin=playground-dt-review#code/JYWwDg9gTgLgBAbzgEwKYCMIFcB2BjVOAXzgDMoIQ4ByAGwmQEMBnAC2oG4AoIA

Without plugin: https://www.typescriptlang.org/play?&install-plugin=playground-dt-review#code/JYWwDg9gTgLgBAbzgEwKYCMIFcB2BjVOAXzgDMoIQ4ByAGwmQEMBnAC2oG4AoIA