kibana/packages
archana 409af00d4d
Move proc_runner from x-pack-kibana into kibana (#17120)
* [tests] add proc_runner from x-pack-kibana

* [tests] implement proc_runner deps

* [tests] fix proc_runner dep

* [packages] move proc_runner into kbn-proc-runner

* [kbn-proc-runner] Package it

* [kbn-proc-runner] Chalk it up

* [kbn-proc-runner] Package.json

* Both kbn-proc-runner and kbn-utils depending on review. Sigh.

* Rename to kbn-dev-util, remove kbn-proc-runner

* Test proc-runner

* Add babel

* [proc-runner] build fixes

* Recreate yarn.locks, add mocha tests to simplemocha config
2018-03-14 19:55:50 -05:00
..
eslint-config-kibana [kbn-pm] Include Kibana's transitive _projects_ in build (#16813) 2018-03-12 11:00:27 +01:00
eslint-plugin-kibana-custom [packages] add licenses (#17072) 2018-03-12 12:39:38 -05:00
kbn-babel-preset Babel preset package (#16479) 2018-02-03 12:24:16 -07:00
kbn-datemath Production package example: datemath (#16531) 2018-02-13 21:49:55 +01:00
kbn-dev-utils Move proc_runner from x-pack-kibana into kibana (#17120) 2018-03-14 19:55:50 -05:00
kbn-plugin-generator [packages] add licenses (#17072) 2018-03-12 12:39:38 -05:00
kbn-plugin-helpers [plugin-helpers] allow opt-ing out of dependency installation (#16816) 2018-02-20 16:28:22 -07:00
kbn-pm [kbn-pm] Update ora typings. Remove redundant types in commands. (#17096) 2018-03-12 13:08:18 +01:00
kbn-test-subj-selector Add test-subj-selector module to packages dir. (#16623) 2018-02-13 10:34:47 -08:00
kbn-ui-framework [@kbn/ui-framework] move ui-framework to a package (#17085) 2018-03-13 10:43:39 -07:00
README.md [kbn-pm] rename from kbn-build (#16739) 2018-02-14 10:57:13 -07:00

Kibana-related packages

This folder contains packages that are intended for use in Kibana and Kibana plugins.

tl;dr:

  • Don't publish to npm registry
  • Always use the @kbn namespace
  • Always set "private": true in package.json

Using these packages

We no longer publish these packages to the npm registry. Now, instead of specifying a version when including these packages, we rely on link: dependencies in Yarn, which sets up a symlink to the package.

For example if you want to use the @kbn/datemath package in Kibana itself, you can specify the dependency like this:

"@kbn/datemath": "link:packages/kbn-datemath"

However, if you want to use this from a Kibana plugin, you need to account for the relative location of the Kibana repo, so it would instead be:

"@kbn/datemath": "link:../../kibana/packages/kbn-datemath"

How all of this works is described in more detail in the @kbn/pm docs.

Creating a new package

Create a new sub-folder. The name of the folder should mirror the name in the package's package.json. E.g. if the name is @kbn/datemath the folder name should be kbn-datemath.

All new packages should use the @kbn namespace, and should be marked with "private": true.