Typed plugins in new platform #12857
Conversation
kimjoar
force-pushed
the
plugin-types
branch
3 times, most recently
from
598f3e7 to
4783b64
Compare
kimjoar
changed the title
packages/kbn-types/README.md
Outdated
|
|
||
| Now external code can use this package, e.g. something like this: | ||
|
|
||
| ```js |
There was a problem hiding this comment.
optional nit: maybe typescript instead of js? Webstorm supports it (and also complains if we try to highlight typescript with js hint), but not sure if it's standard and your IDE supports it as well, so up to you.
packages/kbn-types/.gitignore
Outdated
| @@ -0,0 +1 @@ | |||
| types/ | |||
There was a problem hiding this comment.
question: what is the difference between packages/@elastic/...package-name... and packages/...package-name...? Should we put kbn-types package under @elastic or is there any reason why we shouldn't?
There was a problem hiding this comment.
Moved it to @elastic. We'll likely never push anything that's not under @elastic, so don't really see the point of that folder, but it's something we can solve later
| }); | ||
|
|
||
| const router = http.createAndRegisterRouter('/api/foo', {}); | ||
| } |
There was a problem hiding this comment.
nit: ;
question:: also wondering if we should include TS in packages/... while running npm run prettier?
packages/kbn-types/README.md
Outdated
|
|
||
| If you want to play around with an example, see the `./example` folder. | ||
|
|
||
| ## Exposing types |
I think this is the simplest way to build external plugins with types. Added a
kbn-typespackage that contains a file that exports whatever we want to export from core, then use TS to build declaration files. See the readme in thekbn-typespackage for more info.I'll create issues for some follow-ups. One is having CI build the package and make sure the error code is 0, as we otherwise have broken external types. Not really sure how to otherwise test this, e.g. making sure the right things are available etc. Another follow-up is exploring if we should commit the types, e.g. to make "breaking changes" to the types more obvious.
I've got a feeling it should be possible to further minimise the exposed types, but if this works, I think this is probably a good enough start, then we can learn as we start trying to make core plugins truly "independent" (separate package.json etc).