Skip to content

Typedoc is broken #785

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
ghost opened this issue Jun 3, 2018 · 5 comments
Closed

Typedoc is broken #785

ghost opened this issue Jun 3, 2018 · 5 comments

Comments

@ghost
Copy link

ghost commented Jun 3, 2018

I can't compile my project's documentation.
Here's the log:

PS C:\Users\misha\Documents\Projects\Cutelog> npm run docs

> [email protected] docs C:\Users\misha\Documents\Projects\Cutelog
> typedoc --out ./docs --theme markdown --target es6 --module es2015 .

Loaded plugin typedoc-plugin-markdown

Using TypeScript 2.7.2 from C:\Users\misha\Documents\Projects\Cutelog\node_modules\typedoc\node_modules\typescript\lib
Error: C:/Users/misha/Documents/Projects/Cutelog/node_modules/typescript/lib/lib.d.ts(1361)
 ';' expected.
Error: C:/Users/misha/Documents/Projects/Cutelog/node_modules/typescript/lib/lib.d.ts(1361)
 Expression expected.
Error: C:/Users/misha/Documents/Projects/Cutelog/node_modules/typescript/lib/lib.d.ts(1361)
 Expression expected.
Error: C:/Users/misha/Documents/Projects/Cutelog/node_modules/typescript/lib/lib.d.ts(1362)
 Declaration or statement expected.
Error: C:/Users/misha/Documents/Projects/Cutelog/node_modules/typescript/lib/lib.d.ts(1388)
 ';' expected.
Error: C:/Users/misha/Documents/Projects/Cutelog/node_modules/typescript/lib/lib.d.ts(1393)
 ';' expected.
Error: C:/Users/misha/Documents/Projects/Cutelog/node_modules/typescript/lib/lib.d.ts(1398)
 ';' expected.
Error: C:/Users/misha/Documents/Projects/Cutelog/node_modules/typescript/lib/lib.d.ts(1403)
 ';' expected.
Error: C:/Users/misha/Documents/Projects/Cutelog/node_modules/typescript/lib/lib.d.ts(1403)
 ';' expected.
Error: C:/Users/misha/Documents/Projects/Cutelog/node_modules/typescript/lib/lib.d.ts(1408)
 ';' expected.
Error: C:/Users/misha/Documents/Projects/Cutelog/node_modules/typescript/lib/lib.d.ts(1408)
 Expression expected.
Error: C:/Users/misha/Documents/Projects/Cutelog/node_modules/typescript/lib/lib.d.ts(1408)
 ';' expected.
Error: C:/Users/misha/Documents/Projects/Cutelog/node_modules/typescript/lib/lib.d.ts(1408)
 Declaration or statement expected.
Error: C:/Users/misha/Documents/Projects/Cutelog/node_modules/typescript/lib/lib.d.ts(1408)
 ';' expected.
Error: C:/Users/misha/Documents/Projects/Cutelog/node_modules/typescript/lib/lib.es5.d.ts(1361)
 ';' expected.
Error: C:/Users/misha/Documents/Projects/Cutelog/node_modules/typescript/lib/lib.es5.d.ts(1361)
 Expression expected.
Error: C:/Users/misha/Documents/Projects/Cutelog/node_modules/typescript/lib/lib.es5.d.ts(1361)
 Expression expected.
Error: C:/Users/misha/Documents/Projects/Cutelog/node_modules/typescript/lib/lib.es5.d.ts(1362)
 Declaration or statement expected.
Error: C:/Users/misha/Documents/Projects/Cutelog/node_modules/typescript/lib/lib.es5.d.ts(1388)
 ';' expected.
Error: C:/Users/misha/Documents/Projects/Cutelog/node_modules/typescript/lib/lib.es5.d.ts(1393)
 ';' expected.
Error: C:/Users/misha/Documents/Projects/Cutelog/node_modules/typescript/lib/lib.es5.d.ts(1398)
 ';' expected.
Error: C:/Users/misha/Documents/Projects/Cutelog/node_modules/typescript/lib/lib.es5.d.ts(1403)
 ';' expected.
Error: C:/Users/misha/Documents/Projects/Cutelog/node_modules/typescript/lib/lib.es5.d.ts(1403)
 ';' expected.
Error: C:/Users/misha/Documents/Projects/Cutelog/node_modules/typescript/lib/lib.es5.d.ts(1408)
 ';' expected.
