{"id":16465917,"url":"https://github.com/yusuftaufiq/codeigniter3-ide-helper","last_synced_at":"2025-07-12T17:33:26.345Z","repository":{"id":39815524,"uuid":"475712847","full_name":"yusuftaufiq/codeigniter3-ide-helper","owner":"yusuftaufiq","description":"CodeIgniter 3 IDE helper generator","archived":false,"fork":false,"pushed_at":"2024-07-01T10:38:12.000Z","size":2697,"stargazers_count":4,"open_issues_count":3,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-29T01:42:24.129Z","etag":null,"topics":["autocompletion","cli-app","codeigniter3","ide-helper","php"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yusuftaufiq.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-03-30T04:02:08.000Z","updated_at":"2024-09-27T20:17:55.000Z","dependencies_parsed_at":"2025-06-29T01:36:00.011Z","dependency_job_id":"37701921-c5da-470a-aca3-615397685ac1","html_url":"https://github.com/yusuftaufiq/codeigniter3-ide-helper","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/yusuftaufiq/codeigniter3-ide-helper","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yusuftaufiq%2Fcodeigniter3-ide-helper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yusuftaufiq%2Fcodeigniter3-ide-helper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yusuftaufiq%2Fcodeigniter3-ide-helper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yusuftaufiq%2Fcodeigniter3-ide-helper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yusuftaufiq","download_url":"https://codeload.github.com/yusuftaufiq/codeigniter3-ide-helper/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yusuftaufiq%2Fcodeigniter3-ide-helper/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265025454,"owners_count":23699749,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["autocompletion","cli-app","codeigniter3","ide-helper","php"],"created_at":"2024-10-11T11:35:42.185Z","updated_at":"2025-07-12T17:33:26.289Z","avatar_url":"https://github.com/yusuftaufiq.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n  \u003ca href=\"https://github.com/yusuftaufiq/codeigniter3-ide-helper\"\u003e\u003cimg src=\"https://raw.githubusercontent.com/yusuftaufiq/codeigniter3-ide-helper/main/images/ci3-ide-helper-logo.svg\"\n      width=\"300\"\u003e\u003c/a\u003e\n\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/yusuftaufiq/codeigniter3-ide-helper/actions/workflows/lint.yml\"\u003e\n    \u003cimg alt=\"Lint Codebase Workflow Status\"\n      src=\"https://img.shields.io/github/actions/workflow/status/yusuftaufiq/codeigniter3-ide-helper/lint.yml?branch=main\u0026label=lint\u0026logo=github\u0026style=flat-square\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/yusuftaufiq/codeigniter3-ide-helper/actions/workflows/test.yml\"\u003e\n    \u003cimg alt=\"Test Workflow Status\"\n      src=\"https://img.shields.io/github/actions/workflow/status/yusuftaufiq/codeigniter3-ide-helper/test.yml?branch=main\u0026label=test\u0026logo=github\u0026style=flat-square\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://codecov.io/gh/yusuftaufiq/codeigniter3-ide-helper\"\u003e\n    \u003cimg alt=\"Code Coverage\"\n      src=\"https://img.shields.io/codecov/c/github/yusuftaufiq/codeigniter3-ide-helper?logo=codecov\u0026style=flat-square\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://packagist.org/packages/haemanthus/codeigniter3-ide-helper\"\u003e\n    \u003cimg alt=\"Packagist Version\"\n      src=\"https://img.shields.io/packagist/v/haemanthus/codeigniter3-ide-helper?logo=packagist\u0026style=flat-square\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://hub.docker.com/repository/docker/haemanthus/codeigniter3-ide-helper\"\u003e\n    \u003cimg alt=\"Docker Image Version (latest semver)\" src=\"https://img.shields.io/docker/v/haemanthus/codeigniter3-ide-helper?logo=docker\u0026label=docker%20hub\u0026sort=semver\u0026style=flat-square\"\u003e\n  \u003ca href=\"https://github.com/yusuftaufiq/codeigniter3-ide-helper/blob/main/LICENSE\"\u003e\n    \u003cimg alt=\"License\"\n      src=\"https://img.shields.io/github/license/yusuftaufiq/codeigniter3-ide-helper?style=flat-square\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n## About CodeIgniter 3 IDE Helper\n\nCodeIgniter 3 IDE Helper is a CLI application for generating a helper file to provide automatic code completion for your IDE.\n\nIDE helper output is generated based on all the libraries and models you loaded in the [`config/autoload.php`](https://github.com/bcit-ci/CodeIgniter/blob/master/application/config/autoload.php), [`core`](https://github.com/bcit-ci/CodeIgniter/blob/master/application/core), [`controllers`](https://github.com/bcit-ci/CodeIgniter/blob/master/application/controllers), and [`models`](https://github.com/bcit-ci/CodeIgniter/blob/master/application/models) folders.\n\n## Usage\n\n### Via Composer\n\nInstallation via Composer (require PHP \u003e= 7.4)\n\n- First, install with `composer require haemanthus/codeigniter3-ide-helper --dev`\n- Then, you can use it with `./vendor/bin/ide-helper generate`\n\n### Via Docker\n\nAlternatively, you can install this package via Docker if for whatever reason you don't have and can't install PHP \u003e= 7.4.\n\n- Pull latest Docker image with `docker pull haemanthus/codeigniter3-ide-helper`\n- Then, you can use it with `docker run -it --rm -v \"$(pwd):/app\" haemanthus/codeigniter3-ide-helper generate`\n\n## Usage Example\n\n\u003cp align=\"center\"\u003e\n  \u003cimg width=\"600\" src=\"https://raw.githubusercontent.com/yusuftaufiq/codeigniter3-ide-helper/main/images/ci3-ide-helper-usage.gif\"\u003e\n\u003c/p\u003e\n\n\n## Options\n\n| Commands | Options | Description | Example |\n| -- | -- | -- | -- |\n| ./vendor/bin/ide-helper generate | `--dir` | Set CodeIgniter 3 root directory [default: `./`]. | - |\n| | `--pattern` | Add pattern in string or regex to match files (multiple values allowed). | `--pattern '/Controller\\b/'` (Match all files with 'Controller' suffix) |\n| | | | `--pattern User --pattern Auth` (Match all files with filename containing 'User' or 'Auth') |\n| | `--output-path` | Output path of generated file [default: `_ide_helper.php`] | `--output-path ./application/_my_ide_helper.php` |\n| | `--help` | Display help. | - |\n| | `--quiet` | Do not output any message. | - |\n| | `--version` | Display application version. | - |\n| | `--no-interaction` | Do not ask any interactive question. | - |\n\n## Contributing\n\nFeel free to contribute, but as this repository release cycle is fully automated using [GitHub Actions Workflows](./.github/workflows/) \u0026 [Semantic Release](https://github.com/semantic-release/semantic-release), so make sure your commit messages follow [Conventional Commits Specification](https://www.conventionalcommits.org/en/v1.0.0/).\n\n## Features for Contributors\n\n- Interactive commit with [Commitizen](https://github.com/commitizen/cz-cli).\n\n  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](https://www.conventionalcommits.org/en/v1.0.0/).\n\n- Print debugging with [Symfony Var Dumper](https://symfony.com/doc/current/components/var_dumper.html).\n\n  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.\n\n  - First, you can run `composer dumper:start`\n  - Open a new terminal then run `composer dumper:serve`\n  - Then anywhere inside [`src`](./src/) folder (except [`Application.php`](./src/Application.php), [`Commands/GenerateHelperCommand.php`](./src/Commands/GenerateHelperCommand.php) \u0026 [`Providers/AppServiceProvider.php`](./src/Providers/AppServiceProvider.php) files), you can write `dump($something)` or `dd($something)`\n  - See the result by opening [http://localhost:8000](http://localhost:8000) in your browser\n\n- Developing inside a Container with [Visual Studio Code Remote Container](https://code.visualstudio.com/docs/remote/containers).\n\n  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 \u0026 VS Code with [Remote Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) installed.\n\n## License\n\nThis application is licensed under the [MIT license](http://opensource.org/licenses/MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyusuftaufiq%2Fcodeigniter3-ide-helper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyusuftaufiq%2Fcodeigniter3-ide-helper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyusuftaufiq%2Fcodeigniter3-ide-helper/lists"}