Empty documentation.json in Compodocs + Storybook + Angular 9

5.3k views Asked by At

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?

2

There are 2 answers

2
nikoswsn On BEST ANSWER

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

1
Vaisakh Pradeep On

Use tsconfig.base.json instead of tsconfig.json