Skip to content

Error: Unknown option: --ignoreCompilerErrors #1643

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
Thinking80s opened this issue Jul 31, 2021 · 7 comments
Closed

Error: Unknown option: --ignoreCompilerErrors #1643

Thinking80s opened this issue Jul 31, 2021 · 7 comments
Labels
question Question about functionality

Comments

@Thinking80s
Copy link

Search terms

typedoc --out ~/Downloads/ --tsconfig ./tsconfig.json --entryPoints ./src/ --ignoreCompilerErrors

image

Question

@Thinking80s Thinking80s added the question Question about functionality label Jul 31, 2021
@krisztianb
Copy link
Contributor

I guess you updated to a newer version of TypeDoc, right?

That option was removed in version 0.20: https://github.com/TypeStrong/typedoc/releases/tag/v0.20.0

@Gerrit0 Gerrit0 closed this as completed Aug 5, 2021
@ouya99
Copy link

ouya99 commented Aug 27, 2021

Hi,

i would want to ignore specific TS errors like TS2307 and others to create a documentation for my project

Since I cannot downgrade to v.019.2 (bound to 4.0.x typescript), I need a way to use typedoc with a tool like tsc-silent

Any ideas?

Thank you

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Aug 27, 2021

I'm not going to bring this flag back. It's a bad thing. #1403 contains a workaround but be aware that any crashes due to compiling without checking errors are officially out of scope.

@krisztianb
Copy link
Contributor

How can you expect to have a reasonable documentation for something that is not valid?

@ouya99
Copy link

ouya99 commented Aug 27, 2021

@krisztianb TS2307 is thrown cause i include a package that is not visible to Typescript before the bazel build. Is it best practise to just @ts-ignore those imports?

@ouya99
Copy link

ouya99 commented Aug 30, 2021

@Gerrit0 I do not get my paths to work and receive a TS2307 on every single import. Yet my TS-compiler does not complain when building the project. is "typedoc --tsconfig tsconfig.json" the correct syntax?
Tried src/tsconfig.json without any existing src folder ->....no error thrown...
but ../tsconfig.json throws error if no tsconfig.json in ../

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Aug 31, 2021

If you compile with tsc, then typedoc path/to/entry.ts should work. If you compile with a custom tsconfig file name, (e.g. tsc --project custom.tsconfig.json), then typedoc --tsconfig custom.tsconfig.json should work.

If TypeDoc is complaining in some case where plain tsc is not, that's probably a bug, and I'd love a reproduction

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

No branches or pull requests

4 participants