mirror of
https://github.com/elastic/kibana.git
synced 2025-04-25 10:23:14 -04:00
b2f48f2d54
The existing `build_api_docs` script takes about ~10m to run and generate the API docs. That's not too bad for the daily CI task that generates the docs. However, even if you're just interested in getting some stats on a single plugin/package it runs the full script. We often have to run this script locally to check the stats in detail to improve JSDoc and missing exports which is quite cumbersome if it takes this long to run after each code change. This PR updates the script in the following way: If both the options `--stats` and `--plugin` (with a single plugin/package) are set, it will not generate a TS project for the whole Kibana codebase but just the code related to that plugin/package. API docs will then not be written to avoid inconsistencies and just the stats will be logged. Depending on the size of the package/plugin this can reduce the time needed to run the script down to a few seconds. |
||
|---|---|---|
| .. | ||
| src | ||
| index.ts | ||
| jest.config.js | ||
| jest.integration.config.js | ||
| kibana.jsonc | ||
| package.json | ||
| tsconfig.json | ||