Error trying to generate documentation

[yarkovaleksei]

`$ typedoc --out ./docs ./src

Using TypeScript 2.7.2 from /home/user/.nvm/versions/node/v9.8.0/lib/node_modules/typedoc/node_modules/typescript/lib
Error: /home/user/git/frontend/node_modules/@types/sinon/index.d.ts(488)
';' expected.
`

[taoqf]

same issue

[connorjclark]

same

[connorjclark]

Seems the default behavior of ignoring these files is broken (seems it is meant to be opt in given --includeDeclarations exists).

[liuxh0]

+1

[ali-habibzadeh]

+1

[dannycodes]

Is this still an issue for people? How did you work around it? AFAIK this bug breaks this library completely (100% unusable).

Am I missing something? I haven't found a workaround / solution after googling around.

[aciccarello]

By default typedoc includes declarations so any declaration files need to be compiled correctly. Could someone provide a repo which demonstrates this bug?

[daniellacosse]

+1 for me still, sinon - try running on https://github.com/daniellacosse/process-automation-scripts

tried commenting out the file that imported sinon, same issue. it wasn't until I uninstalled @types/sinon that it started working again. tried turning includeDeclarations off as well

[Gerrit0]

Thanks for the repro to look at.

I haven't cloned to check it out, but I did notice that you are using ^0.11.1, if you update to ^0.14.2 you may find that the types work.

[daniellacosse]

oh shooot sorry thanks

[Gerrit0]

Closing this since as far as I can tell the error was caused by a TypeScript version incompatibility. As TypeDoc (master at least) is now on 3.4, this should not longer be an issue.

In July 2018 TypeDoc was on TypeScript version 2.7.2. The Sinon types at that time required conditional types, which were introduced in 2.8 git blame

[Kalanamith]

This issue still exists in 2021, no document generation with TypeDoc if there is sinon .
Super helpful if someone can give a hand or two, Thank you so much

[Gerrit0]

Please open a new issue rather than responding to one that's been closed for 2+ years.