githooks

1. wtyd/githooks

เป็นเครื่องมือและปลั๊กอินนักแต่งเพลงอื่น ๆ อีกมากมายสำหรับจัดการตะขอ Git แต่ข้อเสนอของ Githooks:

• แอพแบบสแตนด์อโลน Githooks เป็นไบนารี (. phar) ดังนั้นการพึ่งพาของมันจึงไม่รบกวนการพึ่งพาแอปพลิเคชันของคุณ
• ได้รับการจัดการด้วยนักแต่งเพลง คุณไม่ต้องการเครื่องมืออื่น ๆ เช่น Phive หรืออื่น ๆ
• ทำให้การกำหนดค่าเครื่องมือ QA ทั้งหมดบดบัง (อย่างน้อยเครื่องมือที่รองรับทั้งหมด)
• มันเป็นบทคัดย่อนักพัฒนาที่อยู่ห่างจากวิธีการดำเนินการของเครื่องมือ QA โดยใช้เฉพาะคำสั่ง githooks tool name-of-the-tool
• คุณยังสามารถสร้างสคริปต์ของคุณเองและกำหนดค่าเบ็ด git ใด ๆ

นอกจากนี้ยังสามารถใช้ร่วมกับเครื่องมือตรวจสอบความถูกต้องของ JavaScript เช่น Typicode/Husky หากคุณมีโครงการไฮบริด

2. ข้อกำหนด

• php> = 7.1
• เครื่องมือที่คุณต้องตรวจสอบรหัส
• หรือสคริปต์ของคุณเองสำหรับตะขอ

3. ติดตั้ง

1. ต้องติดตั้ง githooks เช่นความต้องการ dev กับนักแต่งเพลง:

composer require --dev wtyd/githooks

หมายเหตุ: สำหรับ PHP <8.1 คุณต้องเพิ่มเหตุการณ์ post-update-cmd ถัดไปในส่วน scripts ใน composer.json ของคุณ Json:

 "scripts" : {
    "post-update-cmd" : [
      " Wtyd \ GitHooks \ Utils \ ComposerUpdater::phpOldVersions "
    ]
}

จากนั้นเรียกใช้ composer update wtyd/githooks

จนกระทั่งเวอร์ชัน 2.3.0 วิธีที่ใช้คือ php72orminorupdate แต่มันเลิกใช้แล้วและจะถูกลบออกจากเวอร์ชัน 3.0.0

นอกจากนี้ยังสะดวกในการเพิ่มเข้าไปในเหตุการณ์ post-install-cm เพื่อให้นักพัฒนาโครงการที่เหลือไม่มีปัญหากับการสร้าง

 "scripts" : {
    "post-update-cmd" : " Wtyd \ GitHooks \ Utils \ ComposerUpdater::phpOldVersions " ,
    "post-install-cmd" : " Wtyd \ GitHooks \ Utils \ ComposerUpdater::phpOldVersions "
}

2. ติดตั้งเครื่องมือที่รองรับทั้งหมดที่จำเป็น วิธีการติดตั้งเครื่องมือไม่สำคัญ

3. เริ่มต้น githooks ด้วย githooks conf:init . คำสั่งนี้สร้างไฟล์การกำหนดค่าในเส้นทางรูท ( githooks.yml )

4. เรียกใช้ githooks hook มันคัดลอกสคริปต์สำหรับการเปิดตัว githooks ในเหตุการณ์ก่อนกำหนดในไดเรกทอรี. .git/hooks คุณสามารถเรียกใช้ githooks hook otherHook MyScriptFile.php สำหรับตั้งค่า hook ใด ๆ ที่มีสคริปต์ที่กำหนดเอง ดู Wiki สำหรับข้อมูลเพิ่มเติม

เพื่อให้แน่ใจว่าได้รับการกำหนดค่าโดยอัตโนมัติเราสามารถกำหนดค่าคำสั่งในเหตุการณ์ post-update-cmd และเหตุการณ์ post-install-cmd ของไฟล์ composer.json (ส่วน scripts ):

 "scripts" : {
    "post-update-cmd" : [
    " vendor/bin/githooks hook " // or "vendor/bin/githooks hook pre-commit MyScriptFile.php"
    ],
    "post-install-cmd" : [
    " vendor/bin/githooks hook "
    ]
}

5. ตั้งค่าไฟล์การกำหนดค่า

4. การใช้งาน

เมื่อคุณกระทำเครื่องมือตรวจสอบรหัสที่กำหนดค่าทั้งหมดจะถูกเปิดใช้งานโดยอัตโนมัติ หากรหัสของคุณผ่านการตรวจสอบทั้งหมด Githooks อนุญาตให้คุณกระทำ ถ้าไม่คุณต้องแก้ไขรหัสและลองอีกครั้ง:

