afb09ccf8a
## Dearest Reviewers 👋 I've been working on this branch with @mistic and @tylersmalley and we're really confident in these changes. Additionally, this changes code in nearly every package in the repo so we don't plan to wait for reviews to get in before merging this. If you'd like to have a concern addressed, please feel free to leave a review, but assuming that nobody raises a blocker in the next 24 hours we plan to merge this EOD pacific tomorrow, 12/22. We'll be paying close attention to any issues this causes after merging and work on getting those fixed ASAP. 🚀 --- The operations team is not confident that we'll have the time to achieve what we originally set out to accomplish by moving to Bazel with the time and resources we have available. We have also bought ourselves some headroom with improvements to babel-register, optimizer caching, and typescript project structure. In order to make sure we deliver packages as quickly as possible (many teams really want them), with a usable and familiar developer experience, this PR removes Bazel for building packages in favor of using the same JIT transpilation we use for plugins. Additionally, packages now use `kbn_references` (again, just copying the dx from plugins to packages). Because of the complex relationships between packages/plugins and in order to prepare ourselves for automatic dependency detection tools we plan to use in the future, this PR also introduces a "TS Project Linter" which will validate that every tsconfig.json file meets a few requirements: 1. the chain of base config files extended by each config includes `tsconfig.base.json` and not `tsconfig.json` 1. the `include` config is used, and not `files` 2. the `exclude` config includes `target/**/*` 3. the `outDir` compiler option is specified as `target/types` 1. none of these compiler options are specified: `declaration`, `declarationMap`, `emitDeclarationOnly`, `skipLibCheck`, `target`, `paths` 4. all references to other packages/plugins use their pkg id, ie: ```js // valid { "kbn_references": ["@kbn/core"] } // not valid { "kbn_references": [{ "path": "../../../src/core/tsconfig.json" }] } ``` 5. only packages/plugins which are imported somewhere in the ts code are listed in `kbn_references` This linter is not only validating all of the tsconfig.json files, but it also will fix these config files to deal with just about any violation that can be produced. Just run `node scripts/ts_project_linter --fix` locally to apply these fixes, or let CI take care of automatically fixing things and pushing the changes to your PR. > **Example:** [` |
||
|---|---|---|
| .. | ||
| dist | ||
| kibana.jsonc | ||
| package.json | ||
| README.md | ||
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.