如何撰寫好的外掛程式
首先,感謝您決定為 Fastify 撰寫外掛程式。Fastify 是一個極簡框架,而外掛程式是它的強項,因此非常感謝您。
Fastify 的核心原則是效能、低開銷,並為使用者提供良好的體驗。在撰寫外掛程式時,請務必牢記這些原則。因此,在本文件中,我們將分析一個高品質外掛程式的特性。
需要一些靈感嗎?您可以使用我們問題追蹤器中的 「外掛程式建議」標籤!
程式碼
Fastify 使用不同的技術來最佳化其程式碼,其中許多技術都記錄在我們的指南中。我們強烈建議您閱讀外掛程式的搭便車指南,以探索您可以用來建構外掛程式的所有 API,並學習如何使用它們。
您有問題或需要一些建議嗎?我們非常樂意為您提供協助!只需在我們的 協助儲存庫中開啟一個問題即可。
一旦您將外掛程式提交到我們的生態系統列表,我們將審查您的程式碼,並在必要時協助您改進。
文件
文件非常重要。如果您的外掛程式沒有完善的文件,我們將不會將其加入生態系統列表。缺乏高品質的文件會使人們更難使用您的外掛程式,並且可能會導致外掛程式未被使用。
如果您想查看一些如何記錄外掛程式的良好範例,請查看
授權條款
您可以根據自己的喜好授權您的外掛程式,我們不強制執行任何類型的授權。
我們偏好 MIT 授權,因為我們認為它允許更多人自由地使用程式碼。如需替代授權的清單,請參閱 OSI 清單或 GitHub 的 choosealicense.com。
範例
請務必在您的儲存庫中放入範例檔案。範例對使用者非常有幫助,並提供一種快速測試外掛程式的方法。您的使用者會很感激。
測試
徹底測試外掛程式以驗證其是否正常運作非常重要。
沒有測試的外掛程式將不會被接受到生態系統列表。缺乏測試不會讓人信任,也不能保證程式碼會在不同版本的相依性中繼續運作。
我們不強制使用任何測試程式庫。我們使用 tap
,因為它可以提供開箱即用的平行測試和程式碼涵蓋率,但您可以自行選擇偏好的程式庫。我們強烈建議您閱讀外掛程式測試,以了解如何測試您的外掛程式。
程式碼檢查器
這不是強制性的,但我們強烈建議您在外掛程式中使用程式碼檢查器。它可以確保程式碼風格一致,並幫助您避免許多錯誤。
我們使用 standard
,因為它無需設定即可運作,並且非常容易整合到測試套件中。
持續整合
這不是強制性的,但如果您以開放原始碼形式發布您的程式碼,則使用持續整合有助於確保貢獻不會破壞您的外掛程式,並顯示外掛程式按預期運作。CircleCI 和 GitHub Actions 對於開放原始碼專案都是免費的,並且易於設定。
此外,您可以啟用諸如 Dependabot 之類的服務,這將幫助您保持相依性更新,並在 Fastify 的新版本與您的外掛程式出現問題時發現。
開始吧!
太棒了,現在您知道關於如何為 Fastify 撰寫好外掛程式的所有知識了!在您建立一個(或多個!)之後,請告訴我們!我們會將其新增到我們文件的 生態系統區塊!
如果您想查看一些真實世界的範例,請查看
@fastify/view
Fastify 的範本渲染 (ejs, pug, handlebars, marko) 外掛程式支援。@fastify/mongodb
Fastify MongoDB 連線外掛程式,您可以使用它在伺服器的每個部分共用相同的 MongoDB 連線池。@fastify/multipart
Fastify 的 Multipart 支援。@fastify/helmet
Fastify 的重要安全性標頭。