haemanthus/codeigniter3-ide-helper

CodeIgniter 3 IDE助手生成器

v1.0.8 2022-06-10 09:53 UTC

This package is auto-updated.

Last update: 2024-09-21 10:47:36 UTC


README

Lint Codebase Workflow Status Test Workflow Status Code Coverage Packagist Version Docker Image Version (latest semver) License

关于CodeIgniter 3 IDE助手

CodeIgniter 3 IDE助手是一个命令行应用程序,用于生成辅助文件,以提供IDE的自动代码补全功能。

IDE辅助文件输出基于您在 config/autoload.phpcorecontrollersmodels 文件夹中加载的所有库和模型。

使用方法

通过Composer

通过Composer安装(需要PHP >= 7.4)

  • 首先,使用 composer require haemanthus/codeigniter3-ide-helper --dev 安装
  • 然后,您可以使用 ./vendor/bin/ide-helper generate 使用它

通过Docker

如果您没有PHP >= 7.4或者无法安装,您也可以通过Docker安装此软件包。

  • 使用 docker pull haemanthus/codeigniter3-ide-helper 拉取最新的Docker镜像
  • 然后,您可以使用 docker run -it --rm -v "$(pwd):/app" haemanthus/codeigniter3-ide-helper generate 使用它

使用示例

选项

贡献

欢迎贡献,但由于此存储库的发布周期完全自动化,使用 GitHub Actions WorkflowsSemantic Release,请确保您的提交消息遵循 常规提交规范

贡献者功能

  • Commitizen 进行交互式提交。

    完成您的更改后,您可以使用 npx cz 运行以显示需要根据 常规提交规范 填写的提示。

  • 使用 Symfony Var Dumper 打印调试信息。

    调试CLI应用程序非常困难,尤其是当您处理复杂的数据结构时。因此,为了最大限度地减少这个问题,您也可以进行打印调试,打印的结果将出现在浏览器中。

  • 使用 Visual Studio Code Remote Container 在容器内开发。

    如果您想进一步开发或探索这个仓库中的源代码,但又不想安装PHP、Composer、Node.js以及各种其他依赖项,您也可以使用VS Code Remote Container,只需确保您已安装Docker和VS Code,并安装了远程容器

许可证

此应用程序受MIT许可证许可。