Excalibur: Tsserver throws error when class member names ends with $

Sure @ewal let me know if you run into new information and we’ll look into it again 👍

Sorry for the delay, @eonarheim!

I decided to do some more testing. I still haven’t figured out the source of the problem but at least I now know how to bypass it 😃 I have my suspects though, see further down.

TLDR; The problem goes away if the consuming project is using TypeScript version <= 4.5.5

Using Excalibur in a new minimal project

• Between tests all dependencies was removed and freshly reinstalled
• The error message is show as soon as the IDE asks to show completions for a class that extends the eg. Actor class
• It is NOT shown when asking for completions inside a class method or getter etc.
• Not all classes throws this error, for example extending a Scene class works fine.
• Only the consuming project needs to specify a lower TypeScript version
• Excalibur was added as a local dependency and built with npm run clean && npm run build

Error message: [coc.nvim] Error: Error processing request. Debug Failure. Did not expect GetAccessor t o have an Identifier in its trivia … More

IDE: Neovim 0.7.0 coc-tsserver

(Tested two different computers with nvim and coc, Linux and Mac)

Minimal test project: TypeScript:

• 4.6.3
• 4.5.5
• 4.7.3
• 4.7.4

Excalibur:

• 0.26.0

Node:

• 16.14.2
• 16.15.1

Yarn:

• 1.22.19

Excalibur source project: TypeScript:

• 4.6.3
• 4.5.5
• 4.7.3
• 4.7.4

Node:

• 16.14.2
• 16.15.1

Npm:

• 8.11.0

Test class

import * as ex from "excalibur";

export class Test extends ex.Actor {
// error is thrown as soon as you start typing here
}

I have no idea what the underlying problem is but I suspect that it is related to js-doc comments. Example issue https://github.com/microsoft/TypeScript/issues/48238 My idea is that TypeScript misinterpret some comment content where code examples are used… 🤷

I upgraded all dependencies in Excalibur and fiddled with the configurations for eslint, typescript, js-doc etc. which resultet in js-doc started to throw a lot of errors. Not of them saved but they all related to how the comments where formatted.

That’s what I have so far 😃

I found the cause to the problem, … 13+ days later 😬 I’ll write a short summary soon. Was nearly going crazy there for a while.

@ewal Thanks for digging into this issue so deep, this is truly mysterious!

bit of a risky pattern 😃

True true! This code will in theory go away soon 😃 I have some performance optimizations that hopefully makes the old transform implementation obsolete (in addition to being a lot simpler) https://github.com/excaliburjs/Excalibur/blob/perf/transform-matrix-refactor/src/engine/Math/transform.ts

I’m wondering if it’s an odd interaction with that specific version of typescript’s tsserver and the tsserver extension? At least in vscode pointing to that same version of typescript it seems to work okay.

There might not be anything we can directly do here other than upgrade typescript on main.

Hi @ewal thanks for the issue!

Oh wow, this is very interesting! It’s wild that $ is messing with the tsserver/typescript, that should be a totally okay character to use in a variable name.

I have a colleague with a similar environment to yours that will be digging into the issue.

I found the related coc-tsserver issue you posted on (including here for posterity) https://github.com/neoclide/coc-tsserver/issues/365