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.

Installation via Composer (require PHP >= 7.4)

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

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.	-

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.

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.

This application is licensed under the MIT license.