kibana/packages
Brandon Kobel 170a2956c8
Updating the License (#88343)
* Updating the Licenses, except for applying eslint, building

* Applying ESLint rules,building @kbn/pm, regenerating api docs
2021-01-19 17:52:56 -08:00
..
elastic-datemath chore(NA): move elastic-datemath from mocha into jest (#87351) 2021-01-06 18:18:28 +00:00
elastic-eslint-config-kibana Update typescript eslint to v4.8 (#83520) 2020-11-18 18:23:08 +01:00
elastic-safer-lodash-set chore(NA): move into single pkg json (#80015) 2020-11-02 21:18:52 +00:00
kbn-ace Updating the License (#88343) 2021-01-19 17:52:56 -08:00
kbn-analytics Updating the License (#88343) 2021-01-19 17:52:56 -08:00
kbn-apm-config-loader Updating the License (#88343) 2021-01-19 17:52:56 -08:00
kbn-babel-code-parser Updating the License (#88343) 2021-01-19 17:52:56 -08:00
kbn-babel-preset Updating the License (#88343) 2021-01-19 17:52:56 -08:00
kbn-config Updating the License (#88343) 2021-01-19 17:52:56 -08:00
kbn-config-schema Updating the License (#88343) 2021-01-19 17:52:56 -08:00
kbn-dev-utils Updating the License (#88343) 2021-01-19 17:52:56 -08:00
kbn-es Updating the License (#88343) 2021-01-19 17:52:56 -08:00
kbn-es-archiver Updating the License (#88343) 2021-01-19 17:52:56 -08:00
kbn-eslint-import-resolver-kibana Updating the License (#88343) 2021-01-19 17:52:56 -08:00
kbn-eslint-plugin-eslint Updating the License (#88343) 2021-01-19 17:52:56 -08:00
kbn-expect [kbn/bootstrap] validate that certain deps don't ship in production (#80549) 2020-10-15 09:56:10 -07:00
kbn-i18n Updating the License (#88343) 2021-01-19 17:52:56 -08:00
kbn-interpreter Updating the License (#88343) 2021-01-19 17:52:56 -08:00
kbn-legacy-logging Updating the License (#88343) 2021-01-19 17:52:56 -08:00
kbn-logging Updating the License (#88343) 2021-01-19 17:52:56 -08:00
kbn-monaco Updating the License (#88343) 2021-01-19 17:52:56 -08:00
kbn-optimizer Updating the License (#88343) 2021-01-19 17:52:56 -08:00
kbn-plugin-generator Updating the License (#88343) 2021-01-19 17:52:56 -08:00
kbn-plugin-helpers Updating the License (#88343) 2021-01-19 17:52:56 -08:00
kbn-pm Updating the License (#88343) 2021-01-19 17:52:56 -08:00
kbn-release-notes Updating the License (#88343) 2021-01-19 17:52:56 -08:00
kbn-spec-to-console Updating the License (#88343) 2021-01-19 17:52:56 -08:00
kbn-std Updating the License (#88343) 2021-01-19 17:52:56 -08:00
kbn-storybook Updating the License (#88343) 2021-01-19 17:52:56 -08:00
kbn-telemetry-tools Updating the License (#88343) 2021-01-19 17:52:56 -08:00
kbn-test Updating the License (#88343) 2021-01-19 17:52:56 -08:00
kbn-test-subj-selector Updating the License (#88343) 2021-01-19 17:52:56 -08:00
kbn-ui-framework Updating the License (#88343) 2021-01-19 17:52:56 -08:00
kbn-ui-shared-deps Updating the License (#88343) 2021-01-19 17:52:56 -08:00
kbn-utility-types Updating the License (#88343) 2021-01-19 17:52:56 -08:00
kbn-utils Updating the License (#88343) 2021-01-19 17:52:56 -08:00
README.md chore(NA): remove mocha junit ci integrations (#88129) 2021-01-15 21:17:25 +00: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 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 or yarn 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.