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

[Bug]: not provided path of components to "include" property in tsconfig.json / not detect jsdoc comments #27135

Open
Kordrad opened this issue May 14, 2024 · 1 comment

Comments

@Kordrad
Copy link

Kordrad commented May 14, 2024

Describe the bug

image
As on the img, by default, path to components is not added to tsconfig.json file. I spent too many hours wondering why my compdoc not generated documentation about my components.

To Reproduce

  1. Create new angular app.
  2. Create new library
  3. Add storybook by CLI command to library
  4. see projects/mylib/.storybook/tsconfig.json

System

System:
    OS: Windows 11 10.0.22631
    CPU: (16) x64 AMD Ryzen 9 5900HS with Radeon Graphics        
  Binaries:
    Node: 20.12.2 - C:\Program Files\nodejs\node.EXE
    npm: 10.5.0 - C:\Program Files\nodejs\npm.CMD <----- active
    pnpm: 8.12.0 - ~\AppData\Local\pnpm\pnpm.EXE
  Browsers:
    Edge: Chromium (123.0.2420.97)
  npmPackages:
    @storybook/addon-docs: ^8.1.0 => 8.1.0 
    @storybook/addon-essentials: ^8.1.0 => 8.1.0 
    @storybook/addon-interactions: ^8.1.0 => 8.1.0 
    @storybook/addon-links: ^8.1.0 => 8.1.0 
    @storybook/angular: ^8.1.0 => 8.1.0 
    @storybook/blocks: ^8.1.0 => 8.1.0 
    @storybook/test: ^8.1.0 => 8.1.0 
    eslint-plugin-storybook: ^0.8.0 => 0.8.0 
    storybook: ^8.1.0 => 8.1.0

Additional context

"../src/**/*.component.ts" should be added

@shilman
Copy link
Member

shilman commented May 19, 2024

@kroeder does your docgen solution fix this? cc @valentinpalkovic

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

No branches or pull requests

2 participants