Help Wanted: TypeScript Conversion Update

Hello PixiJS Community,

We have reach a major milestone in converting PixiJS to TypeScript by converting core and all it dependencies. Now that we are over this hump, we can start on the rest of the packages that dependency on this small set of core packages.

We could definitely use a hand from devs to convert the rest of these packages. If you are interested in converting a package, please let me know which one. There are a few guidelines for converting packages, which you can see from the existing completed PRs.

Converting Gotchyas

We are trying to maintain the JSDocs until everything is completed, and then convert to Typedoc and emit types afterwards. We ask that you maintain JSDocs and make sure that they still build and show up correctly via npm run docs
Please use git mv to rename JS files to TS, or else we lose the Git history. Some Git GUIs may not pick up these changes.
Please do not add public access modifiers to internal-only methods or members, leave access undefined in these cases.

Packages

To Claim a package, please create Draft PR for it

@pixi/accessibility #6379
@pixi/app #6376
@pixi/constants #6173
@pixi/core #6340, #6373
@pixi/display #6261, #6339, #6349, #6371
@pixi/extract #6381
@pixi/graphics #6352
@pixi/interaction #6656
@pixi/loaders #6385
@pixi/math #6141
@pixi/mesh-extras #6396
@pixi/mesh #6382
@pixi/mixin-cache-as-bitmap #6630
@pixi/mixin-get-child-by-name #6621
@pixi/mixin-get-global-position #6637
@pixi/particles #6449
@pixi/polyfill #6654, #6669
@pixi/prepare #6481
@pixi/runner #6164
@pixi/settings #6315
@pixi/sprite-animated #6397
@pixi/sprite-tiling#6398
@pixi/sprite #6375
@pixi/spritesheet #6389
@pixi/text-bitmap #6479
@pixi/text #6390
@pixi/ticker #6186
@pixi/unsafe-eval #6655
@pixi/utils #6262
@pixi/canvas-display #6659
@pixi/canvas-extract #6503
@pixi/canvas-graphics #6663
@pixi/canvas-mesh #6664
@pixi/canvas-particles #6622
@pixi/canvas-prepare #6657
@pixi/canvas-renderer #6499
@pixi/canvas-sprite-tiling #6665
@pixi/canvas-sprite #6658
@pixi/canvas-text #6666
@pixi/filter-alpha #6383
@pixi/filter-blur #6383
@pixi/filter-color-matrix #6383
@pixi/filter-displacement #6383
@pixi/filter-fxaa #6383
@pixi/filter-noise #6383

Bundles

pixi.js-legacy #6673 In Progress @bigtimebuddy
pixi.js #6673 In Progress @bigtimebuddy

Issue Analytics

State:
Created 4 years ago
Comments:24 (20 by maintainers)

Top GitHub Comments

2reactions

bigtimebuddycommented, Feb 11, 2020

I hate making API changes to accommodate typing limitations, just doesn’t feel right to me. Personally, I’d rather use any then create a new method. Having such a large API surface is already a burden.

1reaction

bigtimebuddycommented, Jun 1, 2020

Huge thank you to @Zyie, @ivanpopelyshev, @SerG-Y, @eXponenta and all the other contributors who helped make this migration possible.

Top Results From Across the Web

Documentation - Migrating from JavaScript - TypeScript

Converting a JavaScript codebase over to TypeScript is, while somewhat tedious, usually not challenging. In this tutorial, we're going to look at how...

ts-migrate: A Tool for Migrating to TypeScript at Scale - Medium

Let's walk through the main steps needed to migrate a project from JavaScript to TypeScript and how those steps are implemented: 1) The...

Converting JavaScript to TypeScript - TutorialsTeacher

Learn how to convert an existing JavaScript code to TypeScript step by step.

Convert codebase to TypeScript · Issue #494 · testing-library ...

Currently types are manually maintained in the @types/ project so they are only updated after the fact and are prone to human error...

8 Tips for Converting That Big Project to TypeScript

Try to make sure any helps the team go forward, but doesn't get forgotten in your project. One way to do so is...