Skip to content
New issue

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

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

Already on GitHub? # to your account

CLI: Generate compodoc command based on user's setup #11609

Closed
shilman opened this issue Jul 19, 2020 · 6 comments · Fixed by #11622
Closed

CLI: Generate compodoc command based on user's setup #11609

shilman opened this issue Jul 19, 2020 · 6 comments · Fixed by #11622

Comments

@shilman
Copy link
Member

shilman commented Jul 19, 2020

According to @LeandroCarolino01 the new angular CLI template is not working out of the box in his project #10869 (comment)

[14:50:23] "./tsconfig.base.json" file was not found in the current directory
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! testing-sb@0.0.0 docs:json: compodoc -p ./tsconfig.base.json -e json -d .
npm ERR! Exit status 1

We should generate the docs:json command based on the user's setup rather than hard-coding it to the latest angular-cli. Help wanted @tooppaaa @kroeder @gaetanmaisse

@LeandroCarolino01 can you help kick this off by telling us more about your setup?

@LeandroCarolino01
Copy link

LeandroCarolino01 commented Jul 20, 2020

Sure, This is my set up
TypeScript version used by Compodoc : 2.9.1

TypeScript version of current project : 3.4.3

Node.js version : v12.18.2

@shilman
Copy link
Member Author

shilman commented Jul 20, 2020

@LeandroCarolino01 how about your angular project? Is it generated by angular-cli? What version? Do you have a single tsconfig.json file or multiple? Do you happen to have the project available publicly?

@LeandroCarolino01
Copy link

I am going to send you the link to the project on github here, thanks
https://github.com/LeandroCarolino01/sb-setup

@shilman
Copy link
Member Author

shilman commented Jul 21, 2020

@LeandroCarolino01 we've updated the CLI so it's now compatible with older versions of angular-cli. After we release the next RC, you can re-run it on a fresh project. Or you can update the breaking line in your package.json:

    "docs:json": "compodoc -p ./tsconfig.json -e json -d .",

@shilman
Copy link
Member Author

shilman commented Jul 21, 2020

Whoopee!! I just released https://github.com/storybookjs/storybook/releases/tag/v6.0.0-rc.13 containing PR #11622 that references this issue. Upgrade today to try it out!

You can find this prerelease on the @next NPM tag.

@LeandroCarolino01
Copy link

Thank you so much, it is working fine now.

# for free to join this conversation on GitHub. Already have an account? # to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants