Add support for TypeScript 4.3

[doberkofler]

Search Terms

TypeScript 4.3

Problem

npm ERR! Could not resolve dependency:
npm ERR! peer typescript@"3.9.x || 4.0.x || 4.1.x || 4.2.x" from typedoc@0.20.36

Suggested Solution

Support TypeScript 4.3

[simllll]

Right now it fails on my side with following error message:

Warning: You are running with an unsupported TypeScript version! TypeDoc supports 3.9, 4.0, 4.1, 4.2
lerna ERR! npm run generate:docs stderr:
TypeDoc exiting with unexpected error:
TypeError: Cannot read property 'kind' of undefined
    at Object.isDeclaration (/buddy/hokify-justin/hokify-justin/node_modules/typescript/lib/typescript.js:13449:18)
    at Object.isDeclarationName (/buddy/hokify-justin/hokify-justin/node_modules/typescript/lib/typescript.js:16414:75)
    at getTypeOfSymbolAtLocation (/buddy/hokify-justin/hokify-justin/node_modules/typescript/lib/typescript.js:66938:20)
    at Object.getTypeOfSymbolAtLocation (/buddy/hokify-justin/hokify-justin/node_modules/typescript/lib/typescript.js:45176:35)
    at Object.convertProperty (/buddy/hokify-justin/hokify-justin/node_modules/typedoc/dist/lib/converter/symbols.js:330:176)
    at convertSymbol (/buddy/hokify-justin/hokify-justin/node_modules/typedoc/dist/lib/converter/symbols.js:80:79)
    at convertSymbols (/buddy/hokify-justin/hokify-justin/node_modules/typedoc/dist/lib/converter/symbols.js:86:9)
    at Object.convertClassOrInterface (/buddy/hokify-justin/hokify-justin/node_modules/typedoc/dist/lib/converter/symbols.js:264:5)
    at Object.convertSymbol (/buddy/hokify-justin/hokify-justin/node_modules/typedoc/dist/lib/converter/symbols.js:80:79)
    at Converter.convertExports (/buddy/hokify-justin/hokify-justin/node_modules/typedoc/dist/lib/converter/converter.js:182:23)

let me know if I can help somehow!

Thanks

[chharvey]

Is there any particular reason why this

"peerDependencies": {
  "typescript": "3.9.x || 4.0.x || 4.1.x || 4.2.x"
},

isn’t this?

"peerDependencies": {
  "typescript": ">= 3.9"
},

[vladmandic]

Right now it fails on my side with following error message:

Warning: You are running with an unsupported TypeScript version! TypeDoc supports 3.9, 4.0, 4.1, 4.2
lerna ERR! npm run generate:docs stderr:
TypeDoc exiting with unexpected error:
TypeError: Cannot read property 'kind' of undefined

In TypeScript function isDeclaration(node) somehow node param that is passed is undefined.

But error starts earlier in TypeDoc lib/converter/symbols.js
And code note actually says "This will probably break in a future TS version" - and I guess it did :(

  // FIXME: This is a horrible hack because getTypeOfSymbol is not exposed.
  // The right solution here is probably to keep track of parent nodes...
  // but that's tricky because not every reflection is guaranteed to have a
  // parent node. This will probably break in a future TS version.
  reflection.type = context.converter.convertType(context, (_c = (context.isConvertingTypeNode() ? parameterType : void 0)) !== null && _c !== void 0 ? _c : context.checker.getTypeOfSymbolAtLocation(symbol, {}));

Also, there are few other failed checks for undefined when attempting to build TypeDoc using new TS 4.3
So it can't be used with TS 4.3 nor it can be build with TS 4.3 - I hope this gets resolved, but doesn't look like a tiny fix

[Gerrit0]

This is probably going to be a weekend of June 5th fix - I likely won't have time before then :)

[krisztianb]

Is there any particular reason why this

"peerDependencies": {
  "typescript": "3.9.x || 4.0.x || 4.1.x || 4.2.x"
},

isn’t this?

"peerDependencies": {
  "typescript": ">= 3.9"
},

TypeScript updates often include breaking changes so it's not safe to simply state that TypeDoc supports every TS version above 3.9.

[chharvey]

@Gerrit0 In the short term, could you make typescript 4.2.x a dependency, and then add 4.3.x to the peer dependencies? That might let TypeDoc still use 4.2.x internally but let users install 4.3.x in their projects.

[Gerrit0]

@chharvey doing this would break quite a few users that still use old versions of TS, so I don't really want to do that. I'll consider it if I can't get around to fixing it this coming weekend.