Empty documentation.json in Compodocs + Storybook + Angular 9

Question

I started to use compodoc + storybook in a Angular 9 project.

Installed all the dependencies and Storybook is working fine, but for some reason the documentation.json generated by compodoc is empty, like this:

{
    "pipes": [],
    "interfaces": [],
    "injectables": [],
    "classes": [],
    "directives": [],
    "components": [],
    "modules": [],
    "miscellaneous": [],
    "routes": [],
    "coverage": {
        "count": 0,
        "status": "low",
        "files": []
    }
}

The command I'm using is:

compodoc -p .storybook/tsconfig.json -e json -d ./.storybook

And my tsconfig.json is:

{
  "extends": "../src/tsconfig.app.json",
  "compilerOptions": {
    "types": [
      "node"
    ]
  },
  "exclude": [
    "../src/test.ts",
    "../src/**/*.spec.ts",
    "../projects/**/*.spec.ts"
  ],
  "include": [
    "../src/**/*",
    "../projects/**/*"
  ],
  "files": [
    "./typings.d.ts"
  ]
}

Any ideas of what may be wrong?

@Dekim Not yet. It seems to be a bug. Unfortunately. :( github.com/compodoc/compodoc/issues/951 — dvc.junior
– dvc.junior, Commented May 11, 2020 at 18:33

nikoswsn · Accepted Answer · 2020-06-13 14:48:49Z

11

After switching from -p tsconfig.app.json to -p tsconfig.json it worked. We have both files, but I think compodoc does not understand that tsconfig.app.json extends the tsconfig.json file since both are written in JSON and there is no such thing as dependency.

Source

answered Jun 13, 2020 at 14:48

nikoswsn

1923 silver badges11 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

dvc.junior Over a year ago

Well, that did the trick. My command became: compodoc -p tsconfig.json -e json -d ./.storybook and now it works!

Vaisakh Pradeep · Accepted Answer · 2020-08-19 12:16:23Z

6

Use tsconfig.base.json instead of tsconfig.json

answered Aug 19, 2020 at 12:16

Vaisakh Pradeep

1411 silver badge3 bronze badges

1 Comment

ForestG Over a year ago

The accepted answer did not work for me, but this. Angular 10, newly created project.

ランス · Accepted Answer · 2024-04-16 23:16:25Z

0

What worked for me was having this in the package.json.

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

Our team uses a separate project for the Angular library and the Storybook in another. We just make sure the documentation.json for both of the projects is always the same.

And, we switched off the compodoc flag in storybook so it doesn't try to overwrite what we pasted.

edited Apr 16, 2024 at 23:16

answered Apr 9, 2024 at 2:08

ランス

6003 silver badges12 bronze badges

Collectives™ on Stack Overflow

Empty documentation.json in Compodocs + Storybook + Angular 9

3 Answers 3

1 Comment

1 Comment

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

1 Comment

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Related