<!-- Thank you for your interest in and contributing to Kibana! There are a few simple things to check before submitting your pull request that can help with the review process. You should delete these items from your submission, but they are here to help bring them to your attention. - Have you signed the [contributor license agreement](https://www.elastic.co/contributor-agreement)? - Have you followed the [contributor guidelines](https://github.com/elastic/kibana/blob/master/CONTRIBUTING.md)? - If submitting code, have you included unit tests that cover the changes? - If submitting code, have you tested and built your code locally prior to submission with `yarn test && yarn build`? - If submitting code, is your pull request against master? Unless there is a good reason otherwise, we prefer pull requests against master and will backport as needed. --> Make relevant generated files use snakeCase instead of kebabCase Closes #20524 |
||
---|---|---|
.. | ||
sao_template | ||
index.js | ||
package.json | ||
README.md | ||
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 my_plugin_name
# generates a plugin in `../kibana-extra/my_plugin_name`
To target 6.3, use the 6.x
branch (until the 6.3
branch is created).
git checkout 6.x
yarn kbn bootstrap # always bootstrap when switching branches
node scripts/generate_plugin my_plugin_name
# generates a plugin for Kibana 6.3 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
upstream
is 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 bootstrap
Install dependencies and crosslink Kibana and all projects/plugins.
IMPORTANT: Use this script instead of
yarn
to install dependencies when switching branches, and re-run it whenever your dependencies change. -
yarn start
Start kibana and have it include this plugin. You can pass any arguments that you would normally send to
bin/kibana
yarn start --elasticsearch.url http://localhost:9220
-
yarn build
Build a distributable archive of your plugin.
-
yarn test:browser
Run the browser tests in a real web browser.
-
yarn test:server
Run 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.