grumphp

GrumPHP

เบื่อและเบื่อกับการปกป้องคุณภาพโค้ดซ้ำแล้วซ้ำเล่าใช่หรือไม่ GrumPHP จะทำเพื่อคุณ! ปลั๊กอินผู้แต่งนี้จะลงทะเบียน git hooks บางตัวในพื้นที่เก็บข้อมูลแพ็คเกจของคุณ เมื่อมีคนทำการเปลี่ยนแปลง Grumphp จะทำการทดสอบบางอย่างในรหัสที่มุ่งมั่น หากการทดสอบล้มเหลว คุณจะไม่สามารถยอมรับการเปลี่ยนแปลงของคุณได้ เครื่องมือที่มีประโยชน์นี้ไม่เพียงแต่ปรับปรุงฐานโค้ดของคุณเท่านั้น แต่ยังจะสอนเพื่อนร่วมงานของคุณให้เขียนโค้ดที่ดีขึ้นตามแนวทางปฏิบัติที่ดีที่สุดที่คุณกำหนดไว้เป็นทีมอีกด้วย

GrumPHP has a set of common tasks built-in. คุณจะสามารถใช้ GrumPHP ได้ด้วยการกำหนดค่าขั้นต่ำ

เราไม่ต้องการที่จะทำให้คุณเบื่อกับรายละเอียดทั้งหมด ด่วน: ติดตั้งด้วยตัวคุณเองและปลดปล่อยพลังของ GrumPHP!

สาธิต

การติดตั้ง

เพื่อให้แพ็คเกจนี้ทำงานได้ คุณต้องแน่ใจว่าสามารถค้นพบเครื่องมือต่อไปนี้ได้ในบรรทัดคำสั่ง:

• PHP

• นักแต่งเพลง

• คอมไพล์

แพ็คเกจนี้เป็นปลั๊กอินผู้แต่งและควรติดตั้งกับการพึ่งพาการพัฒนาของโปรเจ็กต์ของคุณโดยใช้ผู้แต่ง:

ติดตั้ง GrumPHP เป็น phar โดยไม่ต้องพึ่งพา:

 ผู้แต่งต้องการ --dev phpro/grumphp-shim

ติดตั้ง GrumPHP ด้วยการพึ่งพา:

composer require --dev phpro/grumphp

ติดตั้ง GrumPHP โดยไม่ต้องพึ่งพาและ git hooks อัตโนมัติผ่าน phive

phive install grumphp

เมื่อติดตั้งแพ็คเกจแล้ว GrumPHP จะแนบตัวเองเข้ากับ git hooks ของโปรเจ็กต์ของคุณ คุณจะเห็นข้อความต่อไปนี้ในบันทึกของผู้แต่ง:

ระวัง! GrumPHP กำลังดมคอมมิตของคุณ!

GrumPHP จะไม่ผลักดันคุณให้ใช้งานเฉพาะอย่างเด็ดขาด คุณสามารถเลือกงานที่ตรงกับความต้องการของคุณ และเปิดใช้งานหรือปิดใช้งานงานใดๆ ก็ได้ในเวลาอันรวดเร็ว! ดูส่วน suggest ใน composer.json

หมายเหตุ: GrumPHP จะเขียนทับ hooks ที่มีอยู่ เว้นแต่คุณจะรัน composer install ด้วย --no-plugins หรือ --no-scripts เราสร้างข้อมูลสำรองของ git hook ของคุณ แต่วิธีที่ดีที่สุดคือตรวจสอบให้แน่ใจว่าคุณได้สำรองข้อมูลของ hooks ที่คุณกำหนดเองไว้ด้วยก่อนที่จะลองติดตั้ง GrumPHP

มีปัญหาในการติดตั้ง GrumPHP? ค้นหาวิธีการ:

• ติดตั้งทั่วโลก

• ติดตั้งด้วยโครงสร้างโครงการที่แปลกใหม่

การกำหนดค่า

บางสิ่งใน GrumPHP สามารถกำหนดค่าได้ในไฟล์ grumphp.yml หรือ grumphp.yml.dist หรือ grumphp.dist.yml ในรูทของโปรเจ็กต์ของคุณ (ไดเร็กทอรีที่คุณเรียกใช้คำสั่ง grumphp) คุณสามารถระบุชื่อไฟล์และตำแหน่งการกำหนดค่าที่กำหนดเองได้ใน 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:failed: grumphp-grumpy.txtsucceeded: grumphp-happy.txtparallel:enabled: truemax_workers: 32fixer:enabled: truefix_by_default: falseenvironment:files: []ตัวแปร: {}เส้นทาง: []งาน: {}ชุดทดสอบ: []ส่วนขยาย: []

รายละเอียดของการกำหนดค่าแบ่งออกเป็นส่วนต่างๆ ต่อไปนี้

• พารามิเตอร์ – การตั้งค่าการกำหนดค่าสำหรับ GrumPHP เอง

• งาน – งานภายนอกที่ดำเนินการตรวจสอบรหัสและการกำหนดค่าตามลำดับ

• ชุดทดสอบ

• ส่วนขยาย

• การขยาย TaskRunner

• ตัวตรวจสอบอนุสัญญา

คำสั่ง

เนื่องจาก GrumPHP เป็นเพียงเครื่องมือ CLI คำสั่งเหล่านี้จึงสามารถทริกเกอร์ได้:

• กำหนดค่า

• คอมไพล์:init

• git:deinit

• git: กระทำล่วงหน้า

• git:commit-msg

• วิ่ง

ความเข้ากันได้

GrumPHP ใช้งานได้กับ PHP 5.6 ขึ้นไป

แพ็คเกจนี้ได้รับการทดสอบกับไคลเอนต์ git ต่อไปนี้:

• CLI ยูนิกซ์

• ซีแอลไอ แมค

• CLI วินโดวส์

• phpstorm git

• Atlassian SourceTree

• ซินเทโว สมาร์ทกิต

แผนการทำงาน

มีงานมากมายอยู่แล้วเพื่อให้แน่ใจว่าทีมของคุณเขียนโค้ดได้ดี เรามองหาการสนับสนุนงานใหม่ๆ อยู่เสมอ อย่าลังเลที่จะบันทึกปัญหาหรือสร้างคำขอดึงสำหรับงานที่เราลืมไป

คุณขาดคุณสมบัติหรือคุณพบข้อบกพร่องหรือไม่? เข้าสู่ระบบในตัวติดตามปัญหา! ต้องการที่จะช่วยออก? อย่าลังเลที่จะติดต่อเรา!

คำถามที่พบบ่อย

• คำถามที่พบบ่อย

เกี่ยวกับ

การส่งข้อบกพร่องและการร้องขอคุณสมบัติ

Bugs and feature request are tracked on GitHub. โปรดดูกฎของเราก่อนที่จะบริจาครหัสของคุณ

ใบอนุญาต

GrumPHP ได้รับอนุญาตภายใต้ใบอนุญาต MIT