Kong Pongo 项目教程

1. 项目的目录结构及介绍

Kong Pongo 项目的目录结构如下：

kong-pongo/
├── assets/
├── kong-versions/
├── github/workflows/
├── .editorconfig
├── .gitattributes
├── .gitignore
├── .shellcheckrc
├── CHANGELOG.md
├── LICENSE
├── Makefile
├── README.md
└── pongo.sh

目录结构介绍

• assets/: 存放项目相关的资源文件。
• kong-versions/: 存放与 Kong 版本相关的配置文件。
• github/workflows/: 存放 GitHub Actions 的工作流配置文件。
• .editorconfig: 编辑器配置文件，用于统一代码风格。
• .gitattributes: Git 属性配置文件，用于指定文件的属性。
• .gitignore: Git 忽略文件配置，指定哪些文件不需要被 Git 管理。
• .shellcheckrc: ShellCheck 配置文件，用于检查 Shell 脚本的语法和风格。
• CHANGELOG.md: 项目变更日志文件。
• LICENSE: 项目许可证文件。
• Makefile: 项目的 Makefile 文件，用于自动化构建和测试。
• README.md: 项目的说明文档。
• pongo.sh: 项目的启动脚本，用于运行插件测试。

2. 项目的启动文件介绍

pongo.sh

pongo.sh 是 Kong Pongo 项目的启动脚本，用于运行插件测试。它提供了多种命令来初始化、构建、运行测试等操作。以下是一些常用的命令：

• pongo init: 初始化当前插件目录，生成默认的配置文件。
• pongo lint: 运行 LuaCheck 代码检查工具。
• pongo pack: 打包所有 *.rockspec 文件为 *.rock 文件，用于分发。
• pongo run: 运行测试文件，支持 Busted 选项和测试文件/文件夹作为参数。
• pongo shell: 获取一个直接在 Kong 容器中的 Shell。
• pongo tail: 启动对指定文件的 tail 操作，默认文件为 /servroot/logs/error.log。

3. 项目的配置文件介绍

.editorconfig

.editorconfig 文件用于统一代码风格，确保不同编辑器和 IDE 之间的代码格式一致。

.gitattributes

.gitattributes 文件用于指定 Git 管理的文件属性，例如文件的换行符类型等。

.gitignore

.gitignore 文件用于指定哪些文件和目录不需要被 Git 管理，例如临时文件、编译输出等。

.shellcheckrc

.shellcheckrc 文件是 ShellCheck 的配置文件，用于检查 Shell 脚本的语法和风格。

Makefile

Makefile 文件用于自动化构建和测试。它定义了一系列的规则和命令，例如构建测试镜像、运行测试等。

README.md

README.md 文件是项目的说明文档，包含了项目的介绍、安装方法、使用说明等内容。

pongo.sh

pongo.sh 文件是项目的启动脚本，它提供了多种命令来初始化、构建、运行测试等操作。可以通过设置环境变量来配置 Pongo 的行为，例如指定 Kong 版本、Kong 镜像等。

通过以上介绍，您可以更好地理解和使用 Kong Pongo 项目。