0b03166d2d
* [eslint] unify resolver configs Our eslint resolver settings currently rely on the fact that we define our resolver with a string globally, and an object in the overrides. This causes the override value to completely override/replace the global setting, which is desired, but when the global setting is converted to an object they are merged, causing both resolvers to run. This is a problem because some dependencies in the UI side of things will resolve with the node resolver, but will resolve incorrectly because they are intended to use some webpack specific override. While trying to add TypeScript I needed to pass argument to the node resolver which uncovered this issue. The change here moves us away from using the node resolver directly and instead uses the kibana resolver with `forceNode: true` set when linting server code and `forceNode: false` when resolving imports that will be handled by webpack. * [import-resolver] use object spread operator |
||
|---|---|---|
| .. | ||
| eslint-config-kibana | ||
| eslint-plugin-kibana-custom | ||
| kbn-babel-preset | ||
| kbn-datemath | ||
| kbn-dev-utils | ||
| kbn-es | ||
| kbn-eslint-import-resolver-kibana | ||
| kbn-eslint-plugin-license-header | ||
| kbn-plugin-generator | ||
| kbn-plugin-helpers | ||
| kbn-pm | ||
| kbn-system-loader | ||
| kbn-test | ||
| kbn-test-subj-selector | ||
| kbn-ui-framework | ||
| 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
@kbnnamespace - Always set
"private": trueinpackage.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.
Unit tests for a package
Currently there are two patterns used to test packages, one using Mocha and one using Jest. These patterns emerged out of convention and we'd like to make them more similar to each other in the near future.
1. Mocha
Today a package can follow the pattern of having a __tests__ directory in each source code directory of a package which contains the tests for that module. These are usually run by Mocha.
If a package's tests should be run with Mocha, you'll have to opt-in to run them by appending the package's test file pattern(s) to Kibana's tasks/config/simplemocha.js file. These will then be run by the unit test runner.
yarn testoryarn grunt testruns all unit tests.node scripts/mocharuns all Mocha tests.
2. Jest
A package can also 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 testoryarn grunt testruns all unit tests.node scripts/jestruns all Jest tests in Kibana.
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.