Skip to content
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

TypeScript Paths Make TypeDoc Call Everything External #1185

Closed
1 task done
ProfessorManhattan opened this issue Jan 19, 2020 · 3 comments
Closed
1 task done

TypeScript Paths Make TypeDoc Call Everything External #1185

ProfessorManhattan opened this issue Jan 19, 2020 · 3 comments
Labels
bug Functionality does not match expectation

Comments

@ProfessorManhattan
Copy link

ProfessorManhattan commented Jan 19, 2020

TypeDoc is labeling all the files in an Angular app as external when you click on the links on the right. Did I not set up the configuration right?

Expected Behavior

All the code in the src/app folder should be internal.

Actual Behavior

Everything shows up as external.

Steps to reproduce the bug

npm install -g @angular/cli
ng new TestApp
cd TestApp
typedoc --tsconfig tsconfig.app.json --exclude **/*.spec.ts src/app

Open the documentation, click on any of the files and they all say "External ...."

Environment

Windows 10
C:\Users\x\OneDrive\Documents\Websites\x\docs>node -v
v10.16.0

C:\Users\x\OneDrive\Documents\Websites\x\docs>typedoc --version

TypeDoc 0.16.7
Using TypeScript 3.7.5 from C:\Users\x\AppData\Roaming\nvm\v10.16.0\node_modules\typedoc\node_modules\typescript\lib

@ProfessorManhattan ProfessorManhattan added the bug Functionality does not match expectation label Jan 19, 2020
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jan 19, 2020

Do you mean the "External Module" label? That's a misnomer that will be fixed relatively soon with #1184, your files are likely not actually marked as external.

@ProfessorManhattan
Copy link
Author

@Gerrit0 They actually were marked External until I included the "include": ["./src/**/*.ts"] in tsconfig.json. Before that I just had a "files": ["./src/main.ts", "./src/polyfills.ts"], declaration.

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jan 21, 2020

I can't reproduce this with the commands you specified above. Note that the externals box is unchecked, which would hide any externals, but AppModule is included, indicating that it is not external.

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Functionality does not match expectation
Projects
None yet
Development

No branches or pull requests

2 participants