github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 17:28:26 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/packages/kbn-type-summarizer
History
Exact
Kibana Machine 2f310d87c0
chore(NA): downgrades rules nodejs into v4.7.0 (#130347) (#130354) 
* chore(NA): downgrade rules nodejs into v4.0.0

* chore(NA): include windows patch

* chore(NA): polish downgrade code

* chore(NA): include yarn.lock

(cherry picked from commit 0b2da10a7d)

Co-authored-by: Tiago Costa <tiago.costa@elastic.co>
2022-04-14 21:39:51 -07:00
..
src [plugin-discovery] move logic to a package (#128684) 2022-03-29 13:19:58 -06:00
BUILD.bazel chore(NA): downgrades rules nodejs into v4.7.0 (#130347) (#130354) 2022-04-14 21:39:51 -07:00
jest.config.js [ts] enable sourcemaps in summarized types of @kbn/crypto (#126410) 2022-03-04 08:02:02 -06:00
jest.integration.config.js [ts] enable sourcemaps in summarized types of @kbn/crypto (#126410) 2022-03-04 08:02:02 -06:00
package.json [eslint] automatically determine dev packages (#127089) 2022-03-08 07:42:06 -06:00
README.md [ts] enable sourcemaps in summarized types of @kbn/crypto (#126410) 2022-03-04 08:02:02 -06:00
tsconfig.json [type-summarizer] always use normalized paths, fix windows compat (#127055) 2022-03-07 16:04:54 -06:00

README.md

@kbn/type-summarizer

Consume the .d.ts files for a package, produced by tsc, and generate a single .d.ts file of the public types along with a source map that points back to the original source.

You mean like API Extractor?

Yeah, except with source map support and without all the legacy features and other features we disable to generate our current type summaries.

I first attempted to implement this in api-extractor but I (@spalger) hit a wall when dealing with the Span class. This class handles all the text output which ends up becoming source code, and I wasn't able to find a way to associate specific spans with source locations without getting 12 headaches. Instead I decided to try implementing this from scratch, reducing our reliance on the api-extractor project and putting us in control of how we generate type summaries.

This package is missing some critical features for wider adoption, but rather than build the entire product in a branch I decided to implement support for a small number of TS features and put this to use in the @kbn/crypto module ASAP.

The plan is to expand to other packages in the Kibana repo, adding support for language features as we go.

Something isn't working and I'm blocked!

If there's a problem with the implmentation blocking another team at any point we can move the package back to using api-extractor by removing the package from the TYPE_SUMMARIZER_PACKAGES list at the top of packages/kbn-type-summarizer/src/lib/bazel_cli_config.ts.