* Adds boilerplate for new hook-utils package * Move existing, identified utils into our hook-utils package Updates references, and fixes a few missing config that were preventing packages from building. * Extracts a common type and adds a little more JSdoc for clarity * Adds new useObservable hook Similar to useAsync (a nearly identical interface), this is meant to wrap a thunk returning an observable, allowing conditional invocation and progressive updates as the observable continues to emit. * Remove orphaned test This function (and its tests) were moved to the hook-utils package; this was simply missed. * Remove optional chaining from kbn package The build system does not currently support these typescript features. While a valid fix would also have been to build separate browser and node targets a la #99390, the use here was very minimal and so changing to a supported syntax was the most pragmatic fix. * Update old reference in test file Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com> |
||
---|---|---|
.. | ||
elastic-datemath | ||
elastic-eslint-config-kibana | ||
elastic-safer-lodash-set | ||
kbn-ace | ||
kbn-analytics | ||
kbn-apm-config-loader | ||
kbn-apm-utils | ||
kbn-babel-code-parser | ||
kbn-babel-preset | ||
kbn-cli-dev-mode | ||
kbn-common-utils | ||
kbn-config | ||
kbn-config-schema | ||
kbn-crypto | ||
kbn-dev-utils | ||
kbn-docs-utils | ||
kbn-es | ||
kbn-es-archiver | ||
kbn-eslint-import-resolver-kibana | ||
kbn-eslint-plugin-eslint | ||
kbn-expect | ||
kbn-i18n | ||
kbn-interpreter | ||
kbn-io-ts-utils | ||
kbn-legacy-logging | ||
kbn-logging | ||
kbn-mapbox-gl | ||
kbn-monaco | ||
kbn-optimizer | ||
kbn-plugin-generator | ||
kbn-plugin-helpers | ||
kbn-pm | ||
kbn-rule-data-utils | ||
kbn-securitysolution-es-utils | ||
kbn-securitysolution-hook-utils | ||
kbn-securitysolution-io-ts-alerting-types | ||
kbn-securitysolution-io-ts-list-types | ||
kbn-securitysolution-io-ts-types | ||
kbn-securitysolution-io-ts-utils | ||
kbn-securitysolution-list-api | ||
kbn-securitysolution-list-constants | ||
kbn-securitysolution-list-hooks | ||
kbn-securitysolution-list-utils | ||
kbn-securitysolution-utils | ||
kbn-server-http-tools | ||
kbn-server-route-repository | ||
kbn-spec-to-console | ||
kbn-std | ||
kbn-storybook | ||
kbn-telemetry-tools | ||
kbn-test | ||
kbn-test-subj-selector | ||
kbn-tinymath | ||
kbn-ui-framework | ||
kbn-ui-shared-deps | ||
kbn-utility-types | ||
kbn-utils | ||
BUILD.bazel | ||
README.md |
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
inpackage.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 yarn workspaces, which sets up a symlink to the package.
For example if you want to use the @kbn/i18n
package in Kibana itself, you
can specify the dependency like this:
"@kbn/i18n": "1.0.0"
However, if you want to use this from a Kibana plugin, you need to use a link:
dependency and account for the relative location of the Kibana repo, so it would
instead be:
"@kbn/i18n": "link:../../kibana/packages/kbn-i18n"
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/i18n
the folder name
should be kbn-i18n
.
All new packages should use the @kbn
namespace, and should be marked with
"private": true
.
Unit tests for a package
Currently there is only one tool being used in order to test packages which is Jest. Below we will explain how it should be done.
Jest
A package should follow the pattern of having .test.js
files as siblings of the source code files, and these run by Jest.
A package using the .test.js
naming convention will have those tests automatically picked up by Jest and run by the unit test runner, currently mapped to the Kibana test
script in the root package.json
.
yarn test
oryarn grunt test
runs all unit tests.yarn jest
runs all Jest tests in Kibana.
In order for the plugin or package to use Jest, a jest.config.js file must be present in it's root. However, there are safeguards for this in CI should a test file be added without a corresponding config file.
Each package can also specify its own test
script in the package's package.json
, for cases where you'd prefer to run the tests from the local package directory.