haemanthus / codeigniter3-ide-helper
CodeIgniter 3 IDE助手生成器
v1.0.8
2022-06-10 09:53 UTC
Requires
- php: >=7.4
- mnapoli/silly: ^1.8
- nikic/php-parser: ^4.13
- php-di/php-di: ^6.3
- spatie/enum: ^3.12
- symfony/filesystem: ^5.4
- symfony/finder: ^5.4
Requires (Dev)
- nunomaduro/phpinsights: ^2.4
- phpstan/phpstan: ^1.7
- phpunit/phpunit: ^9.5
- psy/psysh: @stable
- spatie/phpunit-snapshot-assertions: ^4.2
- squizlabs/php_codesniffer: ^3.6
- symfony/var-dumper: ^5.4
README
关于CodeIgniter 3 IDE助手
CodeIgniter 3 IDE助手是一个命令行应用程序,用于生成辅助文件,以提供IDE的自动代码补全功能。
IDE辅助文件输出基于您在 config/autoload.php
、core
、controllers
和 models
文件夹中加载的所有库和模型。
使用方法
通过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 Workflows 和 Semantic Release,请确保您的提交消息遵循 常规提交规范。
贡献者功能
-
与 Commitizen 进行交互式提交。
完成您的更改后,您可以使用
npx cz
运行以显示需要根据 常规提交规范 填写的提示。 -
使用 Symfony Var Dumper 打印调试信息。
调试CLI应用程序非常困难,尤其是当您处理复杂的数据结构时。因此,为了最大限度地减少这个问题,您也可以进行打印调试,打印的结果将出现在浏览器中。
- 首先,您可以运行
composer dumper:start
- 打开一个新的终端然后运行
composer dumper:serve
- 然后在任何
src
文件夹内部(除了Application.php
、Commands/GenerateHelperCommand.php
和Providers/AppServiceProvider.php
文件外),您可以写入dump($something)
或dd($something)
- 通过在浏览器中打开 https://:8000 来查看结果
- 首先,您可以运行
-
使用 Visual Studio Code Remote Container 在容器内开发。
如果您想进一步开发或探索这个仓库中的源代码,但又不想安装PHP、Composer、Node.js以及各种其他依赖项,您也可以使用VS Code Remote Container,只需确保您已安装Docker和VS Code,并安装了远程容器。
许可证
此应用程序受MIT许可证许可。