grumphp
v2.10.0
코드 품질을 계속해서 방어하는 데 지치셨나요? GrumPHP가 대신해 드립니다! 이 작성기 플러그인은 패키지 저장소에 일부 git 후크를 등록합니다. 누군가 변경 사항을 커밋하면 GrumPHP는 커밋된 코드에 대해 몇 가지 테스트를 실행합니다. 테스트가 실패하면 변경 사항을 커밋할 수 없습니다. 이 편리한 도구는 코드베이스를 향상시킬 뿐만 아니라 동료가 팀으로서 결정한 모범 사례에 따라 더 나은 코드를 작성하도록 가르칠 것입니다.
GrumPHP에는 일련의 공통 작업이 내장되어 있습니다. 최소한의 구성으로 GrumPHP를 사용할 수 있습니다.
모든 세부 사항을 설명하여 여러분을 지루하게 만들고 싶지 않습니다. 너무 빨리 직접 설치하고 GrumPHP의 힘을 발휘하세요!
이 패키지가 작동하려면 명령줄에서 다음 도구를 찾을 수 있는지 확인해야 합니다.
PHP
작곡가
자식
이 패키지는 작곡가 플러그인이며 작곡가를 사용하여 프로젝트의 개발 종속성에 설치해야 합니다.
종속성 없이 GrumPHP를 phar로 설치합니다.
작곡가는 --dev phppro/grumphp-shim을 요구합니다
종속성을 사용하여 GrumPHP를 설치합니다.
composer require --dev phpro/grumphp
phive를 통해 종속성 및 자동화된 git 후크 없이 GrumPHP를 설치합니다.
phive install grumphp
패키지가 설치되면 GrumPHP가 프로젝트의 git 후크에 연결됩니다. 작성기 로그에 다음 메시지가 표시됩니다.
조심하세요! GrumPHP가 커밋을 스니핑하고 있습니다!
GrumPHP는 절대로 특정 작업을 사용하도록 강요하지 않습니다. 귀하의 필요에 맞는 작업을 선택하고 즉시 작업을 활성화하거나 비활성화할 수 있습니다! 작곡가.json의 suggest 섹션을 참조하세요.
참고: GrumPHP는 --no-plugins 또는 --no-scripts 사용하여 composer install 실행하지 않는 한 기존 후크를 덮어씁니다. 우리는 Git Hook의 백업을 생성하지만 GrumPHP를 설치하기 전에 사용자 정의 Hook의 백업도 가지고 있는지 확인하는 것이 가장 좋습니다.
GrumPHP를 설치하는 데 문제가 있나요? 다음 방법을 알아보세요.
전역적으로 설치
이국적인 프로젝트 구조로 설치
GrumPHP의 일부 항목은 프로젝트 루트(grumphp 명령을 실행하는 디렉터리)에 있는 grumphp.yml , grumphp.yml.dist 또는 grumphp.dist.yml 파일에서 구성할 수 있습니다. composer.json 또는 콘솔 명령의 --config 옵션에서 사용자 정의 구성 파일 이름과 위치를 지정할 수 있습니다.
# grumphp.ymlgrumphp:hooks_dir: ~hooks_preset: localgit_hook_variables:VAGRANT_HOST_DIR: .VAGRANT_PROJECT_DIR: /var/wwwEXEC_GRUMPHP_COMMAND: execENV: {}stop_on_failure: falseignore_unstaged_changes: falsehide_circumvention_tip: falseprocess_timeout: 60ascii:실패: grumphp-grumpy.txt성공: grumphp-happy.txtparallel:활성화: truemax_workers: 32fixer:활성화: truefix_by_default: falseenvironment:파일: []변수: {}경로: []작업: {}테스트 모음: []확장: []구성 세부정보는 다음 섹션으로 구분됩니다.
매개변수 – GrumPHP 자체에 대한 구성 설정입니다.
작업 – 코드 검증 및 해당 구성을 수행하는 외부 작업입니다.
테스트 스위트
확장
TaskRunner 확장
컨벤션 체커
GrumPHP는 단순한 CLI 도구이므로 다음 명령을 실행할 수 있습니다.
구성
자식:초기화
자식:디니트
git:사전 커밋
git:커밋-메시지
달리다
GrumPHP는 PHP 5.6 이상에서 작동합니다.
이 패키지는 다음 git 클라이언트에서 테스트되었습니다.
CLI 유닉스
CLI 맥
CLI 윈도우
PhpStorm Git
Atlassian 소스트리
신테보 스마트Git
팀이 훌륭한 코드를 작성하는 데 도움이 되는 많은 작업이 이미 제공되어 있습니다. 우리는 항상 새로운 작업을 지원하기 위해 노력하고 있습니다. 문제를 기록하거나 잊어버린 작업에 대한 끌어오기 요청을 작성해 주세요.
기능이 누락되었거나 버그를 발견하셨나요? 이슈 트래커에 로그인하세요! 도와주고 싶나요? 저희에게 연락 주시기 바랍니다!
FAQ
버그 및 기능 요청은 GitHub에서 추적됩니다. 코드를 제공하기 전에 규칙을 살펴보시기 바랍니다.
GrumPHP는 MIT 라이선스에 따라 라이선스가 부여됩니다.