Error: C:/Users/misha/Documents/Projects/Cutelog/node_modules/typescript/lib/lib.es5.d.ts(1408)
 Expression expected.
Error: C:/Users/misha/Documents/Projects/Cutelog/node_modules/typescript/lib/lib.es5.d.ts(1408)
 ';' expected.
Error: C:/Users/misha/Documents/Projects/Cutelog/node_modules/typescript/lib/lib.es5.d.ts(1408)
 Declaration or statement expected.
Error: C:/Users/misha/Documents/Projects/Cutelog/node_modules/typescript/lib/lib.es5.d.ts(1408)
 ';' expected.
Error: C:/Users/misha/Documents/Projects/Cutelog/node_modules/typescript/lib/lib.es6.d.ts(1361)
 ';' expected.
Error: C:/Users/misha/Documents/Projects/Cutelog/node_modules/typescript/lib/lib.es6.d.ts(1361)
 Expression expected.
Error: C:/Users/misha/Documents/Projects/Cutelog/node_modules/typescript/lib/lib.es6.d.ts(1361)
 Expression expected.
Error: C:/Users/misha/Documents/Projects/Cutelog/node_modules/typescript/lib/lib.es6.d.ts(1362)
 Declaration or statement expected.
Error: C:/Users/misha/Documents/Projects/Cutelog/node_modules/typescript/lib/lib.es6.d.ts(1388)
 ';' expected.
Error: C:/Users/misha/Documents/Projects/Cutelog/node_modules/typescript/lib/lib.es6.d.ts(1393)
 ';' expected.
Error: C:/Users/misha/Documents/Projects/Cutelog/node_modules/typescript/lib/lib.es6.d.ts(1398)
 ';' expected.
Error: C:/Users/misha/Documents/Projects/Cutelog/node_modules/typescript/lib/lib.es6.d.ts(1403)
 ';' expected.
Error: C:/Users/misha/Documents/Projects/Cutelog/node_modules/typescript/lib/lib.es6.d.ts(1403)
 ';' expected.
Error: C:/Users/misha/Documents/Projects/Cutelog/node_modules/typescript/lib/lib.es6.d.ts(1408)
 ';' expected.
Error: C:/Users/misha/Documents/Projects/Cutelog/node_modules/typescript/lib/lib.es6.d.ts(1408)
 Expression expected.
Error: C:/Users/misha/Documents/Projects/Cutelog/node_modules/typescript/lib/lib.es6.d.ts(1408)
 ';' expected.
Error: C:/Users/misha/Documents/Projects/Cutelog/node_modules/typescript/lib/lib.es6.d.ts(1408)
 Declaration or statement expected.
Error: C:/Users/misha/Documents/Projects/Cutelog/node_modules/typescript/lib/lib.es6.d.ts(1408)
 ';' expected.
npm ERR! code ELIFECYCLE
npm ERR! errno 4
npm ERR! [email protected] docs: `typedoc --out ./docs --theme markdown --target es6 --module es2015 .`
npm ERR! Exit status 4
npm ERR!
npm ERR! Failed at the [email protected] docs script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR!     C:\Users\misha\AppData\Roaming\npm-cache\_logs\2018-06-03T17_53_40_745Z-debug.log

Node version: 8.11.2
Typescript version: 2.9.1

@aciccarello
Copy link
Collaborator

I expect this to be a Typescript version issue. TypeDoc is on version 2.7 right now

@Mikhus
Copy link

Mikhus commented Jun 15, 2018

Yes, same problem, heads up for accepting PR with typescript version update

@dskvr
Copy link

dskvr commented Sep 26, 2018

Typedoc shouldn't prevent people from upgrading Typescript. Documentation reacts to development, it shouldn't dictate development. This is an anti-pattern.

@blink1073
Copy link

@dskvr, please bear in mind everyone working on this project is doing so out of good will. The original project was written before public APIs were available in TypeScript to make it feasible for this library to work across versions. Updating the project to use the new API is a substantial effort. cf #378

@aciccarello
Copy link
Collaborator

Moving to a peer dependency is under consideration for a 1.0.0 release. Until then typedoc will continue to include typescript as a direct dependency. Since TypeDoc is currently released with TypeScript 3.1 I believe this issue should be resolved.

If you have an immediate issue, please see the Updating guide for a workaround to TypeScript upgrades.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants