kibana/packages/kbn-ui-framework
Dzmitry Lemechko b324ca3115
[jest] update config files to get coverage per plugin (#111299)
* [jest] update config files to get coverage per plugin

* [docs] add details about plugin coverage collection

* fix path for newsfeed jest config

* fix lint error

* update documentation

* fix lint errors again

* update doc

* fix another lint error

* Update src/plugins/telemetry_management_section/jest.config.js

Co-authored-by: Luke Elmers <lukeelmers@gmail.com>

* Update src/plugins/telemetry_management_section/jest.config.js

Co-authored-by: Luke Elmers <lukeelmers@gmail.com>

* [kibana_legacy] fix path

Co-authored-by: Luke Elmers <lukeelmers@gmail.com>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-09-09 08:14:56 +02:00
..
dist
BUILD.bazel chore(NA): moving @kbn/ui-framework into bazel (#102908) 2021-06-22 13:11:24 -04:00
package.json
README.md [jest] update config files to get coverage per plugin (#111299) 2021-09-09 08:14:56 +02:00

Deprecation notice

This package is set for deprecation and is actively being removed from Kibana.

The Kibana UI framework is a collection of React elements and Sass styles used to build legacy layouts in Kibana. It was primarily used during the 5.x and 6.x versions and is replaced by the Elastic UI framework. Portions of Kibana still utilize this package and until it is fully removed you can still compile and view the documentation using the instructions below.

Compiling KUI and viewing the docs

Compile the CSS with ./node_modules/grunt/bin/grunt uiFramework:compileCss (OS X) or .\node_modules\grunt\bin\grunt uiFramework:compileCss (Windows).

You can view interactive documentation by running yarn uiFramework:start and then visiting http://localhost:8020/. This will also start watching the SCSS files, and will recompile the CSS automatically for you when you make changes.

You can run node scripts/jest --watch to watch for changes and run the tests as you code.

You can run node scripts/jest --coverage to generate a code coverage report to see how fully-tested the code is.

You can run node scripts/jest --config path/to/plugin/jest.config.js --coverage to generate a code coverage report for a single plugin.

See the documentation in scripts/jest.js for more options.