包简介

CodeIgniter 3 IDE helper generator

README 文档

README

About CodeIgniter 3 IDE Helper

CodeIgniter 3 IDE Helper is a CLI application for generating a helper file to provide automatic code completion for your IDE.

IDE helper output is generated based on all the libraries and models you loaded in the config/autoload.php, core, controllers, and models folders.

Usage

Via Composer

Installation via Composer (require PHP >= 7.4)

First, install with composer require haemanthus/codeigniter3-ide-helper --dev
Then, you can use it with ./vendor/bin/ide-helper generate

Via Docker

Alternatively, you can install this package via Docker if for whatever reason you don't have and can't install PHP >= 7.4.

Pull latest Docker image with docker pull haemanthus/codeigniter3-ide-helper
Then, you can use it with docker run -it --rm -v "$(pwd):/app" haemanthus/codeigniter3-ide-helper generate

Usage Example

Options

Commands	Options	Description	Example
./vendor/bin/ide-helper generate	`--dir`	Set CodeIgniter 3 root directory [default: `./`].	-
	`--pattern`	Add pattern in string or regex to match files (multiple values allowed).	`--pattern '/Controller\b/'` (Match all files with 'Controller' suffix)
			`--pattern User --pattern Auth` (Match all files with filename containing 'User' or 'Auth')
	`--output-path`	Output path of generated file [default: `_ide_helper.php`]	`--output-path ./application/_my_ide_helper.php`
	`--help`	Display help.	-
	`--quiet`	Do not output any message.	-
	`--version`	Display application version.	-
	`--no-interaction`	Do not ask any interactive question.	-

Contributing

Feel free to contribute, but as this repository release cycle is fully automated using GitHub Actions Workflows & Semantic Release, so make sure your commit messages follow Conventional Commits Specification.

Features for Contributors

Interactive commit with Commitizen.

Once you are done making your changes, you can run npx cz to bring up a prompt which needs to be filled in according to the Conventional Commits Specification.
Print debugging with Symfony Var Dumper.

Debugging CLI applications is very difficult, especially when you are dealing with complex data structures. So to minimize this problem, you can also do print debugging where the results of something you print appear in the browser.
- First, you can run composer dumper:start
- Open a new terminal then run composer dumper:serve
- Then anywhere inside src folder (except Application.php, Commands/GenerateHelperCommand.php & Providers/AppServiceProvider.php files), you can write dump($something) or dd($something)
- See the result by opening http://localhost:8000 in your browser
Developing inside a Container with Visual Studio Code Remote Container.

If you want to develop or explore the source code in this repository further, but you are lazy to install PHP, Composer, Node.js, and various other dependencies. You can also use VS Code Remote Container, just make sure you have Docker & VS Code with Remote Containers installed.

License

This application is licensed under the MIT license.

haemanthus/codeigniter3-ide-helper 适用场景与选型建议

haemanthus/codeigniter3-ide-helper 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 578 次下载、GitHub Stars 达 4，最近一次更新时间为 2022 年 06 月 08 日，在 PHP 生态内属于活跃度较高的组件。

我们在过去多个企业项目中使用过 haemanthus/codeigniter3-ide-helper 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 haemanthus/codeigniter3-ide-helper 我们能提供哪些服务？

定制开发 / 二次开发

基于 haemanthus/codeigniter3-ide-helper 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

haemanthus/codeigniter3-ide-helper

包简介