此活動涉及在我的開源專案 GENEREADME 中實施統計分析工具,以提高程式碼品質和一致性。
克萊布恩特拉
/
基因自述文件
GENEREADME 是一個命令列工具,它接收原始碼檔案並產生 README.md 文件,該檔案利用 LLM 解釋文件中的程式碼。
貢獻
歡迎為 GENEREADME 做出貢獻!請查看 CONTRIBUTING.md 以取得有關設定環境、如何運作和測試該工具以及提交變更的指南。
GENEREADME
GENEREADME 是一個命令列工具,它接收文件、處理它並產生一個 README 文件,其中包含文件內容的解釋或文件。該工具利用 OpenAI 聊天完成來分析文件並產生內容。
用法
該工具目前支援 Groq 和 OpenRouter,預設使用 Groq。必須提供相應提供者的有效 API 金鑰。
透過建立 .env 檔案或在使用指令時透過 -a 或 --api-key 標誌來提供有效的 API 金鑰:
API_KEY=API_KEY or genereadme <files> -a API_KEY genereadme <files> --api-key API_KEY </files></files>
安裝依賴項:
npm install -g
使用現有範例檔案執行該工具或開始使用您自己的:
genereadme <files genereadme examples>…</files>
格式化程式
對於我的格式化程序,我選擇使用 Prettier。原因很簡單,我選擇這個是因為我之前只是使用過它的基本功能,並且我打算進一步了解它。
從技術上講,我已經將 IDE 設定為預設使用 prettier,因此我從一開始就已經擁有了格式化程式。然而,現在專案本身有了更漂亮的設置,這將允許貢獻者也使用格式化程序,使專案的程式碼在格式方面保持一致。
我只是在 .prettierrc 檔案中添加了關於如何格式化程式碼的規則,以及 .vscode/ 下的 settings.json 中的一些設置,用於保存格式等選項。
短絨
對於我的 linter,我選擇使用 ESLint。由於我使用的是 JavaScript,所以我使用了一種流行的 linter,我以前也有過使用它的經驗,但我自己並沒有真正設定過。因此,我選擇了 ESLinter。
設定 ESLinter 並不複雜。在 eslint.config.js 中進行簡單的安裝和設定規則就足以讓 linter 正常運作。但是,由於我同時使用格式化程式和 linter,因此我必須確保它們都能正常運作。其中基本上包括附加規則,以確保不會與 linter 和格式化程式發生任何衝突。
如何使用工具
這些工具在專案中的使用方式有很多種,我個人更喜歡這些特定的配置:format on save for prettier 和 run on type for eslint。這樣,linter 將始終在開發人員鍵入時檢查 linting 問題,然後格式化程式將在觸發儲存時自動格式化變更。
然而,對於本週的任務,我還添加了腳本以允許用戶透過 CLI 手動運行格式化程式和 linter。還實現了預提交掛鉤,以確保提交到儲存庫的任何程式碼都符合專案的格式和 linting 標準。透過添加這個鉤子,我可以在每次提交之前自動運行 Prettier 和 ESLint,儘早發現任何問題並保持貢獻之間的程式碼一致性。此設定有助於減少出現小格式問題的可能性,並提高參與專案的任何人的程式碼可讀性。
以上是格式化和 Linting 以保持一致性的詳細內容。更多資訊請關注PHP中文網其他相關文章!

JavaScript字符串替換方法詳解及常見問題解答 本文將探討兩種在JavaScript中替換字符串字符的方法:在JavaScript代碼內部替換和在網頁HTML內部替換。 在JavaScript代碼內部替換字符串 最直接的方法是使用replace()方法: str = str.replace("find","replace"); 該方法僅替換第一個匹配項。要替換所有匹配項,需使用正則表達式並添加全局標誌g: str = str.replace(/fi

簡單JavaScript函數用於檢查日期是否有效。 function isValidDate(s) { var bits = s.split('/'); var d = new Date(bits[2] '/' bits[1] '/' bits[0]); return !!(d && (d.getMonth() 1) == bits[1] && d.getDate() == Number(bits[0])); } //測試 var

本文探討如何使用 jQuery 獲取和設置 DOM 元素的內邊距和外邊距值,特別是元素外邊距和內邊距的具體位置。雖然可以使用 CSS 設置元素的內邊距和外邊距,但獲取準確的值可能會比較棘手。 // 設定 $("div.header").css("margin","10px"); $("div.header").css("padding","10px"); 你可能會認為這段代碼很

本文探討了十個特殊的jQuery選項卡和手風琴。 選項卡和手風琴之間的關鍵區別在於其內容面板的顯示和隱藏方式。讓我們深入研究這十個示例。 相關文章:10個jQuery選項卡插件

發現十個傑出的jQuery插件,以提升您的網站的活力和視覺吸引力!這個精選的收藏品提供了不同的功能,從圖像動畫到交互式畫廊。讓我們探索這些強大的工具:相關文章:1

HTTP-Console是一個節點模塊,可為您提供用於執行HTTP命令的命令行接口。不管您是否針對Web服務器,Web Serv

本教程向您展示瞭如何將自定義的Google搜索API集成到您的博客或網站中,提供了比標準WordPress主題搜索功能更精緻的搜索體驗。 令人驚訝的是簡單!您將能夠將搜索限制為Y

當div內容超出容器元素區域時,以下jQuery代碼片段可用於添加滾動條。 (無演示,請直接複製到Firebug中) //D = document //W = window //$ = jQuery var contentArea = $(this), wintop = contentArea.scrollTop(), docheight = $(D).height(), winheight = $(W).height(), divheight = $('#c


熱AI工具

Undresser.AI Undress
人工智慧驅動的應用程序,用於創建逼真的裸體照片

AI Clothes Remover
用於從照片中去除衣服的線上人工智慧工具。

Undress AI Tool
免費脫衣圖片

Clothoff.io
AI脫衣器

AI Hentai Generator
免費產生 AI 無盡。

熱門文章

熱工具

SublimeText3漢化版
中文版,非常好用

SublimeText3 Mac版
神級程式碼編輯軟體(SublimeText3)

MantisBT
Mantis是一個易於部署的基於Web的缺陷追蹤工具,用於幫助產品缺陷追蹤。它需要PHP、MySQL和一個Web伺服器。請查看我們的演示和託管服務。

Dreamweaver CS6
視覺化網頁開發工具

DVWA
Damn Vulnerable Web App (DVWA) 是一個PHP/MySQL的Web應用程序,非常容易受到攻擊。它的主要目標是成為安全專業人員在合法環境中測試自己的技能和工具的輔助工具,幫助Web開發人員更好地理解保護網路應用程式的過程,並幫助教師/學生在課堂環境中教授/學習Web應用程式安全性。 DVWA的目標是透過簡單直接的介面練習一些最常見的Web漏洞,難度各不相同。請注意,該軟體中