ESLint Markdown: ลินต์ไฟล์ Markdown ด้วย ESLint
(github.com/lumirlumir)เราได้เผยแพร่แพ็กเกจ eslint-markdown ที่ช่วยให้สามารถลินต์ไฟล์ Markdown ด้วย ESLint ได้
หลังจากที่ ESLint ประกาศรองรับ Markdown อย่างเป็นทางการเมื่อวันที่ 3 ตุลาคม 2024 ปลั๊กอินนี้ก็ถูกออกแบบให้สอดคล้องกับ API อย่างเป็นทางการและทิศทางของโครงการ
โปรเจ็กต์นี้พัฒนาโดยชุมชนเป็นหลัก และสร้างขึ้นโดยให้ความสำคัญกับความเสถียร ความเข้ากันได้ และการบำรุงรักษาอย่างต่อเนื่อง โดยอาศัยประสบการณ์การพัฒนาภาษา plugin ของ ESLint core
eslint-markdown มี rule มากกว่า 20 รายการที่ไม่ซ้ำกับ @eslint/markdown ซึ่งเป็นแพ็กเกจรองรับ Markdown ของ ESLint core เมื่อนำไปใช้ร่วมกับ core rule ก็จะสามารถใช้ rule ที่เกี่ยวข้องกับ Markdown ได้มากกว่า 40 รายการ นอกจากนี้ยังรองรับ CommonMark, GitHub Flavored Markdown(GFM), Front Matter และมี shared config อย่าง recommended, stylistic, base มาให้ด้วย
ถ้าเป็นโปรเจ็กต์ที่ใช้ ESLint อยู่แล้ว ก็สามารถผนวกการลินต์ Markdown เข้าไปใน flow การตั้งค่าเดียวกันได้อย่างเป็นธรรมชาติด้วยต้นทุนที่ค่อนข้างต่ำ เหมาะอย่างยิ่งสำหรับทีมหรือโปรเจ็กต์ที่ต้องการดูแลคุณภาพของเอกสารและโค้ดจากจุดเดียว
ในระยะยาว เป้าหมายคือการสร้าง flow ที่ทำให้สามารถลินต์ไฟล์หลากหลายประเภทได้ด้วย ESLint ตัวเดียว และพัฒนาให้เป็นตัวเลือกที่ช่วยเสริมหรือในบางกรณีอาจใช้แทนเครื่องมือ lint Markdown เดิมอย่าง markdownlint หรือ remark-lint ได้
ต่อจากนี้มีแผนจะเพิ่ม rule ที่หลากหลายยิ่งขึ้น รวมถึง style rule ด้วย เพื่อให้สามารถจัดการ Markdown ได้อย่างสม่ำเสมอภายใต้ flow การตั้งค่า ESLint เดียวกันเช่นเดียวกับ JavaScript/TypeScript
ยินดีรับฟังฟีดแบ็กและการมีส่วนร่วมเสมอ
ยังไม่มีความคิดเห็น