kuzzleio/plugin-dev

plugin-dev 镜像文档

镜像概述和主要用途

plugin-dev镜像是专为插件或协议开发者设计的专用开发环境镜像，大小约780 MB。该镜像集成了插件与协议开发所需的全套工具链，能够满足实时构建、调试和开发的需求，简化开发流程并提升开发效率。

核心功能和特性

构建项目所需工具

• NVM（Node Version Manager）：支持多Node.js版本管理，已预安装Node.js 6和Node.js 8
• 基础构建工具：包含build-essential（基础编译工具集）、g++（C++编译器）、python（脚本运行环境）
• Ruby环境：集成rbenv（Ruby版本管理工具），支持Ruby相关依赖管理
• 字体配置：包含libfontconfig，支持字体相关构建需求
• 前端工具：
  • gem sass：Sass CSS预处理器，用于样式文件编译
  • npm bower：前端包管理工具，用于管理前端依赖
  • npm node-inspector：Node.js调试工具，支持代码调试

提升开发体验的工具

• 命令行增强：bash-completion提供命令自动补全功能，ll别名（等效于ls -l）简化目录查看操作
• 网络工具：curl和wget用于网络请求与资源下载，满足依赖获取需求

使用场景和适用范围

• 插件开发者：需开发、调试Kuzzle等平台插件，需要实时构建和多Node.js版本支持的场景
• 协议开发者：开发自定义协议实现，需编译、测试协议代码的场景
• 多环境开发：需要在同一环境中切换Node.js 6/8版本进行兼容性测试的开发场景

使用方法和配置说明

基本使用（docker run）

通过以下命令启动交互式开发环境，挂载本地项目目录至容器内进行开发：

bash
docker run -it --rm -v $(pwd):/project kuzzleio/plugin-dev

• -it：以交互式终端模式运行容器
• --rm：容器退出后自动删除，避免残留
• -v $(pwd):/project：将当前目录（本地项目）挂载至容器内/project目录，实现代码实时同步

容器内开发操作

进入容器后，可直接使用集成工具进行开发：

• 切换Node.js版本：nvm use 6 或 nvm use 8
• 安装依赖：npm install 或 bower install
• 编译Sass文件：sass input.scss output.css
• 调试代码：node-inspector 启动调试工具

持久化配置（可选）

若需保存开发环境配置（如自定义别名、工具偏好），可挂载配置目录：

bash
docker run -it --rm -v $(pwd):/project -v ~/.bashrc:/root/.bashrc kuzzleio/plugin-dev

通过挂载本地.bashrc至容器/root/.bashrc，保留自定义命令行配置。