e9e0ca3782
* move test_helpers to the core * create base tsconfig * all tsconfigs use the base one * use test_helpers exposed from the src/core * move getFieldFormatsRegistry to data plugin * add test_utils project * compile types after checkout * add a stub for platform tsconfig.json * fix broken import * fix broken path to the base config * set tsBuildInfoFile for project without outDir * do not commit tsbuildinfo file * do not check output d.ts files * fix type error * use separate config to build types * rollback changes to include paths * mute import zone error * rename files to avoid references to tsd * do not use tsd for type tests * include all ts files in project * run buildRefs before type check to ensure the latest version * store tsbuildinfo locally * update paths to base config * comment out core/tsconfig.json * remove ui path * fix wrong tsbuildinfo path |
||
|---|---|---|
| .. | ||
| scripts | ||
| src | ||
| template | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
| yarn.lock | ||
Kibana Plugin Generator
This package can be used to generate a Kibana plugin from the Kibana repo.
Setup
Before you can use this plugin generator you must setup your Kibana development environment. If you can successfully run yarn kbn bootstrap then you are ready to generate plugins!
Compatibility
The plugin generator became a part of the Kibana project as of Kibana 6.3. If you are targeting versions before Kibana 6.3 then use the Kibana plugin sao template.
If you are targeting Kibana 6.3 or greater then checkout the corresponding Kibana branch and run the plugin generator.
Quick Start
To target the current development version of Kibana just use the default master branch.
node scripts/generate_plugin --name my_plugin_name -y
# generates a plugin in `plugins/my_plugin_name`
To target 6.8, use the 6.8 branch.
git checkout 6.x
yarn kbn bootstrap # always bootstrap when switching branches
node scripts/generate_plugin --name my_plugin_name -y
# generates a plugin for Kibana 6.8 in `../kibana-extra/my_plugin_name`
The generate script supports a few flags; run it with the --help flag to learn more.
node scripts/generate_plugin --help
Updating
Since the Plugin Generator is now a part of the Kibana repo, when you update your local checkout of the Kibana repository and bootstrap everything should be up to date!
NOTE: These commands should be run from the Kibana repo, and
upstreamis our convention for the git remote that references https://github.com/elastic/kibana.git, unless you added this remote you might need to useorigin.
git pull upstream master
yarn kbn bootstrap
Plugin Development Scripts
Generated plugins receive a handful of scripts that can be used during development. Those scripts are detailed in the README.md file in each newly generated plugin, and expose the scripts provided by the Kibana plugin helpers, but here is a quick reference in case you need it:
NOTE: All of these scripts should be run from the generated plugin.
-
yarn kbn bootstrapInstall dependencies and crosslink Kibana and all projects/plugins.
IMPORTANT: Use this script instead of
yarnto install dependencies when switching branches, and re-run it whenever your dependencies change. -
yarn startStart kibana and have it include this plugin. You can pass any arguments that you would normally send to
bin/kibanayarn start --elasticsearch.hosts http://localhost:9220 -
yarn buildBuild a distributable archive of your plugin.
-
yarn test:mochaRun the server tests using mocha.
For more information about any of these commands run yarn ${task} --help. For a full list of tasks run yarn run or take a look in the package.json file.