{"id":13505130,"url":"https://github.com/PHPCheckstyle/phpcheckstyle","last_synced_at":"2025-03-29T23:31:10.814Z","repository":{"id":19847511,"uuid":"23109512","full_name":"PHPCheckstyle/phpcheckstyle","owner":"PHPCheckstyle","description":"PHPCheckstyle is an open-source tool that helps PHP programmers adhere to certain coding conventions.","archived":false,"fork":false,"pushed_at":"2022-12-09T07:46:46.000Z","size":1071,"stargazers_count":164,"open_issues_count":18,"forks_count":31,"subscribers_count":15,"default_branch":"master","last_synced_at":"2024-10-30T04:53:37.557Z","etag":null,"topics":["checkstyle","coding-conventions","php","phpcheckstyle"],"latest_commit_sha":null,"homepage":"https://github.com/PHPCheckstyle/phpcheckstyle","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PHPCheckstyle.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-08-19T12:39:34.000Z","updated_at":"2024-01-18T20:20:39.000Z","dependencies_parsed_at":"2023-01-13T20:37:48.789Z","dependency_job_id":null,"html_url":"https://github.com/PHPCheckstyle/phpcheckstyle","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PHPCheckstyle%2Fphpcheckstyle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PHPCheckstyle%2Fphpcheckstyle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PHPCheckstyle%2Fphpcheckstyle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PHPCheckstyle%2Fphpcheckstyle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PHPCheckstyle","download_url":"https://codeload.github.com/PHPCheckstyle/phpcheckstyle/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246258884,"owners_count":20748573,"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":["checkstyle","coding-conventions","php","phpcheckstyle"],"created_at":"2024-08-01T00:00:59.106Z","updated_at":"2025-03-29T23:31:09.893Z","avatar_url":"https://github.com/PHPCheckstyle.png","language":"PHP","readme":"# PHPCheckstyle\n\n[![Build Status](https://travis-ci.org/PHPCheckstyle/phpcheckstyle.svg?branch=master)](https://travis-ci.org/PHPCheckstyle/phpcheckstyle)\n\n## Overview\n\nPHPCheckstyle is an open-source tool that helps PHP programmers \nadhere to certain coding conventions. The tools checks the input PHP \nsource code and reports any deviations from the coding convention.\n\nThe tool uses the PEAR Coding Standards as the default coding convention. \nBut it allows you to configure it to suit your coding standards.\n\nPlease visit [https://github.com/PHPCheckstyle/phpcheckstyle/wiki](https://github.com/PHPCheckstyle/phpcheckstyle/wiki) for\nmore information and documentation\n\n\n## Requirements\n\n- PHP 5.0 or newer. \n- Web browser to view the checkstyle report (only for html view)\n- That's all. \n\n\n## Installation\n\n### Installation with Composer\n\n```sh\ncomposer require phpcheckstyle/phpcheckstyle\n```\n\nor Add `phpcheckstyle/phpcheckstyle` as a requirement to `composer.json`:\n\n```json\n{\n    \"require\": {\n        \"phpcheckstyle/phpcheckstyle\": \"dev-master\"\n    }\n}\n```\n\nUpdate your packages with `composer update` or if installing from fresh, with `composer install`.\n\n### Manual Installation\n\nJust download [https://github.com/PHPCheckstyle/phpcheckstyle/archive/master.zip](https://github.com/PHPCheckstyle/phpcheckstyle/archive/master.zip) and unzip the distribution.\n\n```bash\n$\u003e unzip PhpCheckstyle.zip\n```\n\nThis will create a directory called `phpcheckstyle` and expand all \nfiles in it.\n\n\n### Testing with Vagrant\n\n* install [VirtualBox](https://www.virtualbox.org/)\n* install [Vagrant](https://www.vagrantup.com/)\n* launch `vagrant up`  in the project root directory to start the VM\n\n* In case of problem with the \"guest additions\", launch :\n \n\u003evagrant plugin install vagrant-vbguest\n\n* to run PHPCheckstyle on itself, type `vagrant provision --provision-with run_phpcheckstyle`\n* to run PHPUnit, type `vagrant provision --provision-with run_phpunit`\n* to log inside the VM, type `vagrant ssh`\n\n## Usage\n\n- Change directory to the PHPCheckstyle installation directory.\n\n  ```bash\n  $\u003e cd phpcheckstyle\n  ```\n\n- Execute the `run.php` script providing the `--src` option.\n\n  ```bash\n  $\u003e php run.php --src \u003cphp source directory/file\u003e\n  ```\n\n- Use the `--help` option to see more options\n\n  ```bash\n  $\u003e php run.php --help\n  ```\n\n\n# License\nSee [LICENSE](/LICENSE.txt)\n","funding_links":[],"categories":["Table of Contents","Standalone","目录","PHP","类库","P5 Créez votre premier blog en PHP","代码分析 Code Analysis"],"sub_categories":["Code Quality","Coding standards","代码质量 Code Quality","代码检查/静态分析","Qualité du code"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FPHPCheckstyle%2Fphpcheckstyle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FPHPCheckstyle%2Fphpcheckstyle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FPHPCheckstyle%2Fphpcheckstyle/lists"}