Skip to content

CLI: Generate docs:json command dynamically for Angular project #11622

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

Jump to bottom
Merged
merged 2 commits into from
Jul 21, 2020
Merged

CLI: Generate docs:json command dynamically for Angular project #11622

merged 2 commits into from
Jul 21, 2020

Conversation

@gaetanmaisse
Copy link
Member

@gaetanmaisse gaetanmaisse commented Jul 20, 2020 •
edited
Loading

Issue: #11609

What I did

  • Angular CLI 10 introduced a tsconfig.base.json file that we have to use to generate doc with compodoc. So if tsconfig.base.json exists then use it, otherwise assume there is a tsconfig.json file.
  • Update E2E test of addon-viewport to match the latest example stories

How to test

  • I checked locally that generated docs:json commands are OK.
  • CI should be 🟢
  • In the CI logs we should have valid logs displaying compodoc output:
[19:53:11] found          : ButtonComponent
[19:53:11] parsing        : /tmp/storybook-e2e-testing/angular-vv8-lts/src/stories/header.component.ts
[19:53:11] found          : HeaderComponent
[19:53:11] parsing        : /tmp/storybook-e2e-testing/angular-vv8-lts/src/stories/page.component.ts
[19:53:11] found          : PageComponent

@gaetanmaisse
fix(cli): generate docs:json NPM script dynamically according to ts…
4a0c9a9 
…config file

Angular CLI 10 introduced a `tsconfig.base.json` file that we have to use to generate doc with compodoc.
So if `tsconfig.base.json` exist then use it, otherwise assume there is a `tsconfig.json` file
@gaetanmaisse
fix(e2e): update test of viewport to match latest example stories
6d79ed2 
Example stories used in CLI have been updated recently however the E2E tests were not changed accordingly.
@gaetanmaisse gaetanmaisse linked an issue Jul 20, 2020 that may be closed by this pull request
CLI: Generate compodoc command based on user's setup #11609
Closed
@gaetanmaisse gaetanmaisse force-pushed the fix/11609-generate-docs-json-command-dynamically branch from b783ffc to 6d79ed2 Compare July 20, 2020 20:05
@gaetanmaisse
Copy link
Member Author

gaetanmaisse commented Jul 20, 2020

ci/circleci: examples-v2 is failing because the following frameworks haven't the new story templates yet:

  • rax
  • riot
  • html

Everything else is 🆗

@gaetanmaisse gaetanmaisse marked this pull request as ready for review July 20, 2020 20:06
@gaetanmaisse gaetanmaisse requested a review from tooppaaa July 20, 2020 20:06
shilman
shilman approved these changes Jul 21, 2020
View reviewed changes
Copy link
Member

@shilman shilman left a comment

Choose a reason for hiding this comment

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

Thanks @gaetanmaisse 🙏

@shilman
Copy link
Member

shilman commented Jul 21, 2020

Can we remove the e2e for rax, riot, html until they are passing?

@shilman shilman merged commit 129ea83 into next Jul 21, 2020
@shilman shilman deleted the fix/11609-generate-docs-json-command-dynamically branch July 21, 2020 00:39
@shilman shilman mentioned this pull request Jul 21, 2020
Closed
This was referenced Dec 28, 2020
Open
Closed
Closed
Open
Open
Closed
Open
Open
Open
Open
Open
Closed
@lili2311 lili2311 mentioned this pull request Sep 26, 2023
Open
This was referenced Nov 25, 2023
Open
Open
Open
Open
Open
Open
This was referenced Nov 26, 2023
Open
Open
@azl397985856 azl397985856 mentioned this pull request Nov 27, 2023
Open
This was referenced Nov 27, 2023
Open
Open
Open
This was referenced Nov 27, 2023
Open
Open
@azl397985856 azl397985856 mentioned this pull request May 13, 2024
Open
This was referenced May 13, 2024
Open
Open
Open
This was referenced May 13, 2024
Open
Open
Open
Open
Open
Open
This was referenced May 14, 2024
Open
Open
@adrukh adrukh mentioned this pull request May 14, 2024
Open
This was referenced May 20, 2024
Open
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@shilman shilman shilman approved these changes

@ndelangen ndelangen Awaiting requested review from ndelangen

@stijnkoopal stijnkoopal Awaiting requested review from stijnkoopal

@tooppaaa tooppaaa Awaiting requested review from tooppaaa

Assignees

No one assigned

Labels

angular bug cli

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

CLI: Generate compodoc command based on user's setup

3 participants

@gaetanmaisse @shilman