开发环境搭建

优质
小牛编辑
145浏览
2023-12-01

要开发kibana 插件,首先要在本地搭建开发环境,我这里推荐使用vs code,如果问我为什么,我只想说这么火的开发工具,不用一下,怎么跟上世界开发潮流呢。

第一步

首先 需要安装node.js,可以去官网下载最新版本,对于如何安装就不废话了。

第二步

下载 kibana 源代码,在github下载即可。

第三步

在kibana项目根目录下执行

1. $ git tag
2. $ git checkout 指定version

第四步

从6.x版本,kibana官方更新了包管理方式,使用了yarn,使用后的感觉是这个超级棒,值得推荐!

  1. 安装nvm

    Install the version of Node.js listed in the .node-version file. This can be automated with tools such as nvm, nvm-windows or avn. As we also include a .nvmrc file you can switch to the correct version when using nvm by running:

     nvm use
  2. 安装yarn

    npm install -g yarn

  3. 下载依赖

    yarn kbn bootstrap

  4. 运行

    yarn start

额外话题

最近搭建最新版kibana v7.1.1,发现无法启动,现象是重复启动,经过查看文档后,发现是node存在的一个问题。

解决办法如下:

在下载依赖成功以后,以管理员权限在cmd中执行fsutil behavior set disablelastaccess 1,然后再执行yarn start即可。

VS Code 搭配开发技巧

关于vs code强大我就不介绍了,这不是本文的重点。这块主要是建议安装的一些插件:

  1. Prettier formatter
  2. Auto Close Tag
  3. Path Intellisense
  4. JavaScript (ES6) code snippets

建议将其他格式化插件禁用,多个格式化插件可能格式化完还是会爆红,这个是我目前发现格式化kibana代码最好的插件

关于debug,目前版本还无法配置,有看到官方提到在7.x版本,就可以在vscode 中配置debug了。具体如何配置参考vscode debug教程。(如果有人现在知道的话,欢迎帮忙添加)

不同版本环境搭建

5.5.1

这步非常重要,绝大部分无法正常启动kibana 项目,都是由于无法安装完整所有依赖,即npm install 执行过程报错。强烈建议有VPN,使用npm install,我尝试过cnpm install ,虽然执行不错,但是有部分依赖无法下载下来,造成启动失败。

在公司开发的人请注意,公司防火墙可能会限制从github 中下载依赖,这块需要将所有git下载代码由ssh强制更换成http。 修改方式如下:

git config --global url."https://".insteadOf "git://"

或者在.gitconfig文件中添加

[url "https://"]
    insteadOf = git://

两者原理一样,都是将ssh 方式转换成http方式。

以上改动是5.5.1版本需要做的

6.4.0

npm install -g yarn@1.6 注意:我这里安装的是1.6版本,yarn最新版本已经是1.7,使用该版本无法工作,暂未追究原因,这块需要注意。

7.1.1

发现无法启动,现象是重复启动,经过查看文档后,发现是node存在的一个问题。

解决办法如下:

在下载依赖成功以后,以管理员权限在cmd中执行fsutil behavior set disablelastaccess 1,然后再执行yarn start即可。

参考

  1. setting-up-your-development-environment
  2. fs.watch says every single file in my folder changed, randomly
  3. [dev mode] Kibana regularly considers (wrongly) that all source files have changed and continuously restart