คุณยังสามารถเรียกใช้ githooks ได้ทุกเมื่อที่คุณต้องการ เครื่องมือทั้งหมดในเวลาเดียวกันหรือทีละหนึ่ง:

githooks tool all # Run all tools
githooks tool phpcs # Run only phpcs

5. เครื่องมือที่รองรับ

ในขณะนี้เครื่องมือที่รองรับคือ:

• PHP CodeSniffer (PHPCS และ PHPCBF)
• เครื่องตรวจจับการคัดลอก PHP
• เครื่องตรวจจับ Mess PHP
• ลินต์คู่ขนาน
• PHP Stan
• ตัวตรวจสอบความปลอดภัย PHP ในพื้นที่

แต่คุณสามารถตั้งค่าสคริปต์ของคุณเองบนเบ็ด git ใด ๆ

6. ตั้งค่าไฟล์กำหนดค่า

ไฟล์ githooks.yml ถูกแยกออกจากสามส่วน:

6.1. ตัวเลือก

6.1.1. การประหารชีวิต

ธง execution ถือเป็นวิธีที่ Githooks จะทำงาน:

• full (ตัวเลือกเริ่มต้น): เรียกใช้เครื่องมือทั้งหมดที่ตั้งค่ากับเส้นทางทั้งหมดที่กำหนดไว้สำหรับแต่ละเครื่องมือ ตัวอย่างเช่นคุณตั้งค่า PHPCs สำหรับ Run in src และ app Directories commit มีเฉพาะไฟล์ที่แก้ไขจากไดเรกทอรี database PHPCS จะตรวจสอบไดเรกทอรี src และ app แม้ว่าจะไม่มีไฟล์ในไดเรกทอรีเหล่านี้แก้ไข
• fast : ตัวเลือกนี้เรียกใช้เครื่องมือกับไฟล์ที่แก้ไขโดยการกระทำเท่านั้น
  • ตัวเลือกนี้มีผลต่อเครื่องมือต่อไปนี้เท่านั้น: PHPCs, PHPMD, PHPSTAN และ Parallel-Lint ส่วนที่เหลือของเครื่องมือจะทำงานเป็นตัวเลือกเต็มรูปแบบ
  • คำเตือน!!! คุณต้องตั้งค่าการยกเว้นเครื่องมือใน githooks.yml หรือในไฟล์การกำหนดค่าของเครื่องมือ EATH เนื่องจากตัวเลือกนี้เขียนทับ paths คีย์ของเครื่องมือเพื่อให้พวกเขาดำเนินการเฉพาะกับไฟล์ที่แก้ไขเท่านั้น

6.1.2. กระบวนการ

เรียกใช้เครื่องมือหลายอย่างในหลายกระบวนการในเวลาเดียวกัน ( tool all คำสั่ง) จำนวนเริ่มต้นของกระบวนการคือ 1

6.2. เครื่องมือ

มันเป็นอาร์เรย์ที่มีชื่อของเครื่องมือที่ Githooks จะทำงาน ชื่อของเครื่องมือคือการปฏิบัติการของพวกเขา หากคุณต้องการให้เครื่องมือทั้งหมดดำเนินการคีย์ Tools จะมีดังนี้:

 Tools :
    - phpstan
    - security-checker
    - parallel-lint
    - phpcs
    - phpcbf
    - phpmd
    - phpcpd

ลำดับที่เครื่องมือเป็นคำสั่งที่พวกเขาจะดำเนินการ

6.3. การตั้งค่าเครื่องมือ

ในขั้นตอนถัดไปคุณต้องกำหนดค่าเครื่องมือที่มีชื่อเดียวกับในปุ่ม เครื่องมือ ตัวอย่างเช่นสำหรับ SET PHPCS:

 phpcs :
    executablePath : vendor/bin/phpcs
    paths : [src, tests]
    ignore : [vendor]
    standard : ' PSR12 '

ตัวเลือกที่มีอยู่ทั้งหมดอยู่ในวิกิ

7. การบริจาค

การมีส่วนร่วมจากผู้อื่นจะได้รับการชื่นชมอย่างมาก! ส่งคำขอ/ปัญหาดึง ตรวจสอบขั้นตอนทั้งหมดสำหรับการทำที่ส่วน Wiki สำหรับการบริจาค ขอบคุณ!

8. ใบอนุญาต

ใบอนุญาต MIT (MIT) โปรดดูไฟล์ใบอนุญาตสำหรับข้อมูลเพิ่มเติม