kibana/packages/kbn-ui-framework
Spencer 4e8ab56497
build immutable bundles for new platform plugins (#53976)
* build immutable bundles for new platform plugins

* only inspect workers if configured to do so

* [navigation] use an index.scss file

* add yarn.lock symlink

* set pluginScanDirs in test so fixtures stay consistent

* cleanup helpers a little

* fix type error

* support KBN_OPTIMIZER_MAX_WORKERS for limiting workers via env

* test support for KBN_OPTIMIZER_MAX_WORKERS

* expand the available memory for workers when only running one or two

* add docs about KBN_OPTIMIZER_MAX_WORKERS environment variable

* fix README link

* update kbn/pm dist

* implement bundle caching/reuse

* update kbn/pm dist

* don't check for cache if --no-cache is passed

* update renovate config

* standardize on index.scss, move console styles over

* add support for --no-cache to cli

* include worker config vars in optimizer version

* ignore concatenated modules

* update integration test

* add safari to browserslist to avoid user-agent warnings in dev

* update docs, clean up optimizer message/misc naming

* always handle initialized messages, don't ignore states that are attached to specific events

* reword caching docs, add environment var to disable caching

* tweak logging and don't use optimizer.useBundleCache as that's disabled in dev

* handle change notifications

* batch changes for 1 second

* rename CompilerState type to CompilerMsg

* getChanges() no longer needs to assign changes to dirs

* remove unused deps

* split up run_worker.ts and share cacheKey generation logic

* add a couple docs

* update tests and remove unused imports

* specify files when creating bundle cache key

* remove one more unused import

* match existing dev cli output more closely

* update kbn/pm dist

* set KBN_NP_PLUGINS_BUILT to avoid warning in CI

* avoid extending global window type

* add note to keep pluginScanDirs in sync

* pass browserslistEnv in workerConfig so it is used for cache key

* load commons.bundle.js in parallel too

* emit initialized+success states if all bundles are cached

* load bootstraps as quickly as possible

* skip flaky suite

* bump

* update jest snapshots

* remove hashing from cache key generation

* remove unnecessary non-null assertion

* improve docs and break up Optimizer#run()

* remove unused import

* refactor kbn/optimizer to break up observable logic, implement more helpful cache invalidation logic with logging

* fix tests

* add initializing phase

* avoid rxjs observable constructor

* remove unnecessary rxjs helper, add tests for bundle cache

* update consumers of optimizer

* update readme with new call style

* replace "new platform" with "kibana platform"

* fix a couple more renames

* add support for several plain-text file formats

* fix naming of OptimizerMsg => OptimizerUpdate, use "store" naming too

* one more OptimizerMsg update

* ensure bundles are not cached when cache config is false

* test for initializing states and bundle cache events

* remove unnecessary timeout change

* Remove unnecessary helpers

* Add tests for BundleCache class

* Add tests for Bundle class

* test summarizeEvent$

* missing paths are no longer listed in mtimes map

* add tests for optimizer/cache_keys

* Add some extra docs

* Remove labeled loop

* add integration test for kbn-optimizer watcher components

* querystring-browser removed

* tweak logging a smidge, improve info and final message

* remove unused imports

* remove duplication of getModuleCount() method

* move type annotation that validates things

* clear up the build completion message

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2020-02-12 19:42:42 -07:00
..
components Apache 2.0 license headers (#19383) 2018-05-28 20:06:30 -07:00
dist Upgrade EUI to v17.0.0 (#52342) 2019-12-09 10:51:17 -06:00
doc_site ensure prettier overrides take precedence, remove style rules 2019-12-14 17:39:10 -07:00
generator-kui autofix all violations 2019-12-13 23:17:13 -07:00
src autofix all violations 2019-12-13 23:17:13 -07:00
Gruntfile.js autofix all violations 2019-12-13 23:17:13 -07:00
package.json build immutable bundles for new platform plugins (#53976) 2020-02-12 19:42:42 -07:00
README.md Update readme for KUI to note deprecation (#34389) 2019-04-02 14:38:45 -07:00
yarn.lock Add lockfile symlinks (#55440) 2020-01-27 11:38:20 -05: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.

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