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.

Sign up for GitHub

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

fix(typedoc): adding to excluded paths #11162

Merged
merged 4 commits into from
Mar 4, 2022
Merged

fix(typedoc): adding to excluded paths #11162

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4a33812
fix(typedoc): adding to excluded paths
kdinev Mar 4, 2022
d3b9d16
chore(ci): resolving ci build issue
ChronosSF Mar 4, 2022
e3f5868
Update .github/workflows/nodejs.yml
kdinev Mar 4, 2022
2f1a5cd
fix(typedoc): gulp now uses the correct config
kdinev Mar 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .github/workflows/nodejs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,3 +53,7 @@ jobs:
uses: coverallsapp/[email protected]
with:
github-token: ${{ github.token }}
- name:
kdinev marked this conversation as resolved.
Show resolved Hide resolved
run: |
npm run build:typedoc:en:production
npm run build:sassdoc:en:production
5 changes: 4 additions & 1 deletion tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,10 @@
"exclude": [
"dist",
"projects/igniteui-angular/migrations/",
"projects/igniteui-angular/schematics/"
"projects/igniteui-angular/schematics/",
"projects/igniteui-angular/cypress/",
"cypress/",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh so this is the main tsconfig? Assuming cypress run would have their own tsconfig this is fine, but also kind of weird. As far as I can see typedoc has options below and those are based on this exclude list, yet there are entry point options.

So the config can be improved in the future. We're interested in API for the project lib only

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, there's a tsconfig.typedoc.json already present in the repo. What's lacking is it doesn't seem to be in use for the actual command:

igniteui-angular/gulpfile.js

Lines 234 to 240 in f9db7af

function typedocBuildDocsEN (cb) {
spawnSync('typedoc', [
TYPEDOC.PROJECT_PATH,
'--localize',
'en',
"--tsconfig",
path.join(__dirname,"tsconfig.json")], { stdio: 'inherit', shell: true});

Replace the tsconfig.json on L240 w/ tsconfig.typedoc.json and it should work fine

"e2e/"
],
"typedocOptions": {
"out": "dist/igniteui-angular/docs/typescript",
Expand Down