Snippy

🚀 Snippy - 代碼片段管理工具

Snippy是一個基於Microsoft Azure構建的代碼片段管理工具。它允許用戶保存、查看代碼片段，還能從存儲的代碼片段中自動生成項目Wiki和代碼風格指南，極大提升了代碼管理和文檔生成的效率。

🚀 快速開始

本地部署

1. 環境準備：
   • 安裝Docker（用於本地開發）。
   • 安裝Azurite和Cosmos Emulator（用於模擬雲服務）。
2. 代碼倉庫克隆：

   git clone https://github.com/Azure-Samples/snippy.git
   cd snippy
   

3. 配置本地環境變量：
   • 創建local.settings.json文件，並填寫以下內容（根據實際情況修改佔位符）：

   {
     "COSMOS_CONN": "<你的Cosmos連接字符串>",
     "AZURE_OPENAI_ENDPOINT": "<你的OpenAI終結點>",
     "AZURE_OPENAI_KEY": "<你的OpenAI密鑰>",
     "PROJECT_CONNECTION_STRING": "<你的項目連接字符串>"
   }
   

4. 啟動本地服務：

   func start
   

   服務將在http://localhost:7071上運行。

使用Codespaces

通過以下步驟在Codespaces上運行項目：

1. 打開項目倉庫：Snippy
2. 點擊“Code”按鈕，選擇“Open in Codespace”。

✨ 主要特性

• 保存代碼片段：將選定的代碼片段保存到雲存儲中。
• 查看代碼片段：通過名稱查找並顯示已保存的代碼片段。
• 生成文檔：從存儲的代碼片段中自動生成項目Wiki和代碼風格指南。

📦 安裝指南

本地部署

1. 環境準備：
   • 安裝Docker（用於本地開發）。
   • 安裝Azurite和Cosmos Emulator（用於模擬雲服務）。
2. 代碼倉庫克隆：

   git clone https://github.com/Azure-Samples/snippy.git
   cd snippy
   

3. 配置本地環境變量：
   • 創建local.settings.json文件，並填寫以下內容（根據實際情況修改佔位符）：

   {
     "COSMOS_CONN": "<你的Cosmos連接字符串>",
     "AZURE_OPENAI_ENDPOINT": "<你的OpenAI終結點>",
     "AZURE_OPENAI_KEY": "<你的OpenAI密鑰>",
     "PROJECT_CONNECTION_STRING": "<你的項目連接字符串>"
   }
   

4. 啟動本地服務：

   func start
   

   服務將在http://localhost:7071上運行。

💻 使用示例

代碼片段操作

保存代碼片段

通過以下命令將代碼片段保存到雲存儲：

curl -X POST "http://localhost:7071/api/snippets" \
-H "Content-Type: text/plain" \
-d "<你的代碼片段>"

查看代碼片段

通過以下命令查找並顯示已保存的代碼片段：

curl "http://localhost:7071/api/snippets/<片段名稱>" 

文檔生成

生成Wiki

通過以下命令生成項目Wiki：

curl -X POST "http://localhost:7071/api/snippets/wiki" \
-H "Content-Type: application/json" \
-d '{"title":"<你的標題>", "content":"<你的內容>"}'

生成風格指南

通過以下命令生成代碼風格指南：

curl -X POST "http://localhost:7173/api/snippets/code-style" \
-H "Content-Type: application/json" \
-d '{"language":"<語言>", "styles":"<樣式說明>"}'

📚 詳細文檔

MCP配置

快速創建mcp.json

mkdir -p .vscode && cat > .vscode/mcp.json <<'EOF'
{
  "inputs": [
    {
      "type": "promptString",
      "id": "functions-mcp-extension-system-key",
      "description": "Azure Functions MCP系統密鑰",
      "password": true
    },
    {
      "type": "promptString",
      "id": "functionapp-name",
      "description": "部署的函數應用名稱"
    }
  ],
  "servers": {
    "local-snippy": {
      "type": "sse",
      "url": "http://localhost:7071/runtime/webhooks/mcp/sse"
    },
    "remote-snippy": {
      "type": "sse",
      "url": "https://${input:functionapp-name}.azurewebsites.net/runtime/webhooks/mcp/sse",
      "headers": { "x-functions-key": "${input:functions-mcp-extension-system-key}" }
    }
  }
}
EOF

獲取系統密鑰：

az functionapp keys list -g <資源組名> -n <函數應用名稱> --query [0].value

🔧 技術細節

主要組件

1. Azure Functions：用於實現RESTful API接口，處理用戶的請求。
2. Durable Functions：用於異步任務處理（如生成文檔）。
3. Cosmos DB：作為存儲後端，用於保存代碼片段和元數據。
4. OpenAI Integration：集成OpenAI API，用於生成自然語言文本（如Wiki和風格指南）。

核心功能

代碼片段管理

• API Endpoint: /api/snippets
  • POST: 上傳新的代碼片段。
  • GET/{name}: 獲取指定名稱的代碼片段。

文檔生成

• API Endpoint: /api/snippets/wiki 和 /api/snippets/code-style
  • POST: 分別用於生成項目Wiki和代碼風格指南。

🤝 貢獻指南

如何貢獻

1. Fork該項目倉庫。
2. 在自己的分支上進行修改。
3. 提交併創建Pull Request。

代碼規範

• 遵循Microsoft Azure的代碼規範。
• 保持代碼簡潔和可維護性。

📞 支持與反饋

問題報告

如果有任何問題或建議，請在GitHub倉庫中創建Issues： Snippy Issues

社區支持

加入我們的Discord社區，與其他開發者交流經驗。

📄 許可證

該項目使用MIT License。