{"id":22555399,"url":"https://github.com/asseco-voice/laravel-code-quality","last_synced_at":"2025-08-20T00:16:06.921Z","repository":{"id":56042899,"uuid":"269097597","full_name":"asseco-voice/laravel-code-quality","owner":"asseco-voice","description":"Githooks, PHP code sniffer, PHP mess detector","archived":false,"fork":false,"pushed_at":"2021-01-25T11:19:47.000Z","size":99,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-06-06T11:07:18.302Z","etag":null,"topics":["code-quality","code-sniffer","laravel","laravel-8-package","mess-detector","microservice","microservices","php","precommit-hooks"],"latest_commit_sha":null,"homepage":"","language":"Shell","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/asseco-voice.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":"2020-06-03T13:37:04.000Z","updated_at":"2023-02-13T16:11:36.000Z","dependencies_parsed_at":"2022-08-15T12:01:02.953Z","dependency_job_id":null,"html_url":"https://github.com/asseco-voice/laravel-code-quality","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/asseco-voice/laravel-code-quality","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asseco-voice%2Flaravel-code-quality","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asseco-voice%2Flaravel-code-quality/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asseco-voice%2Flaravel-code-quality/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asseco-voice%2Flaravel-code-quality/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/asseco-voice","download_url":"https://codeload.github.com/asseco-voice/laravel-code-quality/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asseco-voice%2Flaravel-code-quality/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271242296,"owners_count":24725015,"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","status":"online","status_checked_at":"2025-08-19T02:00:09.176Z","response_time":63,"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":["code-quality","code-sniffer","laravel","laravel-8-package","mess-detector","microservice","microservices","php","precommit-hooks"],"created_at":"2024-12-07T19:07:47.060Z","updated_at":"2025-08-20T00:16:06.566Z","avatar_url":"https://github.com/asseco-voice.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\u003ca href=\"https://see.asseco.com\" target=\"_blank\"\u003e\u003cimg src=\"https://github.com/asseco-voice/art/blob/main/evil_logo.png\" width=\"500\"\u003e\u003c/a\u003e\u003c/p\u003e\n\n# Code quality standard\n\nThis repository is meant to be a single place for PHP related quality \nstandards when it comes to committing code from any Laravel (micro) service\nto repository. Its main purpose is creating [git hooks](https://githooks.com/) \nwhich would catch any pre-commit action and see whether code is written \naccording to agreed standards. If it fails, commit will not be made. \n\nNaming conventions in this document:\n\n- **SERVICE** is used to describe a repository, microservice, external \nservice and similar. Codebase which needs to use this repository to comply\nto given coding standards.\n- **CQS** is this repository. Short for Code Quality Standard.\n\n## Installation\n\nRequire the package with ``composer require asseco-voice/laravel-code-quality``.\nService provider for Laravel will be installed automatically.\n\nAfter a successful installation you have 2 new Artisan commands available:\n\n- ``asseco:git-hooks`` - will install git-hooks by copying \nfrom `CQS/.githooks` to `SERVICE/.git/hooks` directory. \n- ``asseco:tdd`` - will install real time monitoring dependencies if not already \npresent (NPM packages + gulp file), and depending on the flags you provided (explained\nwithin the command itself) will run real time monitoring for test folders as well as\nfiles under the ``App`` folder to enable automatic tests running with notification flag\nwhether test succeeded or not. This is useful in a way that you don't have to switch\nbetween IDE and terminal back and forth to see if tests passed. **Don't run in Docker,\nor you will not receive notifications.** \n\n## IDE support\n\nTo have PHP code sniffer \u0026 mess detector tools integrated within your \nIDE and available in every project instead of setting it up for every\nproject, it is recommended that you clone the CQS repository at the same \ndirectory level as a SERVICE:\n\n```\n|\n|--- code-quality\n|--- service1\n|--- service2\n```\nAfter that point your IDE to ``phpcs.xml`` as a ruleset for PHP code\nsniffer, and ``phpmd.xml`` for mess detector ruleset.\n\nLink for [PHPStorm quality tools specifics](https://www.jetbrains.com/help/phpstorm/php-code-quality-tools.html).\n\n## Usage \u0026 testing\n\nTo test the git hook script without committing anything to the repo\nyou can simply run for example `bash SERVICE/.git/hooks/pre-commit.sh`.\n\nNotice that the script will run only for PHP files that are staged \nwith `git add` command. \n\n# Quality checks\n\n## PHP code sniffer\n\nhttps://github.com/squizlabs/PHP_CodeSniffer/wiki/Customisable-Sniff-Properties\n\n## PHP Mess detector\n\nhttps://phpmd.org/rules/index.html\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fasseco-voice%2Flaravel-code-quality","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fasseco-voice%2Flaravel-code-quality","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fasseco-voice%2Flaravel-code-quality/lists"}