{"id":40574664,"url":"https://github.com/exolnet/phpcs-config","last_synced_at":"2026-01-21T02:02:43.165Z","repository":{"id":46443882,"uuid":"218298968","full_name":"eXolnet/phpcs-config","owner":"eXolnet","description":"[READ ONLY] Subtree split of the phpcs-config package (see exolnet/code-quallity-tools)","archived":false,"fork":false,"pushed_at":"2025-07-17T00:24:46.000Z","size":5,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-12-13T07:14:33.125Z","etag":null,"topics":["php"],"latest_commit_sha":null,"homepage":null,"language":null,"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/eXolnet.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-10-29T13:52:53.000Z","updated_at":"2025-01-10T01:07:49.000Z","dependencies_parsed_at":"2025-01-10T11:47:39.445Z","dependency_job_id":null,"html_url":"https://github.com/eXolnet/phpcs-config","commit_stats":{"total_commits":5,"total_committers":2,"mean_commits":2.5,"dds":0.4,"last_synced_commit":"db3363e70f62390b6136858c96d39ef026e38c49"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/eXolnet/phpcs-config","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eXolnet%2Fphpcs-config","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eXolnet%2Fphpcs-config/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eXolnet%2Fphpcs-config/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eXolnet%2Fphpcs-config/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eXolnet","download_url":"https://codeload.github.com/eXolnet/phpcs-config/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eXolnet%2Fphpcs-config/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28622472,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-20T23:49:58.628Z","status":"online","status_checked_at":"2026-01-21T02:00:08.227Z","response_time":86,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["php"],"created_at":"2026-01-21T02:02:39.678Z","updated_at":"2026-01-21T02:02:43.157Z","avatar_url":"https://github.com/eXolnet.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# eXolnet - PHPCS Ruleset\n\n[![Software License](https://img.shields.io/badge/license-MIT-8469ad.svg?style=flat-square)](LICENSE.md)\n[![Build Status](https://img.shields.io/github/actions/workflow/status/eXolnet/code-quality-tools/ci.yml?label=tests\u0026style=flat-square)](https://github.com/eXolnet/code-quality-tools/actions?query=workflow%3Aci)\n\nA collection of shareable configurations for various coding-style tools to make the configurations consistent across our projects.\n\n## Setup\n\n1. `composer require --dev exolnet/phpcs-config`\n2. Run the following command to run the standards checks:\n\n```\nvendor/bin/phpcs --standard=vendor/exolnet/phpcs-config .\n```\n\nYou can add this to your Travis YAML file as a test:\n\n```yaml\nscript:\n  - phpunit\n  - vendor/bin/phpcs --standard=vendor/exolnet/phpcs-config .\n```\n\n### Excluding Files\n\nThis standard includes special support for a `.phpcsignore` file (in the future, this should be [built into phpcs itself](https://github.com/squizlabs/PHP_CodeSniffer/issues/1884)). \nSimply place a `.phpcsignore` file in your root directory (wherever you're going to run `phpcs` from).\n\nThe format of this file is similar to `.gitignore` and similar files: one pattern per line, comment lines should start with a `#`, and whitespace-only lines are ignored:\n\n```\n# Exclude our tests directory.\ntests/\n\n# Exclude any file ending with \".inc\"\n*\\.inc\n```\n\nNote that the patterns should match [the PHP_CodeSniffer style](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Advanced-Usage#ignoring-files-and-folders): `*` is translated to `.*` for convenience, but all other characters work like a regular expression.\n\nPatterns are relative to the directory that the `.phpcsignore` file lives in. On load, they are translated to absolute patterns: e.g. `*/tests/*` in `/your/dir/.phpcsignore` will become `/your/dir/.*/tests/.*` as a regular expression. **This differs from the regular PHP_CodeSniffer practice.**\n\n\n### Advanced/Extending\n\nIf you want to add further rules (such as laravel-specific rules), you can create your own custom standard file (e.g. `ruleset.xml`):\n\n```xml\n\u003c?xml version=\"1.0\"?\u003e\n\u003cruleset\u003e\n    \u003cfile\u003eapp\u003c/file\u003e\n    \u003cfile\u003econfig\u003c/file\u003e\n    \u003cfile\u003edatabase\u003c/file\u003e\n    \u003cfile\u003eroutes\u003c/file\u003e\n    \u003cfile\u003etests\u003c/file\u003e\n    \n    \u003c!-- Use eXolnet Coding Standards --\u003e\n    \u003crule ref=\"vendor/exolnet/phpcs-config\" /\u003e\n    \n    \u003c!-- Add Laravel-specific rules --\u003e\n    \u003crule ref=\"PSR1.Classes.ClassDeclaration.MissingNamespace\"\u003e\n        \u003cexclude-pattern\u003edatabase/*\u003c/exclude-pattern\u003e\n    \u003c/rule\u003e\n\u003c/ruleset\u003e\n```\n\nYou can then reference this file when running phpcs:\n\n```\nvendor/bin/phpcs --standard=ruleset.xml .\n```\n\n\n#### Excluding/Disabling Checks\n\nYou can also customise the rule to exclude elements if they aren't applicable to the project:\n\n```xml\n\u003crule ref=\"vendor/exolnet/phpcs-config\"\u003e\n\t\u003c!-- Disable short array syntax --\u003e\n\t\u003cexclude name=\"PSR1.Classes.ClassDeclaration.MissingNamespace\" /\u003e\n\u003c/rule\u003e\n```\n\nRules can also be disabled inline. [phpcs rules can be disabled](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Advanced-Usage#ignoring-parts-of-a-file) with a `// @codingStandardsIgnoreLine` comment, and [ESLint rules can be disabled](http://eslint.org/docs/user-guide/configuring#disabling-rules-with-inline-comments) with a `/* eslint disable ... */` comment.\n\nTo find out what these codes are, specify `-s` when running `phpcs`, and the code will be output as well. You can specify a full code, or a partial one to disable groups of errors.\n\n## Security\n\nIf you discover any security related issues, please email security@exolnet.com instead of using the issue tracker.\n\n## Credits\n\n- [Alexandre D'Eschambeault](https://github.com/xel1045)\n- [Simon Gaudreau](https://github.com/Gandhi11)\n- [All Contributors](../../contributors)\n\n## License\n\nCopyright © [eXolnet](https://www.exolnet.com). All rights reserved.\n\nThis code is licensed under the [MIT license](http://choosealicense.com/licenses/mit/).\nPlease see the [license file](LICENSE) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexolnet%2Fphpcs-config","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fexolnet%2Fphpcs-config","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fexolnet%2Fphpcs-config/lists"}