Add support for TypeScript 4.3 #1589

doberkofler · 2021-05-26T19:09:21Z

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 [email protected]

Suggested Solution

Support TypeScript 4.3

simllll · 2021-05-26T21:31:51Z

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

- 3rd library の更新 - typescript 4.3.2 は TypeDoc がまだ未対応なので見送り TypeStrong/typedoc#1589

chharvey · 2021-05-27T05:17:11Z

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 · 2021-05-27T18:23:46Z

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 · 2021-05-29T00:21:12Z

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

krisztianb · 2021-05-29T09:25:06Z

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 · 2021-05-31T01:22:09Z

@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.

- i18next: 20.3.1 - testem: 3.4.2 - typescript 4.3.2 は TypeDoc がまだ未対応なので見送り TypeStrong/typedoc#1589

Error when running typedoc with Typescript 4.3. TypeStrong/typedoc#1589

Gerrit0 · 2021-06-01T02:28:23Z

@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.

typedoc does not yet support typescript 4.3 TypeStrong/typedoc#1589

This is a temporary measure as Typedoc generation will be broken when we upgrade to TypeScript v4.3 until Typedoc supports this version (should be very soon: TypeStrong/typedoc#1589 (comment)). At that point, we can re-instate this. Change-type: patch Signed-off-by: Graham McCulloch <[email protected]>

sindresorhus · 2021-06-02T13:23:14Z

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

I would personally take that risk rather than having the annoyance of having to wait for typedoc for every single minor version of TypeScript.

krisztianb · 2021-06-02T13:57:21Z

It's just a warning. You can take the risk. As you can see it won't work this time. 😄

doberkofler · 2021-06-02T14:07:57Z

I'm generally ok with the strict dependencies but maybe the actual need for the strict dependency could be relaxed. I don't know, how the interface between TypeDoc and TypeScript works but i believe that for example eslint abstracts aways the version specific details of language to be linted by using a dedicate abstraction layer.

Nokel81 · 2021-06-02T20:20:34Z

And code note actually says "This will probably break in a future TS version" - and I guess it did :(

Yeah... I just found that too, {} is not a valid Node (from TS POV) so I can understand why they didn't bother adding a check on name.parent.kind in the ts.isDeclaration function.

Error when running typedoc with Typescript 4.3. TypeStrong/typedoc#1589

Use typescript 4.2.x. Error when running typedoc with Typescript 4.3. TypeStrong/typedoc#1589

Downgrade typescript version because of typedoc bug. TypeStrong/typedoc#1589

Nokel81 · 2021-06-08T11:39:16Z

Tested v0.21.0-beta.2 on www.github.com/lensapp/lens and it worked great!

Ayfri · 2021-06-10T04:32:37Z

Error: source/src/sprites/Text.ts:17:18 - error TS2612: Property 'background' will overwrite the base property in 'Container'. If this is intentional, add an initializer. Otherwise, add a 'declare' modifier or remove the redundant declaration.

public override background: Sprite;

With https://github.com/Ayfri/PIXI-Extended.
This is found in this file.

Configuration here : https://github.com/Ayfri/PIXI-Extended/blob/docs/typedoc.json.

krisztianb · 2021-06-10T11:42:02Z

@Ayfri that's a compiler error you need to fix and not related to TypeDoc, is it?

Ayfri · 2021-06-10T11:44:30Z

No, my code is fine. It's just because override is a new keyword introduced by TS 4.3 and normally TS 4.2 throws this error when falling on it, but in my project I use TS 4.3 and everything is fine. So I don't know 🤔

krisztianb · 2021-06-10T11:51:23Z

So the code builds fine, but creating the docs with TypeDoc fails. Is that right?

Ayfri · 2021-06-10T11:51:41Z

Exactly !

krisztianb · 2021-06-10T11:53:57Z

Could it be that TypeDoc for whatever reason is still using TS 4.2 to compile your project? Looking at your package.json TypeDoc is not installed locally with your project. How do you build the docs?

Ayfri · 2021-06-10T11:55:47Z

It's on the docs branch. I'm using a GitHub action to clone the master branch and generate the docs.

krisztianb · 2021-06-10T12:09:46Z

Oh, I see. I don't know then. Still looks like a compilation error to me. Maybe you should create a smaller repo to narrow down the issue.

Ayfri · 2021-06-11T22:56:20Z

Maybe it's because I'm using a plugin, here are the complete logs :

"C:\Program Files\nodejs\node.exe" "C:\Program Files\nodejs\node_modules\npm\bin\npm-cli.js" run generate --scripts-prepend-node-path=auto

> pixi-extended-docs@1.0.0 generate
> typedoc --sourcefile-url-map mappings.json
Warning: C:\Users\Pierre\WebstormProjects\pixi\PIXI-utils\node_modules\typedoc-plugin-sourcefile-url uses a deprecated structure. Pl
ugins should export a "load" function to be called with the Application
    at Application.bootstrap (C:\Users\Pierre\WebstormProjects\pixi\PIXI-utils\node_modules\typedoc\dist\lib\application.js:156:17)
Info: Loaded plugin C:\Users\Pierre\WebstormProjects\pixi\PIXI-utils\node_modules\typedoc-plugin-sourcefile-url
Error: source/src/sprites/Text.ts:17:18 - error TS2612: Property 'background' will overwrite the base property in 'Container'. If th
is is intentional, add an initializer. Otherwise, add a 'declare' modifier or remove the redundant declaration.

17  public override background: Sprite;
                    ~~~~~~~~~~


Process finished with exit code 3

krisztianb · 2021-06-12T08:28:51Z

Can you temporarily disable or remove the plugin and try without it? Although I doubt that the plugin is the issue.

I think we should move this conversation to a new/separate issue.

Ayfri · 2021-06-12T21:37:01Z

It doesn't fix the issue :/

Maybe yes.

iliubinskii · 2021-06-13T07:45:48Z

Using typedoc 0.21.0-beta.2 with typedoc-plugin-markdown 3.9.0.
It works well.

Curious when 0.21.0 can be expected?
typedoc-plugin-markdown has peer dependency ">=0.20.0" and does not see 0.21.0-beta.2.

Gerrit0 · 2021-06-13T16:05:23Z

I'm aiming to release it tonight, assuming I have enough time, if not tonight, it should be sometime this week, Friday at the latest.

Gerrit0 · 2021-06-15T03:18:47Z

(Obviously didn't happen yesterday, or today... 4 things left on todo list - https://github.com/TypeStrong/typedoc/projects/8)

krisztianb · 2021-06-15T18:32:31Z

@Gerrit0 take your time. 👍

cefn · 2021-06-17T21:42:51Z

Depending on the beta works for @lauf/store and @lauf/store-react Thanks!

Typedoc retiring support for EOL Node 10 has prompted me to tidy up my test build matrix too!

Thanks for all your efforts.

Gerrit0 · 2021-06-18T02:44:25Z

0.21.0 has been released!

nisimjoseph · 2021-06-18T05:19:41Z

Working great! Thank you!

doberkofler · 2021-06-18T06:08:30Z

Thank you!

iliubinskii · 2021-06-18T07:09:51Z

Thx. Great work 👍

doberkofler added the enhancement label May 26, 2021

Shin-Ogata added a commit to Shin-Ogata/fieldwork that referenced this issue May 27, 2021

chore: update 3rd modules

2623508

- 3rd library の更新 - typescript 4.3.2 は TypeDoc がまだ未対応なので見送り TypeStrong/typedoc#1589

achamayou mentioned this issue May 27, 2021

Pin TypeScript to a version TypeDoc supports microsoft/CCF#2624

Merged

eonarheim mentioned this issue May 29, 2021

chore: Update typescript 4.3.2 + npm audit excaliburjs/Excalibur#1902

Merged

Shin-Ogata added a commit to Shin-Ogata/fieldwork that referenced this issue May 31, 2021

chore: update 3rd modules

e0b968f

- i18next: 20.3.1 - testem: 3.4.2 - typescript 4.3.2 は TypeDoc がまだ未対応なので見送り TypeStrong/typedoc#1589

Shin-Ogata mentioned this issue May 31, 2021

chore: update 3rd modules Shin-Ogata/fieldwork#13

Merged

antondalgren added a commit to cloudamqp/amqp-client.js that referenced this issue May 31, 2021

Use typescript 4.2.x.

eee5859

Error when running typedoc with Typescript 4.3. TypeStrong/typedoc#1589

alanshaw pushed a commit to nftstorage/nft.storage that referenced this issue Jun 1, 2021

chore: pin typescript version

8da5b3e

typedoc does not yet support typescript 4.3 TypeStrong/typedoc#1589

alanshaw mentioned this issue Jun 1, 2021

chore: pin typescript version nftstorage/nft.storage#169

Merged

alanshaw pushed a commit to nftstorage/nft.storage that referenced this issue Jun 1, 2021

chore: pin typescript version (#169)

ff032f1

typedoc does not yet support typescript 4.3 TypeStrong/typedoc#1589

iliubinskii mentioned this issue Jun 1, 2021

Feature request: An option to display return section as a table typedoc2md/typedoc-plugin-markdown#227

Closed

grahammcculloch mentioned this issue Jun 2, 2021

Do not generate docs as part of test product-os/jellyfish#6557

Merged

blitz-1306 mentioned this issue Jun 2, 2021

Dependency updates ConsenSysDiligence/solc-typed-ast#41

Merged

4 tasks

peterdemartini mentioned this issue Jun 2, 2021

Update typescript to 4.3 terascope/teraslice#2773

Closed

Nokel81 mentioned this issue Jun 2, 2021

Upgrade typedoc lensapp/lens#2940

Merged

antondalgren added a commit to cloudamqp/amqp-client.js that referenced this issue Jun 3, 2021

Use typescript 4.2.x.

c89d144

Error when running typedoc with Typescript 4.3. TypeStrong/typedoc#1589

antondalgren added a commit to cloudamqp/amqp-client.js that referenced this issue Jun 3, 2021

Deploy documentation to github pages on push to main

8b61e9a

Use typescript 4.2.x. Error when running typedoc with Typescript 4.3. TypeStrong/typedoc#1589

Noah2610 added a commit to Noah2610/timesub that referenced this issue Jun 4, 2021

Add typedoc for documentation generation

6df3d45

Downgrade typescript version because of typedoc bug. TypeStrong/typedoc#1589

gnarea added a commit to relaycorp/keystore-db-js that referenced this issue Jun 9, 2021

chore(release): Disable API docs until TypeStrong/typedoc#1589 is fixed

41466b7

dubzzz mentioned this issue Jun 11, 2021

⬆️ Bump to typescript 4.3.2 dubzzz/fast-check#1980

Merged

12 tasks

Ayfri mentioned this issue Jun 12, 2021

Cannot use override keyword #1597

Closed

Gerrit0 pinned this issue Jun 15, 2021

cefn mentioned this issue Jun 17, 2021

Temporarily adopt Typedoc beta for 4.3. compatibility cefn/lauf#107

Merged

Gerrit0 closed this as completed Jun 18, 2021

Gerrit0 unpinned this issue Jun 18, 2021

zdrawku mentioned this issue Jul 21, 2021

TypeDoc: You are running with an unsupported TypeScript version TypeDoc supports 3.9, 4.0, 4.1, 4.2 IgniteUI/igniteui-angular#9898

Closed

Gerrit0 removed the enhancement label Feb 2, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for TypeScript 4.3 #1589

Add support for TypeScript 4.3 #1589

doberkofler commented May 26, 2021

simllll commented May 26, 2021

chharvey commented May 27, 2021 •

edited

Loading

vladmandic commented May 27, 2021 •

edited

Loading

Gerrit0 commented May 29, 2021

krisztianb commented May 29, 2021 •

edited

Loading

chharvey commented May 31, 2021

Gerrit0 commented Jun 1, 2021

sindresorhus commented Jun 2, 2021

krisztianb commented Jun 2, 2021

doberkofler commented Jun 2, 2021

Nokel81 commented Jun 2, 2021

Nokel81 commented Jun 8, 2021 •

edited

Loading

Ayfri commented Jun 10, 2021 •

edited

Loading

krisztianb commented Jun 10, 2021

Ayfri commented Jun 10, 2021 •

edited

Loading

krisztianb commented Jun 10, 2021

Ayfri commented Jun 10, 2021

krisztianb commented Jun 10, 2021

Ayfri commented Jun 10, 2021

krisztianb commented Jun 10, 2021

Ayfri commented Jun 11, 2021

krisztianb commented Jun 12, 2021

Ayfri commented Jun 12, 2021

iliubinskii commented Jun 13, 2021

Gerrit0 commented Jun 13, 2021

Gerrit0 commented Jun 15, 2021

krisztianb commented Jun 15, 2021

cefn commented Jun 17, 2021

Gerrit0 commented Jun 18, 2021

nisimjoseph commented Jun 18, 2021

doberkofler commented Jun 18, 2021

iliubinskii commented Jun 18, 2021

Add support for TypeScript 4.3 #1589

Add support for TypeScript 4.3 #1589

Comments

doberkofler commented May 26, 2021

Search Terms

Problem

Suggested Solution

simllll commented May 26, 2021

chharvey commented May 27, 2021 • edited Loading

vladmandic commented May 27, 2021 • edited Loading

Gerrit0 commented May 29, 2021

krisztianb commented May 29, 2021 • edited Loading

chharvey commented May 31, 2021

Gerrit0 commented Jun 1, 2021

sindresorhus commented Jun 2, 2021

krisztianb commented Jun 2, 2021

doberkofler commented Jun 2, 2021

Nokel81 commented Jun 2, 2021

Nokel81 commented Jun 8, 2021 • edited Loading

Ayfri commented Jun 10, 2021 • edited Loading

krisztianb commented Jun 10, 2021

Ayfri commented Jun 10, 2021 • edited Loading

krisztianb commented Jun 10, 2021

Ayfri commented Jun 10, 2021

krisztianb commented Jun 10, 2021

Ayfri commented Jun 10, 2021

krisztianb commented Jun 10, 2021

Ayfri commented Jun 11, 2021

krisztianb commented Jun 12, 2021

Ayfri commented Jun 12, 2021

iliubinskii commented Jun 13, 2021

Gerrit0 commented Jun 13, 2021

Gerrit0 commented Jun 15, 2021

krisztianb commented Jun 15, 2021

cefn commented Jun 17, 2021

Gerrit0 commented Jun 18, 2021

nisimjoseph commented Jun 18, 2021

doberkofler commented Jun 18, 2021

iliubinskii commented Jun 18, 2021

chharvey commented May 27, 2021 •

edited

Loading

vladmandic commented May 27, 2021 •

edited

Loading

krisztianb commented May 29, 2021 •

edited

Loading

Nokel81 commented Jun 8, 2021 •

edited

Loading

Ayfri commented Jun 10, 2021 •

edited

Loading

Ayfri commented Jun 10, 2021 •

edited

Loading